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.

Sign up for GitHub

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

Jump to bottom

Autodocs for Protocols, Policy Packages #368

Open
voetberg opened this issue Aug 12, 2024 · 1 comment
Open

Autodocs for Protocols, Policy Packages #368

voetberg opened this issue Aug 12, 2024 · 1 comment
Labels
operator Operator documentation

Comments

@voetberg
Copy link
Contributor

Similar to how the client API docs are automatically compiled for users, it would be useful for the operators to have auto-docs for the different RSE protocols, the abstract protocol packages included with base rucio, the metadata policies, monitoring, and others I'm probably missing. This will prevent mismatch between outdated documentation and source code, and provide operators information about implementing extensions/extras without reading source code.
@voetberg voetberg added the operator Operator documentation label Aug 12, 2024
@voetberg
Copy link
Contributor Author

Hypothetically this could supplant #293

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
operator Operator documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@voetberg