Documentation for Rucio
This project contains the documentation for the rucio project.
Contribution
Every change or idea is welcome! For information on how to contribute to the Rucio documentation, please refer and follow our CONTRIBUTING guidelines.
Documentation Structure
There are two types of documentation hosted for Rucio. Should you wish to contribute improvements to any of them, follow the guidelines below.
Markdown documentation
The source for this section lives in the docs folder within the main branch
of the this GitHub repository. Improvements may be suggested by submitting an
issue or pull request to the main branch of the repository. Once the
changes are approved, GitHub Actions will trigger the build process and publish
on to GitHub pages.
API Documentation
The source for this section lives in the
rucio/rucio GitHub repository. There are
two sub-categories that we document:
Since the documentation is directly derived from the source, any change to the
documentation needs to be made in the source code. Please submit an issue or
pull request to the rucio/rucio
repository with your suggestions for contribution. Once the changes have been
approved & pushed into the main branch, the changes will be available at
https://rucio.cern.ch/documentation on the next day.