[GitHub] aditihilbert closed pull request #482: update the release/refresh process instructions

[GitBox <gi...@apache.org>]

aditihilbert closed pull request #482: update the release/refresh process instructions
URL: https://github.com/apache/mynewt-site/pull/482
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/README.md b/README.md
index 3ada8c42b6..e768464b57 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,12 @@
-The Apache MyNewt site is built using [MkDocs](http://www.mkdocs.org/).
+This is the site documentation for the Apache Mynewt project. It is built using
+[MkDocs](http://www.mkdocs.org/).
+
+This repo previously contained all documentation relating to Apache Mynewt. The
+project documentation now resides in the
+[mynewt-documentation](https://github.com/apache/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
 
@@ -25,17 +33,15 @@ Install the requirements:
     - visit [http://localhost:8000](http://localhost:8000)
 1. Submit a pull request.
 
-## Releasing a versioned set of MyNewt documentation
+## Deploying the latest docs
+
+NOTE: These instructions assume that your workspace has all the mynewt repos cloned under the same parent directory.
 
-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.
+### First follow the steps at mynewt-documentation
 
-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.
+Most steps for releasing docs happen at the
+[mynewt-documentation](https://github.com/apache/mynewt-documentation) repo.
+Follow the instructions there first.
 
 ### Merge all changes and update
 
@@ -44,18 +50,15 @@ directory for a new release and make it available from the mynewt-site.
     - `git checkout master`
 1. While in master, do `git pull --rebase origin master` to pull the latest merged changes.
 
-### Cut the new release documentation set
+### 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.
-1. Add a new _stanza_ in "custom-theme/choose_doc_version.html" for the new version.
-1. 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
+1. Add a new _stanza_ in `custom-theme/choose_doc_version.html` for the new version.
+1. Add a link to `docs/documentation.md` for the new version.
 1. 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.
 1. Commit these changes.
@@ -83,7 +86,10 @@ 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.
+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
 


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services