Данный проект является открытым, Вы можете помочь улучшить его. Создайте pull request с изменениями или issue c описанием проблемы в репозитории
Contribution to documentation
To contribute to documentation please follow the instructions:
- Create issue or assign to yourself.
Label the issue with
documentation - Create branch for the issue. Name it documentation/ISSUE_NUMBER-DESCRIPTION
- Create or edit documentation page
- Deploy locally
- Commit your changes to remote branch 6/ Create pull request to master
Create documentation page
To create new documentation page follow the instructions:
1) Add page reference to menu
entries:
- title: Sidebar
levels: two
folders:
- title: Model
output: web
folderitems:
- title: Catalog
url: /Catalog.html
output: web
- title: NEW_PAGE_TITLE
url: /NEW_PAGE_FILE_NAME.html
output: web
2) Add page to pages directory /docs/pages.
For model pages use corresponding directory /docs/pages/model
Page file should have .md extension and should be written using markdown syntax
See Catalog.md for example
Deploy locally
There are 2 ways to deploy documentation locally: using docker or local jekyll. Please pay attention, that there is no need to restart jekyll when you make changes to the pages, it will be regenerating automatically and in jekyll logs you will see following lines
Regenerating: 1 file(s) changed at 2019-09-12 00:49:27
index.md
...done in 3.1696679 seconds.
Using docker
1) open /docs directory in console
2) execute command
docker-compose up
Using local jekyll installation
1) Install jekyll 2) Start jekyll
jekyll serve