Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
| ... | ... |
@@ -97,3 +97,46 @@ to - which you call from the `docker` directory: |
| 97 | 97 |
|
| 98 | 98 |
make AWS_S3_BUCKET=dowideit-docs docs-release |
| 99 | 99 |
|
| 100 |
+This will publish _only_ to the `http://bucket-url/v1.2/` version of the |
|
| 101 |
+documentation. |
|
| 102 |
+ |
|
| 103 |
+If you're publishing the current release's documentation, you need to |
|
| 104 |
+also update the root docs pages by running |
|
| 105 |
+ |
|
| 106 |
+ make AWS_S3_BUCKET=dowideit-docs BUILD_ROOT=yes docs-release |
|
| 107 |
+ |
|
| 108 |
+## Cherry picking documentation changes to update an existing release. |
|
| 109 |
+ |
|
| 110 |
+Whenever the core team makes a release, they publish the documentation based |
|
| 111 |
+on the `release` branch (which is copied into the `docs` branch). The |
|
| 112 |
+documentation team can make updates in the meantime, by cherry-picking changes |
|
| 113 |
+from `master` into any of the docs branches. |
|
| 114 |
+ |
|
| 115 |
+For example, to update the current release's docs: |
|
| 116 |
+ |
|
| 117 |
+ git fetch upstream |
|
| 118 |
+ git checkout -b post-1.2.0-docs-update-1 upstream/docs |
|
| 119 |
+ # Then go through the Merge commit linked to PR's (making sure they apply |
|
| 120 |
+ to that release) |
|
| 121 |
+ # see https://github.com/docker/docker/commits/master |
|
| 122 |
+ git cherry-pick -x fe845c4 |
|
| 123 |
+ # Repeat until you have cherry picked everything you will propose to be merged |
|
| 124 |
+ git push upstream post-1.2.0-docs-update-1 |
|
| 125 |
+ |
|
| 126 |
+Then make a pull request to merge into the `docs` branch __NOT__ master. |
|
| 127 |
+ |
|
| 128 |
+Once the PR has the needed `LGTM`'s, merge it, then publish to our beta server |
|
| 129 |
+to test: |
|
| 130 |
+ |
|
| 131 |
+ git fetch upstream |
|
| 132 |
+ git checkout post-1.2.0-docs-update-1 |
|
| 133 |
+ git reset --hard upstream/post-1.2.0-docs-update-1 |
|
| 134 |
+ make AWS_S3_BUCKET=beta-docs.docker.io BUILD_ROOT=yes docs-release |
|
| 135 |
+ |
|
| 136 |
+Then go to http://beta-docs.docker.io.s3-website-us-west-2.amazonaws.com/ |
|
| 137 |
+and make sure that what you have published is good. |
|
| 138 |
+ |
|
| 139 |
+When you're happy with it, publish the docs to our live site: |
|
| 140 |
+ |
|
| 141 |
+ make AWS_S3_BUCKET=docs.docker.com BUILD_ROOT=yes docs-release |
|
| 142 |
+ |