From b95d2f2212165160e1ddbe2f064559433ba7878c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=A0imon=20Berka?= <433498@mail.muni.cz>
Date: Mon, 14 Jun 2021 09:05:02 +0000
Subject: [PATCH] Enhancements
---
.gitlab-ci.yml | 2 +-
ci/flavor_info_miner.py | 2 +-
content/cloud/contribute/index.md | 38 +++++++++++++++++++++++++------
content/cloud/flavors/index.md | 3 ++-
content/cloud/news/index.md | 1 +
layouts/partials/menu.html | 4 +++-
6 files changed, 39 insertions(+), 11 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 14a9984..1e21dc7 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -23,7 +23,7 @@ pages:
- apk add py3-yaml
script:
- git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.ics.muni.cz/cloud/hiera.git
- - sed -i '9,$d' content/cloud/flavors/index.md
+ - sed -i '10,$d' content/cloud/flavors/index.md
- echo "{{< csv-table header=\"true\">}}" >> content/cloud/flavors/index.md
- python3 ci/flavor_info_miner.py --hiera-file ./hiera/group/ostack/flavors.yaml
- cat flavors.csv >> content/cloud/flavors/index.md
diff --git a/ci/flavor_info_miner.py b/ci/flavor_info_miner.py
index a4314d8..dce2d5e 100644
--- a/ci/flavor_info_miner.py
+++ b/ci/flavor_info_miner.py
@@ -25,7 +25,7 @@ data = data['cloud::profile::kolla::nova::controller::os_flavors']
#Names for columns
-details = ['Flavor name' , 'CPU' , 'RAM (in GB)' , 'HPC' , 'SSD' , 'Disc throughput (in MB per second)' , 'IOPS', 'Net average througput (in MB per second)', 'GPU']
+details = ['Flavor name' , 'CPU' , 'RAM (in GB)' , 'HPC' , 'SSD' , 'Disc throughput (in MB per second)' , 'IOPS', 'Net average throughput (in MB per second)', 'GPU']
blacklist = ['cerit.hde-half', 'cerit.hde', 'meta.mema2', 'csirtmu.tiny1x2', 'csirtmu.tiny1x4', 'csirtmu.small2x4', 'csirtmu.small2x8', 'csirtmu.medium4x8', 'csirtmu.medium4x16',
'csirtmu.large8x16', 'csirtmu.large4x32', 'csirtmu.large8x32', 'csirtmu.jumbo16x32', 'csirtmu.jumbo8x64', 'csirtmu.jumbo16x64', 'du.perftest', 'admin.scaletest', 'hpc.18core-64ram-dukan',
diff --git a/content/cloud/contribute/index.md b/content/cloud/contribute/index.md
index ba550c2..f926147 100644
--- a/content/cloud/contribute/index.md
+++ b/content/cloud/contribute/index.md
@@ -19,33 +19,57 @@ We use open-source [Hugo](https://gohugo.io/) project to generate the documentat
4. Push to the branch
5. Create a Merge Request with the content of your branch
-## Fork Repository
+### Fork Repository
See [GitLab @ ICS MU](https://gitlab.ics.muni.cz/cloud/documentation/forks/new) for details. This will create your own clone of our repository where you will be able to make changes. Once you are happy with your changes, use GitLab to submit them to our original repository.
-## Clone Repository
+### Clone Repository
```bash
# after creating your own copy of the repository on GitLab
git clone git@gitlab.ics.muni.cz:${GITLAB_USER}/documentation.git
```
-## Create New Branch
+### Create New Branch
```bash
# in `documentation`
git checkout -b my_change
```
-## Make Changes & Run Local Server
+### Make Changes & Run Local Server
```bash
# in `documentation`
hugo --config config-dev.toml serve
```
> Edits will be show live in your browser window, no need to restart the server.
-## Commit and Push Changes
+### Commit and Push Changes
```bash
git commit -am "My updates"
git push origin my_change
```
-## Submit Changes
-Create a *Merge Request* via [GitLab @ ICS MU](https://gitlab.ics.muni.cz/cloud/documentation/merge_requests/new).
\ No newline at end of file
+### Submit Changes
+Create a *Merge Request* via [GitLab @ ICS MU](https://gitlab.ics.muni.cz/cloud/documentation/merge_requests/new).
+
+
+## Tips
+### Disable table of content
+Table of content is generated automatically for every page. To hide table of contents, put this line to page's header:
+```
+disableToc: true
+```
+
+### Hide from menu
+To hide page from menu, add this line to page's header:
+```
+GeekdocHidden: true
+```
+
+
+### Hints
+To show "hint bar" similar to this one:
+{{< hint info >}}
+some text
+{{</hint>}}
+you can use *short codes*.
+
+Please see [theme documentation](https://geekdocs.de/shortcodes/hints/).
\ No newline at end of file
diff --git a/content/cloud/flavors/index.md b/content/cloud/flavors/index.md
index 90b9e5e..b31a0f8 100644
--- a/content/cloud/flavors/index.md
+++ b/content/cloud/flavors/index.md
@@ -2,6 +2,7 @@
title: "Flavors"
date: 2021-05-18T11:22:35+02:00
draft: false
+disableToc: true
---
In this guide you can find info about all flavors available in Metacentrum Cloud.
@@ -10,7 +11,7 @@ In this guide you can find info about all flavors available in Metacentrum Cloud
{{< csv-table header="true">}}
-Flavor name,CPU,RAM (in GB),HPC,SSD,Disc throughput (in MB per second),IOPS,Net average througput (in MB per second),GPU
+Flavor name,CPU,RAM (in GB),HPC,SSD,Disc throughput (in MB per second),IOPS,Net average throughput (in MB per second),GPU
elixir.hda1,30,724,Yes,No,Unlimited,Unlimited,Unlimited,No
elixir.hda1-10core-240ram,10,240,Yes,No,Unlimited,Unlimited,Unlimited,No
hpc.16core-128ram,16,128,Yes,No,524.288,2000,2000.0,No
diff --git a/content/cloud/news/index.md b/content/cloud/news/index.md
index b6b725a..3bded7a 100644
--- a/content/cloud/news/index.md
+++ b/content/cloud/news/index.md
@@ -3,6 +3,7 @@ title: "News"
date: 2021-05-18T11:22:35+02:00
draft: false
disableToc: true
+GeekdocHidden: true
---
diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html
index 8050b58..72a5dd5 100644
--- a/layouts/partials/menu.html
+++ b/layouts/partials/menu.html
@@ -6,7 +6,9 @@
<h2>Navigation</h2>
<ul class="gdoc-nav__list">
<li><span class="flex"><strong>Information</strong></span>
- <ul><span class="flex"><a class="gdoc-nav__entry " href="/documentation/cloud/news/">News</a></span></ul>
+ <ul class="gdoc-nav__list">
+ <li><span class="flex"><a class="gdoc-nav__entry " href="/documentation/cloud/news/">News</a></span></li>
+ </ul>
</li>
</ul>
</section>
--
GitLab