README.md 2.16 KB
Newer Older
1
# User documentation
David Hrbáč's avatar
David Hrbáč committed
2 3

This is project contain IT4Innovation user documentation source.
Lukáš Krupčík's avatar
Lukáš Krupčík committed
4

David Hrbáč's avatar
David Hrbáč committed
5
## Environments
David Hrbáč's avatar
David Hrbáč committed
6

7 8
* [https://docs.it4i.cz - master branch](https://docs.it4i.cz - master branch)
* [https://docs.it4i.cz/devel/$BRANCH_NAME](https://docs.it4i.cz/devel/$BRANCH_NAME) - maps the branches, available only with VPN access
David Hrbáč's avatar
David Hrbáč committed
9

David Hrbáč's avatar
David Hrbáč committed
10 11
## URLs

Lukáš Krupčík's avatar
Lukáš Krupčík committed
12 13
* [http://facelessuser.github.io/pymdown-extensions/](http://facelessuser.github.io/pymdown-extensions/)
* [http://squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)
David Hrbáč's avatar
Rules  
David Hrbáč committed
14 15 16

## Rules

Lukáš Krupčík's avatar
Lukáš Krupčík committed
17 18
* [spellcheck https://github.com/lukeapage/node-markdown-spellcheck](spellcheck https://github.com/lukeapage/node-markdown-spellcheck)
* [SI units http://physics.nist.gov/cuu/Units/checklist.html](SI units http://physics.nist.gov/cuu/Units/checklist.html)
David Hrbáč's avatar
Rules  
David Hrbáč committed
19 20 21 22 23 24 25 26

```
fair-share
InfiniBand
RedHat
CentOS
Mellanox
```
David Hrbáč's avatar
David Hrbáč committed
27

David Hrbáč's avatar
David Hrbáč committed
28
## Mathematical Formulae
David Hrbáč's avatar
David Hrbáč committed
29

Lukáš Krupčík's avatar
Lukáš Krupčík committed
30
### Formulas are made with:
David Hrbáč's avatar
David Hrbáč committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44

* 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.

David Hrbáč's avatar
David Hrbáč committed
45 46 47 48 49 50 51 52 53
## Developemnt Environment

### MkDocs

Documentation pages are build with [MkDocs](http://www.mkdocs.org/), [MkDocs at GitHub](https://github.com/mkdocs/mkdocs/). You need to install mkdocs loacally so that you can build the pages and run developement web server.

```bash
pip install mkdocs pygments pymdown-extensions
```
David Hrbáč's avatar
David Hrbáč committed
54

David Hrbáč's avatar
David Hrbáč committed
55 56 57 58 59 60 61
You can build the pages with `mkdocs build`.

```bash
‹hrb33-toshiba› 11:47 $ mkdocs build
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/hrb33/Dokumenty/dev/it4i/docs.it4i.git/site
```
David Hrbáč's avatar
David Hrbáč committed
62

David Hrbáč's avatar
David Hrbáč committed
63 64 65 66 67 68 69 70 71 72 73
You can start local server with `mkdocs serve`.

```bash
✔ ~/Dokumenty/dev/it4i/docs.it4i.git [readme L|✚ 1…6⚑ 1]
‹hrb33-toshiba› 11:47 $ mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
[I 170124 11:47:27 server:283] Serving on http://127.0.0.1:8000
[I 170124 11:47:27 handlers:60] Start watching changes
[I 170124 11:47:27 handlers:62] Start detecting changes
```