From cc2209f7b12de19f855f8cc87cd2ad0a0e58843f Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Tue, 30 Aug 2016 12:53:34 +0200 Subject: [PATCH] Docsite: add a warning to the index page about the docsite being for master, and update the release process doc to remind the release master to remove it on the branch. --- docs/source/index.rst | 3 +++ docs/source/release-process.rst | 10 +++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index e1fbac846b..3ae4bec6d4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,9 @@ Welcome to the Corda repository! ================================ +.. warning:: This build of the docs is from the *master branch*, not a milestone release. It may not reflect the + current state of the code. + This documentation describes Corda, a proposed architecture for distributed ledgers, the vision for which is outlined in the `Corda Introductory Whitepaper`_. .. _`Corda Introductory Whitepaper`: _static/corda-introductory-whitepaper.pdf diff --git a/docs/source/release-process.rst b/docs/source/release-process.rst index 5cdf4201c9..2fcc8f1e58 100644 --- a/docs/source/release-process.rst +++ b/docs/source/release-process.rst @@ -34,11 +34,11 @@ Steps to cut a release 4. Regenerate the docsite if necessary and commit. 5. Create a branch with a name like `release-M0` where 0 is replaced by the number of the milestone. 6. Adjust the version in the root build.gradle file to take out the -SNAPSHOT and commit it on the branch. -7. Tag the branch with a tag like `release-M0.0` -8. Push the branch and the tag to git. -9. Write up a short announcement containing the summary of new features, changes, and API breaks. Send it to the - r3dlg-awg mailing list. -10. On master, adjust the version number in the root build.gradle file upwards. +7. Remove the "is master" warning from the docsite index page on this branch only. +8. Tag the branch with a tag like `release-M0.0` +9. Push the branch and the tag to git. +10. Write up a short announcement containing the summary of new features, changes, and API breaks. Send it to the r3dlg-awg mailing list. +11. On master, adjust the version number in the root build.gradle file upwards. If there are serious bugs found in the release, backport the fix to the branch and then tag it with e.g. `release-M0.1` Minor changes to the branch don't have to be announced unless it'd be critical to get all developers updated. \ No newline at end of file