mynewt-site

mynewt-site copied to clipboard

This is the site documentation for the Apache Mynewt project. It is built using MkDocs.

This repo previously contained all documentation relating to Apache Mynewt. The project documentation now resides in the mynewt-documentation repo. Code specific documentation is found in various mynewt-* code specific repos. Archived versions of the project documentation for releases 1.3.0 and earlier are found under versions.

Setup

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:

virtualenv venv
. venv/bin/activate

Install the requirements:

pip install -r requirements.txt

Submitting updates

1. Fork the repo.
2. Work on the master branch.
3. Preview your changes using MkDocs.
   • mkdocs serve
   • visit http://localhost:8000
4. Submit a pull request.

Deploying the latest docs

NOTE: These instructions assume that your workspace has all the mynewt repos cloned under the same parent directory.

First follow the steps at mynewt-documentation

Most steps for releasing docs happen at the mynewt-documentation repo. Follow the instructions there first.

Merge all changes and update

1. Merge pull requests to master on github.
2. Switch to the master branch.
   • git checkout master
3. While in master, do git pull --rebase origin master to pull the latest merged changes.

Cut a new versioned documentation set (if appropriate)

NOTE: Skip these steps if you are just refreshing the current documentation or site.

1. Create a new stanza in mkdocs.yml to reflect the new version.
   • At present master is the latest version.
   • And that should probably not change.
2. Add a new stanza in custom-theme/choose_doc_version.html for the new version.
3. Add a link to docs/documentation.md for the new version.
4. Add a Disallow section to extras/robots.txt for the new version so that these documents do not appear in search results before the latest docs.
5. Commit these changes.

Build

1. Run: ./build.py

Test

1. Run: ./serve.py
2. Visit http://localhost:8000

Deploy

1. Run: ./deploy.sh build
2. This will leave you on the asf-site branch.
3. 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.

Link Checking

1. Grab a link checking tool like Integrity
2. Run: ./build.py --test-build
3. Run: ./serve.py
4. Point the link checker at http://localhost:8000/