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

Update feature flags exposed to user in docs #5734

Merged
merged 2 commits into from May 28, 2019
Merged

Conversation

@humitos
Copy link
Member

@humitos humitos commented May 27, 2019

  1. added some flags that could be interesting for users
  2. remove flags that can be achieved by the user themselves (config file, requirements)
  3. remove invalid flag
@humitos humitos requested a review from May 27, 2019

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

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

@stsewd stsewd May 27, 2019

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?

Loading

Copy link
Member Author

@humitos humitos May 27, 2019

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.

Loading

Copy link
Member

@stsewd stsewd May 27, 2019

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.

Loading

Copy link
Member Author

@humitos humitos May 28, 2019

Choose a reason for hiding this comment

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

Why?

Loading

Copy link
Member

@stsewd stsewd May 28, 2019

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.

Loading

Copy link
Member Author

@humitos humitos May 28, 2019

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.

Loading

@humitos humitos requested a review from stsewd May 28, 2019
stsewd
stsewd approved these changes May 28, 2019
@humitos humitos merged commit 900c575 into master May 28, 2019
2 checks passed
Loading
@delete-merged-branch delete-merged-branch bot deleted the humitos/feature-flags-docs branch May 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants