potyarkin/frostfs.info
1
0
Fork 0
forked from TrueCloudLab/frostfs.info
Code Pull requests Activity
WIP: FrostFS site for everything
21 commits 2 branches 0 tags 226 KiB
Find a file
Vitaliy Potyarkin 21680ed723 [#] Store hugo binary in versioned path 
This will simplify runner cache invalidation
when we will start building the site with CI

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
2024-08-28 13:48:35 +03:00
.github [#13] Fix GH move leftovers 2023-04-18 10:02:35 +03:00
bin [#1] Implement initial doc site 2022-12-29 15:35:27 +03:00
content [#21] Fix SDK repo link 2023-07-12 15:38:00 +03:00
i18n [#1] Implement initial doc site 2022-12-29 15:35:27 +03:00
layouts [#5] Update table look 2023-07-07 13:24:34 +03:00
static/images [#1] Implement initial doc site 2022-12-29 15:35:27 +03:00
themes [#9] Update theme 2023-05-29 18:04:14 +03:00
.gitignore [#] Store hugo binary in versioned path 2024-08-28 13:48:35 +03:00
.gitmodules [#12] Move to Forjejo from GitHub 2023-04-17 16:46:37 +03:00
config.toml [#9] Update headers levels 2023-05-29 15:27:46 +00:00
LICENSE [#1] Implement initial doc site 2022-12-29 15:35:27 +03:00
Makefile [#] Store hugo binary in versioned path 2024-08-28 13:48:35 +03:00
README.md [#13] Fix GH move leftovers 2023-04-18 10:02:35 +03:00

README.md

FrostFS logo

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.

We use Hugo for static content generation, so most of Hugo guides are applicable for this site.

How to contribute

  1. Fork the repo
  2. Make some changes
  3. Check how it looks localy with make server
  4. Submit a PR
  5. 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

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.