Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Marketplace Migration - Sellers #6743

Merged
merged 74 commits into from
Mar 2, 2020
Merged

Conversation

ccondra
Copy link
Contributor

@ccondra ccondra commented Feb 27, 2020

Purpose of this pull request

The purpose of this PR is to migrate all Marketplace Seller content from the Marketplace user guide to devdocs. "Extensions Marketplace" was added to the Functional Areas navigation, with a Marketplace Sellers TOC in the left nav. Many of the Marketplace files were renamed for consistency and brevity. Also incorporated the FAQ content from DOC-84.

Affected DevDocs pages

TOC UPDATES
main-nav.yml (added Extensions Marketplace)
marketplace-sellers.yml (left nav for Marketplace topics)

NEW TOPICS

  1. Getting Started
  2. Before You Begin
  3. Extension Quality Program
  4. Seller Overview
  5. Your Seller Account
  6. Account Setup Process
  7. Register as a Developer
  8. Marketplace Developer Portal
  9. Profile Information
  10. Company Profile
  11. Personal Profile
  12. Extensions
  13. Create an Extension
  14. Specify the Version
  15. Complete the Extension Information
  16. Add Extension Content
  17. Establish Your Brand
  18. Define the Business Value
  19. Update Extension Information
  20. Themes
  21. Shared Packages
  22. Review Process
  23. Submit for Technical Review
  24. Technical Review Guidelines
  25. Code Validation
  26. Submit for Marketing Review
  27. Marketing Review Guidelines
  28. Product Descriptions
  29. Video Tips
  30. Image Tips
  31. Preview Your Submission
  32. View the Results
  33. Resubmit an Extension
  34. Manage Sales
  35. Revenue Share
  36. Analytics
  37. Technical Reference
  38. Packaging v1.x Extensions

RENAMED/REDIRECTED TOPICS

  1. Seller Overview
    from: /marketplace/user_guide/sellers/overview.html
    to: /marketplace/sellers/seller-overview.html

  2. Account Setup Process
    from: /marketplace/user_guide/sellers/set-up-your-account.html
    to: /marketplace/sellers/account-setup-process

  3. Account Setup
    form: /marketplace/user_guide/sellers/account-setup-overview.html
    to: /marketplace/sellers/account-setup.html

  4. Register as a Developer
    from: /marketplace/user_guide/sellers/register-as-a-developer.html
    to: /marketplace/sellers/developer-register.html

  5. Developer Portal
    from: /marketplace/user_guide/sellers/marketplace-developer-dashboard.html
    to: /marketplace/sellers/developer-portal.htm

  6. Company Profile
    from: /marketplace/user_guide/sellers/company-profile.html
    to: /marketplace/sellers/profile-company.html

  7. Personal Profile
    from: /marketplace/user_guide/sellers/personal-profile.html
    to: /marketplace/sellers/profile-personal.html

  8. Create an Extension
    from: /marketplace/user_guide/sellers/completing-your-extension.html
    to: /marketplace/sellers/extension-create.html

  9. Specify the Version
    from: /marketplace/user_guide/sellers/creating-a-new-version.html
    to: /marketplace/sellers/extension-version.html

  10. Complete the Extension Information
    from: /marketplace/user_guide/sellers/creating-a-new-extension.html
    to: /marketplace/sellers/extension-information.html

  11. View the Results
    from: /marketplace/user_guide/sellers/test-reports.html
    to: /marketplace/sellers/review-report.html

  12. Resubmit an Extension
    from: /marketplace/user_guide/sellers/resubmitting-an-extension.html
    to: /marketplace/sellers/extension-resubmit.html

  13. Update Extension Information
    from: /marketplace/user_guide/sellers/updating-extension-information.html
    to: /marketplace/sellers/extension-update-information.html

TOPICS NOT MIGRATED

  1. Build Your Extension (Only had 1 sentence)
  2. Resources (landing page not needed)
  3. Frequently Asked Questions for Developers
  4. Frequently Asked Questions for Buyers
  5. Marketplace Tools (No longer available)

Additional Info

Staging: # 1523

whatsnew
Migrated Sellers content from the Marketplace User Guide to Functional Areas > Extensions Marketplace.
Extensions Marketplace

Added Extension Marketplace to Functional Areas
Created the TOC for Marketplace Seller Guide
Uploaded to extensions/marketplace/images folder.
Uploaded all content files for the sellers' guide.
Updated listings and added Packaging v1 extensions and Reference,
Updated meta data with group and to remove old redirects; updated links and misc edits.
Uloaded icons to images/assets folder.
Fixed typo in link.
Fixed filenames in links.
Removed target=blank; fixed paths
This topic is not needed.
Fixed typo in filename.
Fixed filename in link.
Updated links for renamed files.
Added versionless
Renamed Getting Started to index.html
fixed typo in meta data
getting-started.html is now index.html; added Seller Overview; added Marketplace Tools
Changed to match topic titles.
Removed blank line between bullet items; fixed capitalization of headers
Changed link format, fixed header capitalization
Mostly space after bullets.
Removed indentation from bullets in an ordered list,
Trailing spaces; list indents
space after bullet
Removed target.
Updated a few titles and filename changes, and moved the Packaging v1.s Extensions  to the Technical Reference at the end. Also created a separate section for Complete the Extension Information,.
Changed the meta redirect to a single line.
Changed title to Review Process
Renamed account-overview.md to account-setup-process.md
Changed "Build Your Extension" to "Create an Extension"; Changed "Resources" to "Technical Reference".
Fixed redirect format to one line.
@ccondra
Copy link
Contributor Author

ccondra commented Feb 28, 2020

I added a list of renamed/redirected topics and also those that were not migrated to the PR description,

Moved Update Extension Information to new Extension Informaiton section in TOC.
@jeff-matthews
Copy link
Contributor

Everything looks good on staging. I'd like to test the redirects before approving and merging though. Doing that now.

Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

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

In the file-based redirects, you're using the relative path to the old file on the docs.magento.com subdomain, which is incorrect. Redirects are not working as expected as a result.

You must use the relative path to the file in the devdocs project before you changed the file name. For example:

redirect_from: /marketplace/sellers/overview.html

You'll need to update all file-based redirects accordingly.

As a reminder, we have to implement a 2-step redirect solution.

  • "Server-side" (not really true server, but AWS S3)
  • File-based metadata

The server-side redirect will redirect as follows:

https://docs.magento.com/marketplace/user_guide/sellers/overview.html --> https://devdocs.magento.com/marketplace/sellers/overview.html

The file-based redirects will do the next redirect:

https://devdocs.magento.com/marketplace/sellers/overview.html --> https://devdocs.magento.com/marketplace/sellers/seller-overview.html

ccondra added 3 commits March 2, 2020 07:33
Removed user_guide from redirect path.
Incorporated content from the Frequently Asked Questions into related topics.
@ccondra
Copy link
Contributor Author

ccondra commented Mar 2, 2020

All the redirects check out, so this is good to go.

@ccondra
Copy link
Contributor Author

ccondra commented Mar 2, 2020

running tests

@jeff-matthews
Copy link
Contributor

Thanks @ccondra, please run tests and then do a Squash and merge.

@magento magento deleted a comment from ccondra Mar 2, 2020
@jeff-matthews jeff-matthews merged commit 32b5779 into master Mar 2, 2020
@ghost
Copy link

ghost commented Mar 2, 2020

Hi @ccondra, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@jeff-matthews jeff-matthews deleted the DOC-82-marketplace-sellers branch March 2, 2020 19:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Internal Dev Differentiates work between community and Magento staff Maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants