|author||aditihilbert <email@example.com>||Mon Feb 12 10:01:28 2018 -0800|
|committer||GitHub <firstname.lastname@example.org>||Mon Feb 12 10:01:28 2018 -0800|
Merge pull request #396 from ryangrimm/patch-4 The NimBLE Stack Initialization page no longer exists
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 release of MyNewt OS and its associated tools occurs, a new version directory should be created to hold all docs pertaining to that release. The documentation in the git
master branch of this repository always shows the latest docs under development. The following steps will create a documentation directory for a new release and make it available from the mynewt-site.
git checkout master
git pull --rebase origin masterto pull the latest merged changes.
NOTE: Skip these steps if you are just refreshing the current documentation or site.
mkdocs.ymlto reflect the new version.
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.