Lukáš Krupčík committed Feb 21, 2017 1 # User documentation = TEST  David Hrbáč committed Jan 24, 2017 2 3  This is project contain IT4Innovation user documentation source.  Lukáš Krupčík committed Dec 20, 2016 4   David Hrbáč committed Jan 21, 2017 5 ## Environments  David Hrbáč committed Jan 21, 2017 6   Lukáš Krupčík committed Jan 26, 2017 7 8 * [https://docs-new.it4i.cz - master branch](https://docs-new.it4i.cz - master branch) * [https://docs-new.it4i.cz/devel/$BRANCH_NAME](https://docs-new.it4i.cz/devel/$BRANCH_NAME) - maps the branches  David Hrbáč committed Jan 21, 2017 9   David Hrbáč committed Jan 21, 2017 10 11 ## URLs  Lukáš Krupčík committed Jan 26, 2017 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áč committed Jan 22, 2017 14 15 16  ## Rules  Lukáš Krupčík committed Jan 26, 2017 17 * [spellcheck https://github.com/lukeapage/node-markdown-spellcheck](spellcheck https://github.com/lukeapage/node-markdown-spellcheck)  David Hrbáč committed Jan 23, 2017 18   Lukáš Krupčík committed Jan 26, 2017 19 * [SI units http://physics.nist.gov/cuu/Units/checklist.html](SI units http://physics.nist.gov/cuu/Units/checklist.html)  David Hrbáč committed Jan 22, 2017 20 21 22 23 24 25 26 27   fair-share InfiniBand RedHat CentOS Mellanox   David Hrbáč committed Jan 24, 2017 28   David Hrbáč committed Feb 15, 2017 29 ## Mathematical Formulae  David Hrbáč committed Feb 15, 2017 30   Lukáš Krupčík committed Feb 17, 2017 31 ### Formulas are made with:  David Hrbáč committed Feb 15, 2017 32 33 34 35 36 37 38 39 40 41 42 43 44 45  * 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áč committed Jan 24, 2017 46 47 48 49 50 51 52 53 54 ## 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áč committed Feb 02, 2017 55   David Hrbáč committed Jan 24, 2017 56 57 58 59 60 61 62 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áč committed Feb 02, 2017 63   David Hrbáč committed Jan 24, 2017 64 65 66 67 68 69 70 71 72 73 74 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