ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-20 21:43:14 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

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.

Browse Source
This commit is contained in:
Mike Hearn 2016-08-30 12:53:34 +02:00
parent 5a5377f0a1
commit cc2209f7b1
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/source/index.rst
View File

@ -1,6 +1,9 @@
Welcome to the Corda repository! 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`_. 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 .. _`Corda Introductory Whitepaper`: _static/corda-introductory-whitepaper.pdf

10
docs/source/release-process.rst
View File

@ -34,11 +34,11 @@ Steps to cut a release
4. Regenerate the docsite if necessary and commit. 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. 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. 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` 7. Remove the "is master" warning from the docsite index page on this branch only.
8. Push the branch and the tag to git. 8. Tag the branch with a tag like `release-M0.0`
9. Write up a short announcement containing the summary of new features, changes, and API breaks. Send it to the 9. Push the branch and the tag to git.
r3dlg-awg mailing list. 10. 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. 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` 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. Minor changes to the branch don't have to be announced unless it'd be critical to get all developers updated.