Skip to content

Commit

Permalink
Add notes about versions
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
  • Loading branch information
mbwhite committed Jul 19, 2022
1 parent 9ccf918 commit 2a1b7d9
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The IBM Blockchain Platform provides advanced tooling that allows you to quickly

This Ansible collection, provided as part of the IBM Blockchain Platform, enables you to automate the building of Hyperledger Fabric networks.

*Please Note* the main branch is now set to `2.0.0-beta`, the `release-1.2` branch is available. If you build a local copy of Ansible for production, please work from the `release-1.2` branch.
## Documentation

Documentation for this Ansible collection is available here: https://ibm-blockchain.github.io/ansible-collection/
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ This Ansible collection is maintained by the IBM Blockchain Platform development
:hidden:

installation
migrating-v12-v2.rst

.. toctree::
:maxdepth: 2
Expand Down
3 changes: 2 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,13 @@ Installing from source
----------------------

You can use the ``ansible-galaxy`` command to install a collection built from source. To build your own collection, follow these steps:
This will build the stable `release-1.2` branch for v1.2.; use the `main` branch for the `2.0.0-beta` level

1. Clone the repository:

::

git clone https://github.com/IBM-Blockchain/ansible-collection.git
git clone --branch release-1.2 https://github.com/IBM-Blockchain/ansible-collection.git

2. Build the collection artifact:

Expand Down
10 changes: 10 additions & 0 deletions docs/source/migrating-v12-v2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
..
.. SPDX-License-Identifier: Apache-2.0
..
Migrating from v1.2 to version 2
================================

Consistent with a major version upgrade, the following are important changes between v1.2 and v2

- tba

0 comments on commit 2a1b7d9

Please sign in to comment.