docs: split/link ext.args into user and developer sections (docs-v2)
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
Currently the ext.args info sits in developer docs, which to a certain extent makes sense, as it's normally used for developers to input command line parameters into a process.
However in some cases a user may want to override these in a configuration file (even if this is not recommended!).
We should either spltuthe page into two for developers vs users, or (I think my preferred solution), link the page also into Running / Configuration but with a big warning that a user overriding pipeline ext.args defaults 'comes with no warranty nor support'.
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
Locate the current developer documentation for ext.args and the Running / Configuration section in the website. Decide whether to split the page or link it for users; done means the relevant audience can find the guidance and the user-facing link includes the stated warning about unsupported pipeline overrides.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100