Investigate "NOT USED IN CODE" configuration parameters
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
https://github.com/search?q=repo%3Arucio%2Fdocumentation+%22NOT+USED+IN+CODE%22&type=code
configuration_parameters.md shows 18 instances of <!--NOT USED IN CODE-->. This is not rendered in production.
for reference: https://github.com/rucio/rucio/issues/7696
We should investigate these params individually:
- if they're actually not used in code anymore, we should either add a deprecation notice that is rendered in the prod docs or delete them. It might be a good idea to only add the deprecation notice in case the parameter was deprecated after the oldest supported LTS release, and to possibly also add the version at which the deprecation happened
- If they're used in code, we should remove the HTML comment.
By the end, let's remove all these comments.
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 with configuration_parameters.md and the linked code search to inventory all 18 NOT USED IN CODE comments; read issue #7696 for context. Check each parameter's current code usage and deprecation timing, then remove every comment, either deleting unused parameters or adding a rendered deprecation notice where appropriate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100