Skip to content

Conversation

@AronPerez
Copy link
Contributor

@AronPerez AronPerez commented May 16, 2025

Ticket

DAPS-1359

Description

Put up a rough draft of the planning doc that will help steer the FE refactor effort

How Has This Been Tested?

N/A

Artifacts (if appropriate):

See rich diff of doc

Summary by Sourcery

Documentation:

  • Introduce web/docs/migration_strategy.md with a comprehensive migration plan covering current vs. target architecture, phased rollout, timeline, risk mitigation, testing strategy, and success metrics.

@AronPerez AronPerez self-assigned this May 16, 2025
@AronPerez AronPerez added Component: Web UI Relates to web appp user interface Type: Docs - Code Relates to code documentation labels May 16, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 16, 2025

Reviewer's Guide

Introduces a new draft document outlining a comprehensive migration strategy from jQuery to React+TypeScript, covering architecture, phased rollout, risks, testing, and success metrics.

File-Level Changes

Change Details Files
Added detailed migration strategy draft
  • Created migration_strategy.md with full document skeleton
  • Outlined current and target frontend architectures
  • Defined phased migration approach with four phases
  • Specified timeline, milestones, and component dependencies
  • Added risk assessment, mitigation strategies, testing strategy, and success metrics
web/docs/migration_strategy.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@AronPerez AronPerez linked an issue May 16, 2025 that may be closed by this pull request
@AronPerez AronPerez requested a review from Copilot May 16, 2025 07:30
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a draft documentation outlining the migration strategy for transitioning the DataFed frontend from jQuery to a modern React+TypeScript architecture, aimed at supporting the FE refactor effort.

  • Introduces a comprehensive migration strategy document including sections on current and target architecture, phased migration, risk assessment, and testing strategy.
  • Details milestones and risk mitigation strategies with illustrative tables and bullet lists.


## 4. Phased Migration Approach

### Phase 1: Foundation and Setup (Current Phase)
Copy link

Copilot AI May 16, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider adding a brief summary or bullet list at the start of each major section (e.g. each Phase or Milestone) to enhance readability and provide quick context for reviewers.

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you give a full example of this


### Identified Risks

| Risk | Impact | Probability | Mitigation Strategy |
Copy link

Copilot AI May 16, 2025

Choose a reason for hiding this comment

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

[nitpick] Enhance the formatting of the risk assessment table to improve clarity; consider adjusting spacing or adding markdown nuances to distinctively separate headers and values.

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you give a full example of this

@AronPerez AronPerez force-pushed the chore-DAPS-1359-FE-migration-strategy-doc branch from 3ad5846 to 1357968 Compare May 16, 2025 08:13
@AronPerez AronPerez changed the base branch from devel to feat-TASK-refactor-DataFed-FE May 16, 2025 08:14
@AronPerez
Copy link
Contributor Author

Easier to manage with feat branch

@AronPerez AronPerez force-pushed the chore-DAPS-1359-FE-migration-strategy-doc branch from 1357968 to 28b3e78 Compare May 16, 2025 08:17
@AronPerez AronPerez closed this Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Web UI Relates to web appp user interface Type: Docs - Code Relates to code documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Migration Strategy Document

3 participants