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.

Sign up for GitHub

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

Jump to bottom

Update feature flags exposed to user in docs #5734

Merged
merged 2 commits into from May 28, 2019
Merged

Update feature flags exposed to user in docs #5734

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a773246
Update feature flags exposed to user in docs
humitos May 27, 2019
7afc235
Remove SHARE_SPHINX_DOCTREE because it's not relevant for the user
humitos May 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/guides/feature-flags.rst
View file
Open in desktop
Expand Up @@ -12,16 +12,12 @@ or disable one or more of these featured flags for a particular project.
Available Flags
---------------

``USE_SPHINX_LATEST``: :featureflags:`USE_SPHINX_LATEST`

``ALLOW_DEPRECATED_WEBHOOKS``: :featureflags:`ALLOW_DEPRECATED_WEBHOOKS`

``PIP_ALWAYS_UPGRADE``: :featureflags:`PIP_ALWAYS_UPGRADE`

``SKIP_SUBMODULES``: :featureflags:`SKIP_SUBMODULES`

``DONT_OVERWRITE_SPHINX_CONTEXT``: :featureflags:`DONT_OVERWRITE_SPHINX_CONTEXT`

``MKDOCS_THEME_RTD``: :featureflags:`MKDOCS_THEME_RTD`

``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`

``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE`

``SHARE_SPHINX_DOCTREE``: :featureflags:`SHARE_SPHINX_DOCTREE`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why?

Copy link
Member

@stsewd stsewd May 28, 2019 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I will remove it from this docs then.