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

Add migrations section #8873

Merged
merged 19 commits into from
Dec 4, 2024
Merged

Add migrations section #8873

merged 19 commits into from
Dec 4, 2024

Conversation

Naarcha-AWS
Copy link
Collaborator

Description

Removes the old migrations section and removes the "upgrade_to" directory. Can add redirects from the upgrade pages, if necessary. However, no links exist to the current upgrade flow in the rest of the documentation.

Issues Resolved

Closes #8499

Checklist

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

Copy link

github-actions bot commented Dec 4, 2024

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@Naarcha-AWS Naarcha-AWS added the backport 2.18 PR: Backport label for 2.18 label Dec 4, 2024
@Naarcha-AWS Naarcha-AWS added the 4 - Doc review PR: Doc review in progress label Dec 4, 2024
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Some formatting callouts. Also, please add copy buttons to all code blocks.

_migration-assistant/index.md Show resolved Hide resolved
@@ -2,18 +2,20 @@
layout: default
title: Getting started with data migration
nav_order: 10
Copy link
Collaborator

Choose a reason for hiding this comment

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

The children of this page are not displaying because the parent does not have has_children: true specified.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There aren't any child pages for this section.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There were child pages for "Deploying Migration Assistant" that was not displaying, however. I fixed that in my latest commit.

Copy link
Collaborator

Choose a reason for hiding this comment

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

You're right - it was for the "Deploying Migration Assistant" topic, but they are still not displaying.

@@ -2,18 +2,20 @@
layout: default
title: Getting started with data migration
nav_order: 10
redirect_from:
- /upgrade-to/upgrade-to/
- /upgrade-to/snapshot-migrate/
---
Copy link
Collaborator

Choose a reason for hiding this comment

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

Right now, steps have a mix of verbs in imperative and gerund forms. All steps should have verbs in imperative form.

Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO, steps should be in the imperative form, so "Configure and deploy" rather than "Configuring and deploying". cc: @natebower

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Switched steps to imperative form.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Please add copy buttons to the command reference page.

@Naarcha-AWS Naarcha-AWS merged commit 8664051 into main Dec 4, 2024
6 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.18 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.18 2.18
# Navigate to the new working tree
pushd ../.worktrees/backport-2.18
# Create a new branch
git switch --create backport/backport-8873-to-2.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 866405197e8f656ec82115c5f2e6569c77d16a07
# Push it to GitHub
git push --set-upstream origin backport/backport-8873-to-2.18
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.18

Then, create a pull request where the base branch is 2.18 and the compare/head branch is backport/backport-8873-to-2.18.

Naarcha-AWS added a commit that referenced this pull request Dec 5, 2024
* Add migrations section.

Signed-off-by: Archer <[email protected]>

* Add back upgrade pages. Make them less migration focused.

Signed-off-by: Archer <[email protected]>

* Add back in upgrade pages.

Signed-off-by: Archer <[email protected]>

* Remove upgrade section. Add redirects.

Signed-off-by: Archer <[email protected]>

* Update migration-console-commands-references.md

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

* Implement doc review.

Signed-off-by: Archer <[email protected]>

* Fix getting started headers.

Signed-off-by: Archer <[email protected]>

* Fix parent child relationship for Deploying migration assistant

Signed-off-by: Archer <[email protected]>

* Update _migration-assistant/migration-phases/assessing-your-cluster-for-migration.md

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

* Additional feedback

Signed-off-by: Archer <[email protected]>

* Add permalink for migration console

Signed-off-by: Archer <[email protected]>

* Add redirects for index pages.

Signed-off-by: Archer <[email protected]>

* Final edits.

Signed-off-by: Archer <[email protected]>

* Fix headings.

Signed-off-by: Archer <[email protected]>

* Add copy buttons.

Signed-off-by: Archer <[email protected]>

* Last copy button.

Signed-off-by: Archer <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 8664051)
Naarcha-AWS added a commit that referenced this pull request Dec 5, 2024
* Add migrations section (#8873)

* Add migrations section.

Signed-off-by: Archer <[email protected]>

* Add back upgrade pages. Make them less migration focused.

Signed-off-by: Archer <[email protected]>

* Add back in upgrade pages.

Signed-off-by: Archer <[email protected]>

* Remove upgrade section. Add redirects.

Signed-off-by: Archer <[email protected]>

* Update migration-console-commands-references.md

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

* Implement doc review.

Signed-off-by: Archer <[email protected]>

* Fix getting started headers.

Signed-off-by: Archer <[email protected]>

* Fix parent child relationship for Deploying migration assistant

Signed-off-by: Archer <[email protected]>

* Update _migration-assistant/migration-phases/assessing-your-cluster-for-migration.md

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

* Additional feedback

Signed-off-by: Archer <[email protected]>

* Add permalink for migration console

Signed-off-by: Archer <[email protected]>

* Add redirects for index pages.

Signed-off-by: Archer <[email protected]>

* Final edits.

Signed-off-by: Archer <[email protected]>

* Fix headings.

Signed-off-by: Archer <[email protected]>

* Add copy buttons.

Signed-off-by: Archer <[email protected]>

* Last copy button.

Signed-off-by: Archer <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 8664051)

* Fix merge conflicts

Signed-off-by: Archer <[email protected]>

* Delete _migrations directory

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

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS deleted the publish-migrations-section branch December 19, 2024 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.18 PR: Backport label for 2.18
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Migration assistant documentation
2 participants