This repository contains documentation for MetaCentrum grid services hosted at docs.metacentrum.cz.
If you found an error or something is missing in this documentation please open an issue. Pull requests are also welcome.
The documentation pages are written mostly in Markdown and use fumadocs syntax. These files are used to automatically generate a static website which is then deployed on docs.metacentrum.cz.
The easiest way to start contributing is to find the .mdx file that is used to generate the page you want to modify in the /content/docs folder and either edit it directly using GitHub editor or press dot (.) to load vscode in your browser. Afterwards create a pull request with your changes and they will be reviewed.
In case you want to generate the static pages locally (could be useful for large changes) see below.
- Clone the CESNET/metacentrum-user-docs repo
git clone https://github.com/CESNET/metacentrum-user-docs - Clone CERIT-SC/fumadocs repo with some objects common to all eInfra docs:
git clone https://github.com/CERIT-SC/fumadocs - Copy the required files
cp -r fumadocs/components/* metacentrum-user-docs/components/ - Enter the directory
cd metacentrum-user-docs - Run the build
docker run -it --rm -p 3000:3000 -e STARTPAGE=/en/docs -v ./public:/opt/fumadocs/public -v ./components:/opt/fumadocs/components -v ./content/docs:/opt/fumadocs/content/docs cerit.io/docs/fuma:v16.4.6 pnpm dev- Documentation will be available at
http://localhost:3000/en/docs/welcomeand automatically rebuilt on source change.