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

Point users to use a configuration file from advanced settings #5413

Closed
stsewd opened this issue Mar 7, 2019 · 3 comments
Closed

Point users to use a configuration file from advanced settings #5413

stsewd opened this issue Mar 7, 2019 · 3 comments
Assignees
Labels
Design Design or UX/UI related Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@stsewd
Copy link
Member

stsewd commented Mar 7, 2019

Currently users may still be using the advanced settings to build their docs, they should use a configuration file, now they can do everything from the web in the config file.

I was thinking in blocking the UI for new projects, but we can't do that, because that would be a problem for people moving to read the docs (they can't modify their docs). A long solution can be allowing to have a global configuration (codecov has this feature), and that can be merged with the configuration of each version (probably I can create another issue to discuss this more if we agree).

Anyway, going back to the original issue:

We already have something like this in the settings

screenshot_2019-03-06 edit project read the docs

I was thinking we could use the same pattern in the advanced settings

screenshot_2019-03-06 edit advanced project settings read the docs

But I think that first we should group the settings, we have global and per version settings, so putting the global settings first would be the idea (those are not present in the config file). Then we can list the per-version settings (available in the config file) but first showing a tip/link to the config file docs.

Advanced settings

[ ] Single version
[Default branch]
[Default version]
....

:warning: All the next options can be configured using a configuration file.

[Python interpreter]
[ ] Istall project
[Requirements file]
....

@stsewd stsewd added Design Design or UX/UI related Improvement Minor improvement to code Needed: design decision A core team decision is required labels Mar 7, 2019
@stsewd stsewd changed the title Poit users to use a configuration file from advanced settings Ponit users to use a configuration file from advanced settings Mar 7, 2019
@stsewd stsewd changed the title Ponit users to use a configuration file from advanced settings Point users to use a configuration file from advanced settings Mar 7, 2019
@davidfischer
Copy link
Contributor

I think this is a great proposal. I like the idea of separating out global features that can't be configured in the YAML file. I almost wish there was another page to put those 3 settings on but I don't think they belong on the regular settings page.

@stsewd
Copy link
Member Author

stsewd commented Mar 7, 2019

There are more, I didn't put all p:

@davidfischer
Copy link
Contributor

There aren't that many though.

stsewd added a commit to stsewd/readthedocs.org that referenced this issue Mar 14, 2019
This is an initial proposal for readthedocs#5413
This was referenced Mar 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design Design or UX/UI related Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants