|author||Szymon Janc <firstname.lastname@example.org>||Thu Apr 08 02:09:02 2021 +0200|
|committer||Szymon Janc <email@example.com>||Thu Apr 08 09:30:34 2021 +0200|
Update download page with comments from announce list moderator Following issues were fixed: - there is no link to the KEYS file at https://downloads.apache.org/mynewt/KEYS - there is no mention of the need to verify downloads, nor information on how to do so using the KEYS and sigs or hashes - the core 1.9.0 link has a typo, so the link does not work - it's not clear what the difference is between the core and newt downloads. Are they both needed? - the download page must not link to non-released software such as code under development. Such links should be reserved for pages intended for developers only. - the download page must not link directly to mirror directories, as these don't carry the sigs and hashes: -- the Release Download link for MyNewt core 1.9.0 should be removed -- Added direct links to source and binary releases - fixed old releases links to point to archive server
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
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
NOTE: These instructions assume that your workspace has all the mynewt repos cloned under the same parent directory.
Most steps for releasing docs happen at the mynewt-documentation repo. Follow the instructions there first.
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.
custom-theme/choose_doc_version.htmlfor the new version.
docs/documentation.mdfor the new version.
extras/robots.txtfor the new version so that these documents do not appear in search results before the latest docs.
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.