Skip to content

Revise copy for settings page description of Paired URL Structures #6229

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

Merged
merged 4 commits into from
May 17, 2021

Conversation

jwold
Copy link
Collaborator

@jwold jwold commented May 13, 2021

Summary

In #6227 we updated the copy to explain how the paired URL function works. This has been approved, with one small typo to update the wording of is is.

In addition I reviewed the text and have a few wording suggestions.

Before:

When using Transitional or Reader template modes, your site is is in a “Paired AMP” configuration where your canonical URLs are non-AMP and then you have separate AMP versions of your pages with AMP-specific URLs. The structure of the paired AMP URL is not important, whether using a query parameter or path suffix. The use of a query parameter is the most compatible across various sites and it has the benefit of not resulting in a 404 if the AMP plugin is deactivated, so that is why it is the default. Please note that changing the paired URL structure can cause AMP pages to disappear from search results until your site has been re-indexed. So if the current structure of your paired AMP URLs works for you, there is no need to change. If you're migrating from another AMP plugin that used a different paired URL structure than the default, then you may want to change this setting. Learn more.

After:

When using Transitional or Reader template modes, your site is in a “Paired AMP” configuration. Canonical URLs are non-AMP and separate AMP versions of your pages have AMP-specific URLs.
The structure of a paired AMP URL is not important, whether using a query parameter or path suffix. The use of a query parameter is the most compatible across various sites and doesn't result in a 404 if the AMP plugin is deactivated. Note: Changing the paired URL structure can cause AMP pages to disappear from search results until your site is re-indexed.
If you're migrating from another AMP plugin with a different paired URL structure, then you may want to change this setting. Otherwise we recommend leaving it as is. Learn more

--

Here's a screenshot of the diff: https://d.pr/i/KLOuEo

Before After
before image

Checklist

  • My code is tested and passes existing tests.
  • My code follows the Engineering Guidelines (updates are often made to the guidelines, check it out periodically).

@github-actions
Copy link
Contributor

github-actions bot commented May 13, 2021

Plugin builds for 3f67835 are ready 🛎️!

@westonruter westonruter force-pushed the add/paired-url-structure-docs-copy branch 2 times, most recently from 90d18a7 to da825e6 Compare May 13, 2021 23:06
@westonruter westonruter added this to the v2.1.2 milestone May 13, 2021
@westonruter westonruter requested a review from amedina May 13, 2021 23:07
@westonruter westonruter force-pushed the add/paired-url-structure-docs-copy branch from da825e6 to bcd5a69 Compare May 13, 2021 23:10
Copy link
Member

@amedina amedina left a comment

Choose a reason for hiding this comment

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

LGTM.

@westonruter westonruter enabled auto-merge May 17, 2021 18:03
@westonruter westonruter merged commit 67f2cf8 into develop May 17, 2021
@westonruter westonruter deleted the add/paired-url-structure-docs-copy branch May 17, 2021 18:09
@pierlon pierlon self-assigned this May 18, 2021
@pierlon
Copy link
Contributor

pierlon commented May 18, 2021

QA Passed

Revision can be seen on page:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants