Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Update to new release (OVA 2.0.0) documentation #1182

Closed
wants to merge 9 commits into from
Closed

Update to new release (OVA 2.0.0) documentation #1182

wants to merge 9 commits into from

Conversation

stx-hseow
Copy link
Contributor

@stx-hseow stx-hseow commented Aug 23, 2021 •
edited by markdownify bot
Loading

Signed-off-by: Harrison Seow harrison.seow@seagate.com

Describe your changes in brief

Changes

  • Why is this change required? What problem does it solve?
  • If proposing a new change then please raise an issue first

How Has This Been Tested? (Optional)

  • Please describe in detail how you tested your changes.
  • Include details of your testing environment, and the tests you ran to
  • How your change affects other areas of the code, etc.

Screenshots (if appropriate)

Checklist

  • tested locally
  • added new dependencies
  • updated the docs
  • added a test

View rendered README.md

@stx-hseow
Update to new release (OVA 2.0.0) documentation
f10285d 
Signed-off-by: Harrison Seow <harrison.seow@seagate.com>
@cla-bot cla-bot bot added the cla-signed label Aug 23, 2021
@stale
Copy link

stale bot commented Aug 27, 2021

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @mukul-seagate11 for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

mukul-seagate11
mukul-seagate11 suggested changes Sep 11, 2021
View reviewed changes
README.md Outdated Show resolved Hide resolved
@stx-hseow
Update to new link
ca92b3a 
Signed-off-by: Harrison Seow <harrison.seow@seagate.com>
@stale stale bot removed the needs-attention label Sep 12, 2021
@stale
Copy link

stale bot commented Sep 16, 2021

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @mukul-seagate11 for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

@stale stale bot removed the needs-attention label Sep 17, 2021
@stx-hseow
Copy link
Contributor Author

The link has been updated and should be good to go. Anything else?

johnbent
johnbent approved these changes Sep 21, 2021
View reviewed changes
Copy link
Contributor

@johnbent johnbent left a comment

Choose a reason for hiding this comment

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

@hseow-seagate , this is a great PR. Is it possible to create a Latest url and just use that instead though? That way we don't have to remember to change this every time we make a new release. What do you think @mukul-seagate11 ?

@stx-hseow
Copy link
Contributor Author

stx-hseow commented Sep 22, 2021 •
edited
Loading

@johnbent Sure, let me add the changes

EDIT: Putting the discussion link

@stx-hseow
Update files to use latest OVA
5dfdbf2 
Signed-off-by: Harrison <harrison.seow@seagate.com>
@stx-hseow
Copy link
Contributor Author

I've added a new folder latest and put in the new PI-3 OVA guide with the name CORTX_on_Open_Virtual_Appliance.rst, and also updated CONTRIBUTING.md / QUICK_START.md / README.md to use the latest link instead.

@stale
Copy link

stale bot commented Sep 26, 2021

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @mukul-seagate11 for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

@stale stale bot removed the needs-attention label Sep 29, 2021
@stx-hseow
Copy link
Contributor Author

@mukul-seagate11 is this good to go?

mukul-seagate11
mukul-seagate11 suggested changes Sep 30, 2021
View reviewed changes
CONTRIBUTING.md
@@ -2,7 +2,7 @@

CORTX is about building the world's best scalable mass-capacity object storage system. If you’re interested in what we’re building and intrigued by hard challenges, here's everything you need to know about contributing to the project and how to get started.

This guide is intended to provide quick start instructions for developers who want to build, test, and contribute to the CORTX software. If you are merely looking to _test_ CORTX, please use [these instructions](doc/ova/1.0.4/CORTX_on_Open_Virtual_Appliance.rst).
This guide is intended to provide quick start instructions for developers who want to build, test, and contribute to the CORTX software. If you are merely looking to _test_ CORTX, please use [these instructions](doc/ova/latest/CORTX_on_Open_Virtual_Appliance.rst).

Copy link
Contributor

@mukul-seagate11 mukul-seagate11 Sep 30, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

@hseow-seagate, don't create a separate file for latest as least OVA release is in https://github.com/Seagate/cortx/blob/e9fa271e318babc3a9c20467adf38259902b62f3/doc/ova/2.0.0/PI-3/CORTX_on_Open_Virtual_Appliance_PI-3.rst

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mukul-seagate11, can you check this and maybe put your thoughts to this discussion then?

@mukul-seagate11
Copy link
Contributor

@hseow-seagate, commented in #1185

@johnbent
Copy link
Contributor

johnbent commented Oct 4, 2021

@mukul-seagate11 can you please let me know what I should do with this one?

@mukul-seagate11
Copy link
Contributor

@hseow-seagate, I had commented in #1185 (reply in thread) so would suggest to close to this PR as well as discussion as that we are aligned with one structure.

You can raise a PR, if you find any broken link once Wiki pages are updated with new instructions which might be due to design or feature change in product.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mukul-seagate11 mukul-seagate11 mukul-seagate11 requested changes

@johnbent johnbent johnbent approved these changes

@shailesh-vaidya shailesh-vaidya Awaiting requested review from shailesh-vaidya shailesh-vaidya is a code owner

Assignees
No one assigned
Labels
cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stx-hseow @mukul-seagate11 @johnbent