|author||aditihilbert <email@example.com>||Tue Jul 18 12:37:09 2017 -0700|
|committer||GitHub <firstname.lastname@example.org>||Tue Jul 18 12:37:09 2017 -0700|
Merge pull request #259 from cwanda/rtt Added note on J-Link versions and input char limits.
The Apache MyNewt site is built using MkDocs.
Clone the repo:
git clone https://github.com/apache/mynewt-site cd mynewt-site
Optional: it's a very good idea to use a
virtualenv venv . venv/bin/activate
Install the requirements:
pip install -r requirements.txt
When a new release of MyNewt OS and its associated tools occurs, the documentation in the git
develop branch of this repository should be in sync with the released version. The following steps will create a documentation branch for the release and make it available as the default documentation from the mynewt-site.
git pull --rebase origin developto pull the latest merged changes.
git checkout master
mkdocs.ymlto reflect the new version.
latestflag, only one release should be marked latest.
The runtime-bot github user does a build every ~15 minutes and opens a Pull Request against the asf-site branch if there are any changes. It is recommended that the runtime-bot PRs are used to deploy changes to the site instead of PRs from individual contributors. The runtime-bot PRs give us repeatable builds using known versions of the build tools.
For the deployed site a version prefix is added to the URL for each mkdocs page. When developing there is no version prefix. If you want to link from a site page to a documentation page you should prefix the URL with /DOCSLINK/ so that the user is taken to the correct location when browsing in production.