Generate "Configuration parameters" documentation page automatically, to avoid mismatches between documentation and code
Open
@voetberg is already working on this.
Since Jun 27, 2024.
bug
documentation
operator
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
The "Configuration parameters" docs page describes various configuration parameters across Rucio.
From what I can see, this documentation page is maintained manually. The issue with this is that some configuration parameters might change in the code (e.g. default values could be modified), and the documentation might become outdated.
It would be ideal to automatically generate this documentation from the code containing the configuration parameters themselves, in order to keep them in sync.
This would prevent issues like this (https://github.com/rucio/rucio/issues/5965) from occurring.
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.
Assessment
This issue has not been assessed yet.