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
- Fork the repo.
- Work on the
- Preview your changes using MkDocs.
- visit http://localhost:8000
- Submit a pull request.
Releasing a versioned set of MyNewt documentation
NOTE: When it comes time to create a static versioned set of docs from the mynewt-documentation repo for v1.4.0, these instructions will need to be modified.
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.
Merge all changes and update
- Merge pull requests to
- Switch to the master branch.
git checkout master
- While in master, do
git pull --rebase origin masterto pull the latest merged changes.
Cut the new release documentation set
NOTE: Skip these steps if you are just refreshing the current documentation or site.
- Create a new stanza in
mkdocs.ymlto reflect the new version.
- At present
- And that should probably not change.
- At present
- Add a new stanza in "custom-theme/choose_doc_version.html" for the new version.
- Create a new directory in the versions directory for this new version.
- Copy the latest docs directory and mkdocs.yml file into the new version directory
- Set extra.version to the new version in the copied mkdocs.yml file
- Create a symbolic link to the customer-theme
- Commit these changes.
- Visit http://localhost:8000
- This will leave you on the
- Commit & push the changes.
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.
Links to Documentation
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.