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

Addons: split settings page per-addon #293

Closed
humitos opened this issue Mar 4, 2024 · 2 comments · Fixed by #482
Closed

Addons: split settings page per-addon #293

humitos opened this issue Mar 4, 2024 · 2 comments · Fixed by #482
Assignees
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@humitos
Copy link
Member

humitos commented Mar 4, 2024

In the short term, as we keep adding configuration options for each addon, we will need to split the addons settings' page per-addon somehow. I'm creating this issue here to keep track of this and have this discussion together.

There are some different proposals here:

  • Use the same settings page for all the addons and add a header for each of them (idea partially implemented in Addons: update form to show all the options readthedocs.org#11031)
  • Split the settings page into different pages per-addon (different URL, forms, etc)
  • Split the settings page into different tags per-addon (same URL, form, etc)

Reference: readthedocs/readthedocs.org#11069 (review)

@agjohnson
Copy link
Contributor

Since this was opened, do we have any more opinions on what exactly we want here? Looking at the current form, it's not too overwhelming at the moment so I'm not immediately drawn to splitting this up into multiple forms/views/tabs. At very least, having 6 form instances feels overkill.

Maybe it helps to start from what other fields do we see us needing here?

I feel like I might want a little bit more onboarding content for some of the settings, but this could also be covered with documentation.

@agjohnson
Copy link
Contributor

I think I found a fairly minimal solution for now, and I avoided splitting up the form and views into multiple instances. My change provides more space for fields and supporting content for each addon, like onboard placeholder segments or images/etc, but leaves the form instance untouched.

I'd still like to know if this fits in our plans for fields and usage of this form, but at very least it feels adaptable without being too much maintenance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants
@humitos @agjohnson and others