Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate "Configuration parameters" documentation page automatically, to avoid mismatches between documentation and code #325

Open
rdimaio opened this issue May 22, 2024 · 3 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation operator Operator documentation

Comments

@rdimaio
Copy link
Contributor

rdimaio commented May 22, 2024

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 (rucio/rucio#5965) from occurring.

@rdimaio rdimaio added bug Something isn't working documentation Improvements or additions to documentation labels May 22, 2024
@rdimaio
Copy link
Contributor Author

rdimaio commented May 22, 2024

Related: #183 (as it also pertains documentation about config)

@voetberg voetberg self-assigned this Jun 27, 2024
@voetberg
Copy link
Contributor

voetberg commented Aug 2, 2024

So I spent some time looking into this, and grabbing the defaults from the config file is easy enough with the MDX format introduced by docusaurus3, but the question becomes - What defaults are being used where? Is grabbing the default config file from /opt/rucio/rucio.cfg enough?

@rdimaio
Copy link
Contributor Author

rdimaio commented Aug 5, 2024

So I spent some time looking into this, and grabbing the defaults from the config file is easy enough with the MDX format introduced by docusaurus3, but the question becomes - What defaults are being used where? Is grabbing the default config file from /opt/rucio/rucio.cfg enough?

Good question, I assume the defaults used in rucio.cfg are the ones we should use here, but I'm not sure. @bari12 ?

@rdimaio rdimaio added the operator Operator documentation label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation operator Operator documentation
Projects
None yet
Development

No branches or pull requests

2 participants