cesnet / einfra-docs

User Documentation

This project contains e-INFRA CZ documentation portal source.

Development

Install

$ sudo apt install libpython-dev
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt

or using docker

$ git submodule update --init --recursive
$ sudo ./start.sh

the -b parameter builds the container with required dependencies.

Package Upgrade With pip

$ pip list -o
$ pip install --upgrade package
$ pip freeze | sed '/pkg-resources==/d' > requirements.txt

Environments

• [https://docs.it4i.cz - master branch](https://docs.it4i.cz - master branch)
• https://docs.it4i.cz/devel/$BRANCH_NAME - maps the branches, available only with VPN access

URLs

• http://facelessuser.github.io/pymdown-extensions/
• http://squidfunk.github.io/mkdocs-material/

fair-share
InfiniBand
RedHat
CentOS
Mellanox

Mathematical Formulae

Formulas Are Made With:

• https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/
• https://www.mathjax.org/

You can add formula to page like this:

$$
MAX\_FAIRSHARE * ( 1 - \frac{usage_{Project}}{usage_{Total}} )
$$

To enable the MathJX on page you need to enable it by adding line ---8<--- "mathjax.md" at the end of file.

einfra-docs's Issues

Spolocne dokumentacke stranky pre software, aplikacie a licencie

Prepinatko jazyka

Kdyz napriklad na https://docs.e-infra.cz/storage/object-storage/rbd-setup/ pouziju tlacitko na prepinani jazyka, ale nikoli to, co je vedle titulku stranky, ale to v horni fialove liste uplne nahore, tak dostanu 404. Navic to prepinaci tlacitko v horni fialove liste magicky mizi a obcas se objevi, kdyz se clovek temi strankami proklikava. Prijde mi to trochu matouci.

Tlacitko na prepnuti jazyka v textu vedle hlavniho titulku stranky elementarne funguje (byt tam tedy jeste nejsou veci, co jsme se posledne domlouvali ohledne odkazu na automaticky preklad, kdyz stranka v prislusne verzi neexistuje).

Podpora cestiny a anglictiny v dokumentacii

[broken link] SensitiveCloud on Cerit website

Hi,

link [1] in SensitiveCloud Overview docs leads to a page that does not exist.

Link to the source line: https://github.com/CESNET/eInfra-docs/blob/97865113f4a2beb3fcd909332d9457174d9d3aeb/topics/compute/sensitive/docs/index.md?plain=1#L41C6-L41C88

The target website (https://www.cerit-sc.cz/infrastructure-services/trusted-environment-for-sensitive-data) is "Not found"

(Dokumentace je anglicky, tak píši anglicky, ale pokud tu komunikujete v češtině, samozřejmě není problém.)