-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Addons: allow users to opt-in into the beta addons #10733
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
Conversation
I created the URL, models, view and form to prepare ourselves for the beta addons. Currently, if the `Project.addons` fields is not null we add a HTTP header to tell Cloudflare to enforce the new beta addons on this project. In the future, we can use each of the `ProjectAddonsConfig` field to let the user decide which of the addons they want to enable/disable and change their configurations. * Related: readthedocs/ext-theme#212
Show a small form to the user where they can enable/disable the new beta addons on their project. * Closes #212 * Requires readthedocs/readthedocs.org#10733
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a good start.
""" | ||
Addon search user defined filter. | ||
|
||
Specific filter defined by the user to show on the search modal. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An example or use case here would probably be useful. Is this to allow users to default to subprojects enabled or similar?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can skip it for now if we are not sure how we are going to use this, tho.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't feel too strongly, just wanted to make sure we had a plan for this. I'm fine to include it if we can make the docstring obvious for the user, but perhaps it's better for the next version? 🤷
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Making these filters configurable has been the idea from the beginning of the re-work for the search as you type. However, they are not yet configurable by the user and they won't be in this iteration because it will require more UI.
For now, we are only allowing them to opt-in into all the addons at once. In the following iteration we will be exposing specific configuration for each addon and they will be able to create these filters. This PR only creates the models we will use in the future.
Use a `AddonsConfig.enabled` field to decide whether or not all the addons are enabled.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes look good to me, with a bit more explanation of the headers 👍
* Addons: allow users to opt-in into the beta addons Show a small form to the user where they can enable/disable the new beta addons on their project. * Closes #212 * Requires readthedocs/readthedocs.org#10733 * Add beta label on the menu item * Upate the notification and ask for feedback
I created the URL, models, view and form to prepare ourselves for the beta addons. Currently, if the
Project.addons
fields is not null we add a HTTP header to tell Cloudflare to enforce the new beta addons on this project.In the future, we can use each of the
ProjectAddonsConfig
field to let the user decide which of the addons they want to enable/disable and change their configurations.