Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 2.96 KB

README.md

File metadata and controls

89 lines (64 loc) · 2.96 KB
Raw

Documentation for Rucio

Update Documentation Check external links

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.

Installation

The following packages need to be installed to build the documentation:

docker
python3
mdl           # markdownlint, see https://github.com/markdownlint/markdownlint
yarn
npx           # part of npm

The python dependencies need to be installed. They are defined in requirements.txt. Install them via:

python3 -m pip install -r tools/requirements.txt

To run the server locally, the dependencies of the server need to be installed:

(cd website && yarn install)

Usage

To build the assets, run the build_documentation.sh script in tools. The assets need to be build in order for the server to run!

tools/build_documentation.sh

The script might generate multiple error messages. These are forwarded from the build of the different components and can be ignored, as long as the process finishes with the exit code 0.

To start the development version of the server, run:

(cd website && yarn start)

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.