potyarkin/frostfs.info
1
0
Fork 0
forked from TrueCloudLab/frostfs.info
Code Pull requests Activity
WIP: FrostFS site for everything
26 commits 2 branches 0 tags 284 KiB
Find a file
Vitaliy Potyarkin caee2a4d55 [#28] Add CODEOWNERS 
Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
2024-12-10 18:49:13 +03:00
.forgejo [#27] Stop using obsolete .github directory 2024-11-06 15:21:07 +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 [#25] Store hugo binary in versioned path 2024-09-05 12:21:34 +03:00
.gitmodules [#25] Build the site with Forgejo Actions 2024-09-05 12:21:34 +03:00
CODEOWNERS [#28] Add CODEOWNERS 2024-12-10 18:49:13 +03:00
config.toml update copyright years 2024-09-05 08:20:16 +00:00
LICENSE [#1] Implement initial doc site 2022-12-29 15:35:27 +03:00
Makefile [#25] Deploy the site via SSH 2024-09-05 12:21:34 +03:00
README.md [#27] Stop using obsolete .github directory 2024-11-06 15:21:07 +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.