Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refact(README): updated README for upgrades with some comments #2750

Merged
merged 3 commits into from Oct 15, 2019

Conversation

shubham14bajpai
Copy link
Member

@shubham14bajpai shubham14bajpai commented Sep 27, 2019

Signed-off-by: shubham shubham.bajpai@mayadata.io

This PR adds

  • upgrade paths for 1.3.0 upgrade.
  • comments to make the it more clear above the to-version and from-version in the job yaml, also the dependency of the image-tag to the to-version

Signed-off-by: shubham <shubham.bajpai@mayadata.io>
- updated example with latest image

Signed-off-by: shubham <shubham.bajpai@mayadata.io>
@@ -26,8 +29,9 @@ The upgrade of OpenEBS is a three step process:

**Note: It is mandatory to make sure to that all OpenEBS control plane
and data plane components are running with expected version before the upgrade.
- For upgrading to 1.1.0, the previous version should be 1.0.0
- For upgrading to 1.1.0, the previous version should be 1.0.0**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_n: the ** should be only on the last line. this will render entire section "Note" as bold.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added ** for all list items as the formatting was not making all the text bold.

@@ -7,6 +7,9 @@ This document describes the steps for the following OpenEBS Upgrade paths:
- Upgrade from 1.0.0 to 1.1.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section can be updated/simplified as follows:

  • Upgrade from 1.0.0 to any of 1.1.0, 1.2.0, 1.3.0
  • Upgrade from 1.1.0 to any of 1.2.0, 1.3.0
  • Upgrade from 1.2.0 to 1.3.0

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Signed-off-by: shubham <shubham.bajpai@mayadata.io>
@kmova kmova merged commit ab84654 into openebs:master Oct 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants