diff --git a/content/cloud/contribute/index.md b/content/cloud/contribute/index.md index 769cba6505560c78c1f32b80b1562382487704c4..75e38d838a227562d7b7fb23f0d8e2f8b93947aa 100644 --- a/content/cloud/contribute/index.md +++ b/content/cloud/contribute/index.md @@ -4,33 +4,12 @@ date: 2021-05-18T11:22:35+02:00 draft: false --- -{{< hint danger >}} -**WARNING:** - -This page requires an update. -{{< /hint >}} +We use open-source [Hugo](https://gohugo.io/) project to generate the documentation. ## Requirements -Working with our documentation requires the following tools: -* *git* for version control -* *nodejs* and *gitbook* for content management +[Install](https://gohugo.io/getting-started/installing/) Hugo -This documentation is written in the *Markdown* markup language. - -```bash -# Debian -apt-get install nodejs git -``` -```bash -# CentOS -yum install nodejs git -``` -```bash -# Fedora -dnf install nodejs git -``` -Or see [NodeJS Documentation](https://nodejs.org/en/download/package-manager/) for distro-specific instructions. ## Work-flow Overview 1. Fork & clone repository @@ -54,19 +33,10 @@ git clone git@gitlab.ics.muni.cz:${GITLAB_USER}/documentation.git git checkout -b my_change ``` -## Install GitBook -```bash -npm install gitbook-cli -g - -# in `documentation` -gitbook install -``` -This step MAY require `sudo` depending on your system and NodeJS installation method. - ## Edit GitBook ```bash # in `documentation` -gitbook serve +hugo --config config-dev.toml serve ``` > Edits will be show live in your browser window, no need to refresh.