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.

Sign up for GitHub

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

Jump to bottom

Add migration guide for canonical URL replacement #996

Merged
merged 4 commits into from
Jan 10, 2023
Merged

Add migration guide for canonical URL replacement #996

merged 4 commits into from
Jan 10, 2023

Conversation

peterwilsoncc
Copy link
Collaborator

@peterwilsoncc peterwilsoncc commented Jan 9, 2023 •
edited
Loading

Description of the Change

  • Updates the documentation required to prevent the plugin from using the source site's canonical URL.
  • Introduces a migration guide file to the docs
  • Adds call out to the migration guide in the introduction to the docs.

Docs are built from trunk so no changes will be published until version 2.0 is released.

Closes #989
Follow up to #988

How to test the Change

  1. Checkout this branch locally
  2. Run npm i; npm run build:docs
  3. Open the file docs-built/index.html in your browser.

Changelog Entry

Added - Migration guide for version 1 to version 2.

Credits

Props @peterwilsoncc, @faisal-alvi

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@peterwilsoncc peterwilsoncc marked this pull request as ready for review January 9, 2023 01:32
@peterwilsoncc peterwilsoncc requested review from a team and faisal-alvi and removed request for a team January 9, 2023 01:33
faisal-alvi
faisal-alvi reviewed Jan 9, 2023
View reviewed changes
Copy link
Member

@faisal-alvi faisal-alvi left a comment

Choose a reason for hiding this comment

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

@peterwilsoncc Everything looks good except for the link that is not working for me. If that is not expected, can you please check?

.github/hookdoc-tmpl/README.md Show resolved Hide resolved
@peterwilsoncc peterwilsoncc requested review from jeffpaul and a team as code owners January 9, 2023 23:48
@peterwilsoncc peterwilsoncc merged commit 1059ce4 into develop Jan 10, 2023
@peterwilsoncc peterwilsoncc deleted the fix/989-migration-guide branch January 10, 2023 21:24
@jeffpaul jeffpaul added this to the 2.0.0 milestone Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@faisal-alvi faisal-alvi faisal-alvi approved these changes

@jeffpaul jeffpaul Awaiting requested review from jeffpaul jeffpaul is a code owner

Assignees
No one assigned
Labels
None yet
Projects
No open projects
Distributor 2.0.0
Archived in project
Milestone
2.0.0
Development

Successfully merging this pull request may close these issues.

Remove duplication overriding post meta.
3 participants
@peterwilsoncc @faisal-alvi @jeffpaul