Skip to content

Refactor Migrations and Upgrades Documentation #10169

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

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

Conversation

Naarcha-AWS
Copy link
Contributor

@Naarcha-AWS Naarcha-AWS commented Jul 1, 2025

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

  • __Moved content to _migrate-or-upgrade/ and various upgrade and migration options discoverable from this location.
  • Consolidated migration documentation under a unified structure
  • Updated navigation hierarchy to reflect new organization

2. Content Architecture Improvements

  • Migration Journey Enhancement: Added structured migration phases with clear step-by-step guidance
  • Requirements Clarification: Updated migration and upgrade requirements and technical prerequisites
  • Migration Phases: Added comprehensive migration workflow with distinct phases

3. Navigation and User Experience Enhancements

  • Fixed broken links throughout the documentation
  • Updated breadcrumbs and TOC structure for better navigation
  • Made title casing consistent across all sections
  • Improved cross-references between related topics
  • Added comprehensive redirects to maintain backward compatibility

4. Configuration and Infrastructure Updates

  • Added Migration Assistant section to _config.yml
  • Updated home page cards to properly link to migration content
  • Fixed collection permalinks and navigation structure
  • Updated section names for consistency ("Migration Assistant for OpenSearch")

Strategy 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

  • 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.

sumobrian and others added 4 commits June 29, 2025 12:04
Copy link

github-actions bot commented Jul 1, 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.

Signed-off-by: Archer <[email protected]>
@Naarcha-AWS Naarcha-AWS marked this pull request as ready for review July 1, 2025 13:08
@Naarcha-AWS Naarcha-AWS added migration Tech review PR: Tech review in progress labels Jul 1, 2025
@sumobrian sumobrian self-requested a review as a code owner July 2, 2025 02:27
Signed-off-by: Archer <[email protected]>
@Naarcha-AWS Naarcha-AWS assigned sumobrian and unassigned Naarcha-AWS Jul 10, 2025
@sumobrian sumobrian changed the title Rename Migration Assistant section Refactor Migrations and Upgrades Documentation Jul 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
migration Tech review PR: Tech review in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants