Break up Jinja filter example chains
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.5k
- Forks
- 787
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/StackStorm/st2docs/pull/542 introduced a note about using literalinclude in RST to directly show filter examples. However, the existing examples are grouped together in the same actionchain, and others are missing entirely
We should put all filter examples into their own directory, and make one file per example. Once each filter has an example actionchain, we can remove the inline examples in the documentation and simply refer to them via literalinclude, so there's no way they can be outdated.
Some of these may be used for automated tests, so be mindful of that
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
Review PR 542 first, then locate the existing filter actionchain examples and their inline RST counterparts. Separate each example into its own directory and file, preserve examples used by automated tests, and replace inline examples with literalinclude references. Done means every filter has a standalone example and the documentation renders from those files.
Written by the indexing model from the issue text.
Assessment
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100