Update feature flags exposed to user in docs #5734
Conversation
humitos
commented
May 27, 2019
humitos
commented
- added some flags that could be interesting for users
- remove flags that can be achieved by the user themselves (config file, requirements)
- remove invalid flag
docs/guides/feature-flags.rst
Outdated
|
|
||
| ``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE` | ||
|
|
||
| ``SHARE_SPHINX_DOCTREE``: :featureflags:`SHARE_SPHINX_DOCTREE` |
There was a problem hiding this comment.
I think this one was only for testing, and we haven't seen any failure related to this. Should we sample more projects or just remove the flag and activate the feature for all projects?
There was a problem hiding this comment.
I'm not really sure. We could sample more projects before making it the default. Although, I think that decision is not related with this PR and in the meantime we should expose it to users to let them know that it exists.
It's a useful one when generating the doctree takes some time, so being able to share it will reduce their build time.
There was a problem hiding this comment.
we should expose it to users to let them know that it exists.
I think that decision is part of the core team, not to the user. Users shouldn't know anything about that.
There was a problem hiding this comment.
This isn't a setting that will change the build result in any way, or at least it shouldn't. It will save resources, maybe, but that's not something the user will care about so much, that's more our concern. It's like having a cache for pip, that's useful for us, not something the user cares about so much.
There was a problem hiding this comment.
Good point. I will remove it from this docs then.
