[OSDEV-1904] Update the instructions link on the List upload page.

[Innavin369]

OSDEV-1904 - The step-by step instructions link on the List upload page has been updated to /resources/preparing-data.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[barecheck]

React App | Jest test suite - Code coverage report

Total: 33.18%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[barecheck]

Dedupe Hub App | Unittest test suite - Code coverage report

Total: 56.14%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[barecheck]

Countries App | Unittest test suite - Code coverage report

Total: 100%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[barecheck]

Contricleaner App | Unittest test suite - Code coverage report

Total: 98.91%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the documentation and React code to reflect a new URL for preparing data. A release note entry is added in the documentation, while the React component’s hyperlink is modified to use the updated URL. In addition, a new key is added to the constants file to support the new path. These updates ensure that users are directed to the correct resource for preparing data.

Changes

File(s)	Change Summary
doc/release/RELEASE-NOTES.md	Added a new entry for issue OSDEV-1904, updating the "step-by-step" instructions link to /resources/preparing-data.
src/react/.../Contribute.jsx, src/react/.../constants.jsx	Updated the ContributeList component’s hyperlink from ${InfoLink}/${InfoPaths.contribute} to ${InfoLink}/${InfoPaths.preparingData}; added a new preparingData: 'resources/preparing-data' entry in InfoPaths.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant C as ContributeList Component
    participant B as Browser

    U->>C: Click "step-by-step instructions" link
    C->>B: Redirect to `/resources/preparing-data`
    B->>U: Render "Preparing Data" page

Loading

Possibly related PRs

• [OSDEV-1867] SLC. Update Messy Data link to data cleaning service splash page #561: Updates release notes for a data cleaning link, indicating similar documentation modifications.
• [OSDEV-1777] Make the URL style consistent for all routes of the SLC workflow. #533: Standardizes URL structure across the workflow, relating to the updated URL path changes.

Suggested reviewers

• roman-stolar
• VadimKovalenkoSNF
• vladsha-dev
• mazursasha1990

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

doc/release/RELEASE-NOTES.md (1)

32-32: Minor typo in the release note entry

There's a small typo in the release note - "step-by step" is missing a hyphen between "by" and "step". It should be "step-by-step" to match the wording used in the actual component.

-* [OSDEV-1904](https://opensupplyhub.atlassian.net/browse/OSDEV-1904) - The `step-by step` instructions link on the List upload page has been updated to `/resources/preparing-data`.
+* [OSDEV-1904](https://opensupplyhub.atlassian.net/browse/OSDEV-1904) - The `step-by-step` instructions link on the List upload page has been updated to `/resources/preparing-data`.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a8f35ce and 2725629.

📒 Files selected for processing (3)

• doc/release/RELEASE-NOTES.md (1 hunks)
• src/react/src/components/Contribute.jsx (1 hunks)
• src/react/src/util/constants.jsx (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

src/react/src/components/Contribute.jsx (1)

src/react/src/util/constants.jsx (4)

• InfoLink (19-19)
• InfoLink (19-19)
• InfoPaths (23-64)
• InfoPaths (23-64)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: run-integration-test-code-quality
• GitHub Check: run-django-code-quality
• GitHub Check: get-base-branch-django-cov

🔇 Additional comments (2)

src/react/src/components/Contribute.jsx (1)

47-47: Link updated to the new resources location

The change correctly updates the URL for the step-by-step instructions, pointing users to the new /resources/preparing-data path rather than the previous data cleaning service path. This aligns with the PR objective to update the instructions link.

src/react/src/util/constants.jsx (1)

27-27: Adding new path constant for preparing data documentation.

This change adds a new key-value pair to the InfoPaths object, which is used throughout the application for consistent URL references. The new path will be used to direct users to the updated resource for preparing data as described in the PR objectives.

[barecheck]

Django App | Unittest test suite - Code coverage report

Total: 80.65%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered