-
Notifications
You must be signed in to change notification settings - Fork 854
Include raw docs in Feature PRs #1510
Copy link
Copy link
Closed
Labels
area/documentationImprovements or additions to documentationImprovements or additions to documentation
Description
I propose we start requiring medium-to-large feature PRs to come with raw documentation (e.g. mostly bullet points on what it is, how to use it, example).
It's not intended to be user facing documentation, the goal is to:
- Provide raw material we'll be using to write documentation later on (instead of having to ping the author and ask to explain)
- Make sure we don't forget to document some slightly obscure features (e.g. Support for partially running a DAG #1302)
- Provide a starting point for Europa testers while we work on "proper" docs
- See the feature in action. Helps PR review.
For instance, in the current PR pipeline, that would include:
- Implements #DecodeSecret as a wrapper to #TransformSecret #1509
- [POC] Multi-platform in dagger europa #1467
- Add output values to plan #1486
I'd like to hear your thoughts @gerhard -- if you think this is a good idea, do you have an opinion on the implementation?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area/documentationImprovements or additions to documentationImprovements or additions to documentation