docs: [FC-86] Restructure Modify Items section with Add/Replace examples

[peterkulko]

Note

Related PR

• feat: [FC-86] Updated Header links frontend-app-catalog#24

Description

This PR includes updated slots examples for adding Marketing links for Header component.

Useful information

• Slack conversation
• [DEPR]: Deprecation of Legacy Home, Course Catalog, and Course About Pages in Favor of MFE Implementations openedx-platform#36785

Initial setup

1. Complete all necessary steps from the Initial setup section for Catalog MFE: feat: [FC-86] Updated Header links frontend-app-catalog#24
2. Clone and mount this repository.

How Has This Been Tested?

1. Add env.config.js and example adding Marketing links via plugin slots in Catalog MFE.
2. Check adding links in the Catalog MFE header.

Merge Checklist

• If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Sandbox, if applicable.
• Is there adequate test coverage for your changes?

Post-merge Checklist

• Deploy the changes to prod after verifying on stage or ask @openedx/edx-infinity to do it.
• 🎉 🙌 Celebrate! Thanks for your contribution.

[openedx-webhooks]

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.01%. Comparing base (dbec796) to head (5d4a890).
⚠️ Report is 7 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #598   +/-   ##
=======================================
  Coverage   73.01%   73.01%           
=======================================
  Files          55       55           
  Lines         504      504           
  Branches      100      100           
=======================================
  Hits          368      368           
  Misses        133      133           
  Partials        3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[ihor-romaniuk]

[question] Should we accept false or null types here?

[peterkulko]

Removed at 80acabe

[brian-smith-tcril]

Overall this looks good!

I have a couple thoughts here:

• I don't think using the term "Marketing Links" makes sense, there's nothing about this use case that requires the links be "marketing"
• This is very similar to the "Modify Items" example (the difference being the existing "Modify Items" examples replace all menu items, where as these examples add items)

I think what would be great here would be to make this a sub-heading of "Modify Items."

So we can take the existing

### Modify Items
[current example]

and change it to be

### Modify Items
#### Replace All Items
[current example]
#### Add Items
[example from this PR]

[peterkulko]

@brian-smith-tcril thanks! I changed the examples of adding plugin slots and the title of this PR: 5d4a890

[brian-smith-tcril]

LGTM!