This is an open source project, so you may help to enhance it. Create pull request with changes made or issue with a problem description in repository
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
- 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 model
catalog model directory /docs/pages/model
.
Page file should have .md extension and should be written using markdown syntax
Deploy locally
To deploy documentation locally you have to install 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.
For using local jekyll instalation:
2) Start jekyll
jekyll serve