Toolchain Document Center

This repository is the document center for the documents releasing to customers.

This repository is moved to Github: https://github.com/kneron/document_center.

How to add a new page.

1. Create a .md markdown file under docs/ or its subfolder. Edit the content.
2. Add it under nav in mkdocs.yml so that users can access it from the left-side menu.
3. Run a testing server to check if it looks good. (Ypu can check the following sections on how to setup test environment.)
4. Commit your change and submit a pull request. Remember to assign it to a maintainer.

How to migrate from gitlab

First, you need to set up your Github account. Then, you just need to run the following command to reset the remote:

git remote set-url origin [email protected]:kneron/document_center.git

After that, we recommend you switch to master branch and use git pull to update the local master branch before your start your work.

Test environment setup

1. Install Python3 and corresponding pip.
2. Install dependencies with pip install -r requirements.txt. The file is under the project root folder.
3. Run mkdocs serve to host a debug website locally. If the command mkdocs is not found, you may want to run python3 -m mkdocs serve.
4. Use the browser to visit your local website. And you can check how your modification looks like on the website yourself.

Deploy on server

1. Install Python3 and corresponding pip.
2. Install dependencies with pip install -r requirements.txt. The file is under the project root folder.
3. Run mkdocs build to build the static web pages. If the command mkdocs is not found, you may want to run python3 -m mkdocs build.
4. The generated website is under site folder. Just deploy it as a static website.