Skip to content

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

@rdimaio

Description

@rdimaio

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.

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentationoperatorOperator documentation

Type

No type

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions