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

Document Feature flag user can request us #5041

Closed
humitos opened this issue Dec 27, 2018 · 4 comments
Closed

Document Feature flag user can request us #5041

humitos opened this issue Dec 27, 2018 · 4 comments
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@humitos
Copy link
Member

humitos commented Dec 27, 2018

We have several Feature flags that can be applied to projects. Although, we don't have a document that explains that they are there and how to request them to be enabled.

List of Feature flags available,

https://github.com/rtfd/readthedocs.org/blob/dec39ba70315eca338359f8381af4610a3e56274/readthedocs/projects/models.py#L1018-L1029

We should write some docs around this mentioning them and explaining how they are used and how to request them.

Comes from: #5036 (comment)

@humitos humitos added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels Dec 27, 2018
@humitos humitos added this to the Better user documentation milestone Dec 27, 2018
@dojutsu-user
Copy link
Member

dojutsu-user commented Dec 27, 2018

@humitos
If I'm not wrong, the user has to request the admin for the enable of any of the Feature flag.
So, here's something that I thought.
In the docs, we can have these grouped in a separate heading.
And in the project admin in readthedocs.org, we can add links to these which will redirect to a new issue in RTD with prefilled details (with Project name/slug).
And in the docs, we can do the same thing, only the project details required needs to be manually filled in by the user.

Edit: Or we can just add in the docs.

@humitos
Copy link
Member Author

humitos commented Dec 27, 2018

I think just a specific page under our docs is enough. Maybe another entry in the FAQ with a general question like: "I want a different configuration that's not available under Admin" or well, something better than that ;)

@dojutsu-user
Copy link
Member

Okay.
Working on it.

@agjohnson
Copy link
Contributor

I don't think the point behind feature flags is to advertise to users to get a feature added, it's for us to manage the flags internally or automatically. Once a feature is ready for production, a user can manage the feature by themself, but this shouldn't require feature flags.

Our use cases for feature flags are:

  • Quick iteration to get a partial/half baked feature out
  • Sampling builds to test large changes

We shouldn't expect users to ask us for a feature -- features are ready when they're ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants