| .github | ||
| bin | ||
| content | ||
| i18n | ||
| layouts/shortcodes | ||
| static/images | ||
| themes | ||
| .gitignore | ||
| .gitmodules | ||
| config.toml | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
FrostFS Documentation site
Overview
Welcome to the FrostFS Documentation site repository!
This is a TrueCloudLab maintained and community supported FrostFS documentation project, where everyone can contribute new articles, suggest new topics and enhance existing content.
All documentation can be edited via GitHub. We use Hugo for static content generation, so most of Hugo guides are applicable for this site.
How to contribute
- Fork the repo
- Make some changes
- Check how it looks localy with
make server - Submit a PR
- Wait for PR to be merged =)
Usage
To build and run doc site locally one needs to run make public. This make
target will download the required version of hugo and use it for site generation.
The resulting static site content will be in the public directory.
License
License: CC BY-NC-SA 4.0
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.