DataFed icon indicating copy to clipboard operation
DataFed copied to clipboard

[DAPS-1359] Add draft for discussion

Open AronPerez opened this issue 8 months ago • 2 comments

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 avatar May 16 '25 07:05 AronPerez

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

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar May 16 '25 07:05 sourcery-ai[bot]

Easier to manage with feat branch

AronPerez avatar May 16 '25 08:05 AronPerez