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.

Sign up for GitHub

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

Jump to bottom

Update documentation for Getting Started with data migration #9030

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update documentation for Getting Started with data migration #9030

wants to merge 6 commits into from

Conversation

jugal-chauhan
Copy link

@jugal-chauhan jugal-chauhan commented Jan 7, 2025 •
edited
Loading

Description

This change updates the "Getting started with data migration" documentation to improve clarity and accuracy. Specifically, it:

  • Adds a new prerequisite about verifying the CDKToolkit Stack status.
  • Updates the instructions for managing cluster passwords in AWS Secrets Manager.
  • Clarifies the steps for setting up Bootstrap instance access.

Issues Resolved

Adds more clarification

Version

All

Frontend features

N/A

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.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 7, 2025

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 3 - Tech review PR: Tech review in progress backport 2.18 PR: Backport label for 2.18 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress labels Jan 8, 2025
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 5 - Editorial review PR: Editorial review in progress labels Jan 8, 2025
@jugal-chauhan jugal-chauhan force-pushed the update-getting-started-page branch from 486cfe8 to ef2018f Compare January 9, 2025 23:18
@jugal-chauhan
Copy link
Author

Hello Team, I initially forgot to add my signoff on my first commit. I noticed another commit made by @Naarcha-AWS, which still had a spacing issue. I addressed that issue in a 3rd commit with correct signoff. FInally, I have squashed all 3 commits into a single one that contains my signoff. Please do review or get back to me for additional details. Thanks!

@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jan 14, 2025
peternied
peternied reviewed Jan 14, 2025
View reviewed changes
Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

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

Minor comments, thanks for making this update

_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md Outdated
@@ -152,54 +155,52 @@ Use the following steps to configure and deploy RFS:
```
{% include copy.html %}

4. Deploy the stacks:
4. Deploy Migration Assistant and any required stacks when `cdk.context.json` is fully configured:
Copy link
Member

Choose a reason for hiding this comment

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

[Clarity] This phrasing is confusing, if the cdk.context.json needs to be configured, that should be assumed to be part of the previous step. Is there something else we are trying to convey?

_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md Outdated
Comment on lines 166 to 168
* Migration Assistant network stack
* `Reindex-from-snapshot` stack
* Migration console stack
Copy link
Member

Choose a reason for hiding this comment

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

[Writing Style] All the stacks should be either inside tic marks or not.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'll fix this one.

@peternied
Copy link
Member

peternied commented Jan 14, 2025 •
edited
Loading

@jugal-chauhan Could you review the changes since you last published and provide feedback on the unresolved comments / push updates?

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

@Naarcha-AWS Naarcha-AWS Naarcha-AWS left review comments

@peternied peternied peternied approved these changes

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@natebower natebower Awaiting requested review from natebower natebower is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@epugh epugh Awaiting requested review from epugh epugh is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@Naarcha-AWS Naarcha-AWS

Labels
5 - Editorial review PR: Editorial review in progress backport 2.18 PR: Backport label for 2.18
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jugal-chauhan @peternied @Naarcha-AWS @kolchfa-aws