Tarball installation guide refactor #881

JeffHuss · 2022-08-11T22:49:36Z

Signed-off-by: JeffH-AWS [email protected]

Description

This PR represents the work being done around a refactor of the tarball instructions.

Issues Resolved

This PR relates to issue #789

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: JeffH-AWS <[email protected]>

JeffHuss · 2022-08-11T22:51:24Z

Had to open this new PR because the old one (#855) included a commit missing DCO. Since this is a draft PR the commit history isn't important so I've just cut a new branch with a clean history. Looks like DCO is working on my new laptop now, though!

Signed-off-by: JeffH-AWS <[email protected]>

…s guide Signed-off-by: JeffH-AWS <[email protected]>

Signed-off-by: JeffH-AWS <[email protected]>

vagimeli

Insert comma after distribution; delete commas surrounding the verbiage "but not limited to;" delete that verbiage too. For example, "...distributions, including CentOS..."

_opensearch/install/tar.md

kolchfa-aws

LGTM - left a couple of comments.

JeffHuss · 2022-08-25T15:16:40Z

This guide is now pending editorial review. Please DO NOT MERGE until that review is completed.

Signed-off-by: JeffH-AWS <[email protected]>

JeffHuss · 2022-08-29T17:47:10Z

Per discussion with the editor last week, this should be ready to publish sometime this week.

Signed-off-by: JeffH-AWS <[email protected]>

natebower

@JeffH-AWS Please see my comments and let me know if you have any questions. Thanks!

_opensearch/install/tar.md

Signed-off-by: JeffH-AWS <[email protected]>

* New PR because the old one was corrupted by a commit without DCO Signed-off-by: JeffH-AWS <[email protected]> * Fixed syntax for bullet/numbered lists. Signed-off-by: JeffH-AWS <[email protected]> * Added validation steps to the end Signed-off-by: JeffH-AWS <[email protected]> * Cleaning up phrasing and grammar Signed-off-by: JeffH-AWS <[email protected]> * Making some changes based on peer feedback Signed-off-by: JeffH-AWS <[email protected]> * Fixing opening section Signed-off-by: JeffH-AWS <[email protected]> * Fixing phrasing and rewording headers Signed-off-by: JeffH-AWS <[email protected]> * Cleaning up more Signed-off-by: JeffH-AWS <[email protected]> * Moved unrelated content to the appropriate pages and deleted from this guide Signed-off-by: JeffH-AWS <[email protected]> * Added templates for links Signed-off-by: JeffH-AWS <[email protected]> * Added a few related links that make sense as logical next steps Signed-off-by: JeffH-AWS <[email protected]> * Cleaned up link formatting. Ready for review now. Signed-off-by: JeffH-AWS <[email protected]> * Applied changes recommended by vagimeli Signed-off-by: JeffH-AWS <[email protected]> * Applied changed from PR review Signed-off-by: JeffH-AWS <[email protected]> * Added step numbers to headers and periods to bullet list at the top Signed-off-by: JeffH-AWS <[email protected]> * Fix typo in script comment Signed-off-by: JeffH-AWS <[email protected]> * Made most of the editorial changes but there are a couple open items Signed-off-by: JeffH-AWS <[email protected]> * Final editorial changes applied, ready to merge Signed-off-by: JeffH-AWS <[email protected]> Signed-off-by: JeffH-AWS <[email protected]> (cherry picked from commit f65dce5)

* New PR because the old one was corrupted by a commit without DCO Signed-off-by: JeffH-AWS <[email protected]> * Fixed syntax for bullet/numbered lists. Signed-off-by: JeffH-AWS <[email protected]> * Added validation steps to the end Signed-off-by: JeffH-AWS <[email protected]> * Cleaning up phrasing and grammar Signed-off-by: JeffH-AWS <[email protected]> * Making some changes based on peer feedback Signed-off-by: JeffH-AWS <[email protected]> * Fixing opening section Signed-off-by: JeffH-AWS <[email protected]> * Fixing phrasing and rewording headers Signed-off-by: JeffH-AWS <[email protected]> * Cleaning up more Signed-off-by: JeffH-AWS <[email protected]> * Moved unrelated content to the appropriate pages and deleted from this guide Signed-off-by: JeffH-AWS <[email protected]> * Added templates for links Signed-off-by: JeffH-AWS <[email protected]> * Added a few related links that make sense as logical next steps Signed-off-by: JeffH-AWS <[email protected]> * Cleaned up link formatting. Ready for review now. Signed-off-by: JeffH-AWS <[email protected]> * Applied changes recommended by vagimeli Signed-off-by: JeffH-AWS <[email protected]> * Applied changed from PR review Signed-off-by: JeffH-AWS <[email protected]> * Added step numbers to headers and periods to bullet list at the top Signed-off-by: JeffH-AWS <[email protected]> * Fix typo in script comment Signed-off-by: JeffH-AWS <[email protected]> * Made most of the editorial changes but there are a couple open items Signed-off-by: JeffH-AWS <[email protected]> * Final editorial changes applied, ready to merge Signed-off-by: JeffH-AWS <[email protected]> Signed-off-by: JeffH-AWS <[email protected]> (cherry picked from commit f65dce5) Co-authored-by: Jeff Huss <[email protected]>

New PR because the old one was corrupted by a commit without DCO

5e3c6dc

Signed-off-by: JeffH-AWS <[email protected]>

JeffHuss requested a review from a team as a code owner August 11, 2022 22:49

JeffHuss marked this pull request as draft August 11, 2022 22:49

JeffHuss added 2 - In progress Issue/PR: The issue or PR is in progress. backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x v-All This issue is valid for all versions through 1.3 labels Aug 11, 2022

JeffHuss added this to the 2022-Q3 milestone Aug 11, 2022

JeffH-AWS added 2 commits August 15, 2022 09:53

Fixed syntax for bullet/numbered lists.

2e61002

Signed-off-by: JeffH-AWS <[email protected]>

Added validation steps to the end

2b28bc7

Signed-off-by: JeffH-AWS <[email protected]>

JeffHuss mentioned this pull request Aug 15, 2022

[DOC-META] Installation guide refactor + recommended config (Tarball, Docker, Yum, RPM) #789

Closed

10 tasks

JeffH-AWS added 3 commits August 16, 2022 07:32

Cleaning up phrasing and grammar

ea13d03

Signed-off-by: JeffH-AWS <[email protected]>

Making some changes based on peer feedback

a04b53c

Signed-off-by: JeffH-AWS <[email protected]>

Fixing opening section

6512f0d

Signed-off-by: JeffH-AWS <[email protected]>

JeffHuss self-assigned this Aug 19, 2022

JeffH-AWS added 3 commits August 19, 2022 10:57

Fixing phrasing and rewording headers

f64f56e

Signed-off-by: JeffH-AWS <[email protected]>

Cleaning up more

e61f5e8

Signed-off-by: JeffH-AWS <[email protected]>

Moved unrelated content to the appropriate pages and deleted from thi…

51174a0

…s guide Signed-off-by: JeffH-AWS <[email protected]>

JeffHuss added the backport 2.1 PR: Backport label for 2.1 label Aug 23, 2022

JeffH-AWS added 3 commits August 24, 2022 09:24

Added templates for links

af04597

Signed-off-by: JeffH-AWS <[email protected]>

Added a few related links that make sense as logical next steps

0887726

Signed-off-by: JeffH-AWS <[email protected]>

Cleaned up link formatting. Ready for review now.

ee2f707

Signed-off-by: JeffH-AWS <[email protected]>

JeffHuss added 4 - Doc review PR: Doc review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Aug 24, 2022

JeffHuss marked this pull request as ready for review August 24, 2022 16:38

vagimeli suggested changes Aug 24, 2022

View reviewed changes

vagimeli reviewed Aug 24, 2022

View reviewed changes