Refactor Migrations and Upgrades Documentation#10169
Merged
Conversation
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
…cluded in a seperate migration patterns page. Updated checklist. Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Archer <naarcha@amazon.com>
|
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. |
Signed-off-by: Archer <naarcha@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Archer <naarcha@amazon.com>
1 task
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Archer <naarcha@amazon.com>
Signed-off-by: Archer <naarcha@amazon.com>
Signed-off-by: Archer <naarcha@amazon.com>
lucy66hw
pushed a commit
to lucy66hw/documentation-website
that referenced
this pull request
Aug 14, 2025
…increase jekyll build time (opensearch-project#10591) Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR represents a comprehensive restructuring of OpenSearch's migration and upgrade documentation, transforming scattered content into a cohesive, user-centric resource. This refactoring transforms upgrade and migration documentation into a cohesive, user-centered resource that guides users through the complete migration journey from initial assessment to successful completion for Migration Assistant, and identifies other available options.
Key Changes Made
1. Major Directory Restructuring
_migrate-or-upgrade/and various upgrade and migration options discoverable from this location.2. Content Architecture Improvements
3. Navigation and User Experience Enhancements
4. Configuration and Infrastructure Updates
_config.ymlStrategy Behind This PR
1. Information Architecture Optimization
Problem: Migration information was fragmented across multiple sections, making it difficult for users to find comprehensive guidance.
Solution: Consolidated all migration-related content under a logical hierarchy that follows the user journey from assessment to completion.
Impact: Users can now find all migration information in one place with clear progression paths.
2. User Journey Enhancement
Problem: Users struggled to understand the complete migration process and often got lost in scattered documentation.
Solution: Created structured migration phases with clear step-by-step guidance and logical progression.
Impact: Reduced user confusion and improved migration success rates through better guidance.
3. Maintenance and Scalability
Problem: Scattered content was difficult to maintain, update, and keep consistent.
Solution: Centralized structure with consistent naming conventions and organization patterns.
Impact: Easier maintenance, updates, and future expansion of migration documentation.
4. Backward Compatibility
Problem: Major restructuring could break existing links and user bookmarks.
Solution: Comprehensive redirect strategy to maintain link integrity across the transition.
Impact: Seamless experience for existing users and preserved external references.
Version
all
Frontend features
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.