Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start documenting TaxJar reporting feature and required configuration #159

Open
forkata opened this issue Feb 4, 2022 · 2 comments
Open

Comments

@forkata
Copy link
Collaborator

forkata commented Feb 4, 2022

Since we've now introduced some async jobs we need to add some documentation around the reporting feature pertaining to that. Specifically we want to ensure that users of this gem which enable the reporting feature have a job backend configured and if not understand that jobs will be performed inline as per these docs https://guides.rubyonrails.org/v4.2/active_job_basics.html#job-execution.

@Noah-Silvera
Copy link
Member

Noah-Silvera commented Feb 7, 2022

I think we should keep any documentation around how to setup ActiveJob to a minimum. We don't want to start taking on that role, as active job and it's configuration will change over time, including it's current behavior of running jobs inline as there's no default queue adapter.

I think from an extension perspective, we should only inform users that our extension queues jobs with ActiveJob and that they can refer to <link_here> documentation on how to configure ActiveJob

@forkata
Copy link
Collaborator Author

forkata commented Feb 7, 2022

@Noah-Silvera 100% agree, I think we need to document what reporting tasks are performed async and any decisions we've made regarding queue name etc. From a user's point of view I would like to know that the extension uses the ActiveJob API etc. as not all stores use that and some rely directly on interacting with DelayedJob, Sidekiq etc..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants