Skip to content
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

Remove MV2 code from "Create an extension tutorial, part 1" #3277

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

Conversation

bhuvanapriyap
Copy link
Contributor

@bhuvanapriyap bhuvanapriyap commented Sep 24, 2024

This PR is finished & on-hold waiting for Extensions repo Part 1 to be updated from MV2 to MV3, per PR: microsoft/MicrosoftEdge-Extensions#202
manifest.json:
https://github.com/microsoft/MicrosoftEdge-Extensions/blob/main/Extension%20samples/extension-getting-started-part1/part1/manifest.json --
"manifest_version": 2,
When that line becomes "manifest_version": 3,, this PR can be merged.

Rendered articles for review:

  • Tutorial part 1: Display an image in a pop-up (part1-simple-extension.md)
    • https://review.learn.microsoft.com/microsoft-edge/extensions-chromium/getting-started/part1-simple-extension?branch=pr-en-us-3277
    • Before/Live
    • Removed Manifest v2 code.
      • Removed tabset tagging.
      • Removed "The source code has been updated from Manifest V2 to Manifest V3."
    • Changed title from "Create an extension tutorial, part 1", to describe the extension.
    • Clarified intro to describe and show the Part 1 demo's UX.
    • Clearly recommended cloning the MicrosoftEdge-Extensions repo and installing and running the provided, completed demo.
      • Added how to clone the Extensions Samples repo.
      • Clarified how to obtain the image files.
      • Added section saying how to install and run/test the sample, with screenshots.
    • Reformatted plain sentences as numbered steps.
    • In manifest code, differentiated Name and Description of the Part 1 demo vs Part 2 demo.
    • Re-created screenshots and updated them, using a Microsoft-owned site, and added screenshots.
      • Added screenshot of the extension running.
  • Tutorial part 2: Use JavaScript to insert an image in the webpage (part2-content-scripts.md)
    • https://review.learn.microsoft.com/microsoft-edge/extensions-chromium/getting-started/part2-content-scripts?branch=pr-en-us-3277
    • Before/Live
    • Removed note about using MV2 when creating a new extension.
    • Changed title from "Create an extension tutorial, part 2", to describe the extension.
    • Clarified intro to describe and show the Part 2 demo's UX.
    • Clearly recommended cloning the MicrosoftEdge-Extensions repo and installing and running the provided, completed demo.
    • In heading, changed "pop-up.html" (wrong filename) to "the webpage".
    • Added filename above each listing, & whether it's a portion or the complete listing.
    • In some steps, linked to "Sideload an extension to install and test it locally", to update & run the expanded sample.
    • Removed stray "8." step.
    • In manifest code, differentiated Name and Description of the Part 1 demo vs Part 2 demo.
    • Clarified how to install and run/test the sample.
      • Specified to first open a webpage; not an empty tab or utility page.
      • Added an h2 heading to form a Step section: Step 7: Install and test the extension.
      • Re-created screenshots and updated them, using a Microsoft-owned site, and added screenshots.
  • Sideload an extension to install and test it locally (extension-sideloading.md)
    • https://review.learn.microsoft.com/microsoft-edge/extensions-chromium/getting-started/extension-sideloading?branch=pr-en-us-3277
    • Before/Live
    • Integrated with the tutorial articles, for better flow, comprehension, & maintainability.
      • Explicitly specified the "picture of the day" tutorial's extension, as a specific example to follow the steps end-to-end.
    • Changed title from "Sideload an extension", to state the task/ objective.
      • Rewrote intro to clarify the scenario, task, strategy, & objective.
    • Added the main h2 heading "Locally installing and running an extension".
      • Added how to run the installed extension.
      • Added step to open a webpage before running certain types of extensions (eg Part 2 demo).
      • Clarified the other h2 headings to clarify each task.
    • Re-created screenshots and updated them, using a Microsoft-owned site, and added screenshots.
  • Microsoft Edge documentation (hub page for Edge docsets) (~/index.yml)
  • Microsoft Edge Developer documentation (landing page for entire docset) (/developer/index.yml)
  • Microsoft Edge extensions documentation (landing page for Extensions) (/extensions/landing/index.yml)
  • TOC (toc.yml)

AB#54090321

@mikehoffms mikehoffms added the cat: extensions Extensions-related content. label Sep 24, 2024
@mikehoffms mikehoffms changed the base branch from user/bhuvana/removemv2 to main September 24, 2024 18:07
@mikehoffms mikehoffms changed the title Update part1-simple-extension.md Remove MV2 code from "Create an extension tutorial, part 1" Sep 24, 2024
Copy link
Contributor

@mikehoffms mikehoffms left a comment

Choose a reason for hiding this comment

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

LGTM - Writer/Editor

Copy link
Contributor

@captainbrosset captainbrosset left a comment

Choose a reason for hiding this comment

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

Approving the content changes, but we need to update the samples repo to v3 at the same time.

@mikehoffms mikehoffms added the on-hold The changes are currently on-hold and awaiting further evaluation. label Sep 25, 2024
Copy link

Learn Build status updates of commit f63f101:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/developer/index.yml ✅Succeeded View
microsoft-edge/devtools-guide-chromium/sources/index.md ✅Succeeded View
microsoft-edge/extensions-chromium/developer-guide/sidebar.md ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/extension-running.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/extensions-icon.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/extensions-popup-no-extensions.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/extensions-popup.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/load-unpacked-icon.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/part1-developermode-toggle.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/part1-installed-extension.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/extension-sideloading-images/part1-threedots.png ✅Succeeded n/a (file deleted or renamed)
microsoft-edge/extensions-chromium/getting-started/extension-sideloading.md ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/index.md ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/part1-simple-extension-images/extension-running.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/part1-simple-extension.md ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/part2-content-scripts-images/extensions-icon.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/part2-content-scripts-images/open-the-extension.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/part2-content-scripts-images/part2-popupdialog.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/part2-content-scripts-images/part2-showingimage.png ✅Succeeded View
microsoft-edge/extensions-chromium/getting-started/part2-content-scripts.md ✅Succeeded View
microsoft-edge/extensions-chromium/index.md ✅Succeeded View
microsoft-edge/extensions-chromium/landing/index.yml ✅Succeeded View
microsoft-edge/extensions-chromium/publish/contact-extensions-team.md ✅Succeeded View
microsoft-edge/extensions-chromium/publish/reply-user-reviews.md ✅Succeeded View
microsoft-edge/extensions-chromium/whats-new/released-features.md ✅Succeeded View

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat: extensions Extensions-related content. on-hold The changes are currently on-hold and awaiting further evaluation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants