Add documentation publishing instructions

Alfonso Acosta
2016-06-20 13:03:13 +02:00
parent 2d4e83b9e8
commit 7cbd446c34
+11
@@ -132,4 +132,15 @@ Merge the release branch to master.
Go to [https://checkpoint-api.weave.works/admin](https://checkpoint-api.weave.works/admin) and fill in the details of the release for **both for the scope-app and scope-probe products** so that users can be automatically informed of a new version being available.
## Publish documentation
1. Install wordepress: `go get -u github.com/weaveworks/wordepress/cmd/wordepress`
2. Obtain a Wordpress application password:
* Login to https://weave.works/wp-admin
* Navigate to Users -> Your Profile -> Application Passwords
* Enter 'wordepress' as the application name and choose 'Add New'
3. Publish the documentation:
* Dry run: `wordepress publish --dry-run --url https://www.weave.works --user yourwordpressuser --password 'your wordpress application password' --product scope --tag latest --version 0.1.0 releases/v0.1.0`
* If everything went well, pubslish without dry-run: `wordepress publish --url https://www.weave.works --user yourwordpressuser --password 'your wordpress application password' --product scope --tag latest --version 0.1.0 releases/v0.1.0`
You're done. Congratulations.