Open
Description
Summary
Serverless documentation provides a unique use case—writers sometimes don't have a good idea of when a feature will go live in the product. We'd like to add a way for writers to add content to the documentation behind a feature flag. Ideally, this feature flag can later be enabled by product or engineering when the feature goes live. This will give us more granular control over when content is published, and allow us to plan ahead better.
Ideas
- Launch Darkly - LD is used by multiple engineering teams and looks easy to implement in a python application. We could explore adding a custom directive that conditionally publishes content by polling LD to determine if a feature flag has been enabled
- Pros: FFs can be enabled/disabled outside of the docs
- Cons: Have to integrate a third-party tool.
- Sphinx ifconfig - a much simpler option where we only publish content if the value of a variable is set to true.
Things to think about
- Both of these methods will leave conditional statements in the docs after content is enables. Writers will likely need to periodically go into the docs and clean up unused conditionals.
- How will linking work?
- How will inclusion work?