Auto generate documentation for all the attributes which are available in the action context
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.5k
- Forks
- 787
- PR merge metrics
- No merged PRs in 30d
Description
We should add action context attribute descriptions to the code (similar as we do for RBAC permission types and runner parameters) and write a script which generates a table with all the available attributes and corresponding descriptions. We can then include those tables in the documentation.
This way documentation will always be in-sync with code.
For details, see https://github.com/StackStorm/st2/pull/2154#discussion_r43586824
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the action context attribute definitions and the existing approaches for RBAC permission types and runner parameters, then read the linked pull request discussion. Identify where the documentation-generation script belongs and make sure it produces a table of every available attribute and its description for inclusion in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100