You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2017/07/01 00:42:26 UTC
[mynewt-site] branch master updated (68a580d -> 5586613)
This is an automated email from the ASF dual-hosted git repository.
aditi pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-site.git.
from 68a580d updated readme
new f648727 updated instructions for generating site
new 5586613 Update build process in readme
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
--
To stop receiving notification emails like this one, please contact
['"commits@mynewt.apache.org" <co...@mynewt.apache.org>'].
[mynewt-site] 01/02: updated instructions for generating site
Posted by ad...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aditi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-site.git
commit f648727134069d014afa39d5002e78fdff2f2f6e
Author: aditihilbert <ad...@runtime.io>
AuthorDate: Fri Jun 30 16:29:14 2017 -0700
updated instructions for generating site
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 1f6a15a..1bd4243 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,7 @@ When a new release of MyNewt OS and its associated tools occurs, the documentati
### Build
1. Merge pull requests to `develop` on github.
-1. While in `develop`, do 'git pull --rebase origin develop` to pull the latest merged changes.
+1. While in `develop`, do `git pull --rebase origin develop` to pull the latest merged changes.
1. Switch to the master branch.
* `git checkout master`
1. Create a new _stanza_ in `mkdocs.yml` to reflect the new version.
--
To stop receiving notification emails like this one, please contact
"commits@mynewt.apache.org" <co...@mynewt.apache.org>.
[mynewt-site] 02/02: Update build process in readme
Posted by ad...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aditi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-site.git
commit 55866139178f0b487169ef3b90ff005d5df0bd18
Author: aditihilbert <ad...@runtime.io>
AuthorDate: Fri Jun 30 17:41:24 2017 -0700
Update build process in readme
---
README.md | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 1bd4243..ef49c80 100644
--- a/README.md
+++ b/README.md
@@ -26,19 +26,20 @@ Install the requirements:
1. Submit a pull request.
## Releasing a versioned set of MyNewt documentation
-When a new release of MyNewt OS and its associated tools occurs, the documentation in the git `develop` branch of this repository should be in sync with the released version. The following steps will create a documentation branch for the release and make it available as the default documentation from the mynewt-site.
+When a release of MyNewt OS and its associated tools occurs, a new branch should be created to hold all docs pertaining to that release. The documentation in the git `develop` branch of this repository always shows the latest docs under development (beyond the latest release). The following steps will create a documentation branch for a new release and make it available from the mynewt-site.
### Build
1. Merge pull requests to `develop` on github.
-1. While in `develop`, do `git pull --rebase origin develop` to pull the latest merged changes.
+1. Checkout `develop`.
+ * `git pull --rebase origin develop` to pull the latest merged changes.
1. Switch to the master branch.
* `git checkout master`
-1. Create a new _stanza_ in `mkdocs.yml` to reflect the new version.
+1. Create a new _stanza_ in `mkdocs.yml` to reflect the new version. (SKIP THIS STEP IF NOT A NEW RELEASE)
* and update the `latest` flag, only one release should be marked latest.
* **and update version to match the new branch name.**
-1. Commit this change.
-1. Create a branch from master to reflect this new version.
+1. Commit this change. (SKIP THIS STEP IF NOT A NEW RELEASE)
+1. Create a branch from master to reflect this new version. (SKIP THIS STEP IF NOT A NEW RELEASE)
1. Run: `./build.py`
### Test
@@ -48,7 +49,7 @@ When a new release of MyNewt OS and its associated tools occurs, the documentati
### Deploy
-1. Run: `./deploy.sh`
+1. Run: `./deploy.sh build`
1. This will leave you on the `asf-site` branch.
1. Commit & push the changes.
--
To stop receiving notification emails like this one, please contact
"commits@mynewt.apache.org" <co...@mynewt.apache.org>.