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

Integrate documentation links to Validation Error details #1401

Closed
3 tasks
postphotos opened this issue Sep 5, 2018 · 4 comments
Closed
3 tasks

Integrate documentation links to Validation Error details #1401

postphotos opened this issue Sep 5, 2018 · 4 comments
Labels
Blocked Documentation Documentation related tasks Groomed P1 Medium priority WS:Core Work stream for Plugin core

Comments

@postphotos
Copy link
Contributor

postphotos commented Sep 5, 2018

As a developer debugging a surfaced AMP error caught by the plugin, I should the ability to understand what clearly caused this and should have links to relevant documentation (to the new product site, to ampproject.org or ampbyexample.com).

Based on the listing in #1360, to appear on the screen in #1364. Shown in mockup here. Intended to link the product site to the plugin wherever relevant.

  • AC1: Create a way to link the error taxonomy to a given specific URL per error, to be managed by the plugin in a way that can be updated on a per-release basis.
  • AC2: Decide which errors from Generate an error taxonomy for AMP error types #1360 already have content for in-depth reading. Similarly, if an error doesn't have a given URL, link them to a fallback URL that explains more about the AMP project and WordPress (perhaps ton the product site.)
  • AC3: As AC1 and AC2 are met, prepare the documentation links for v1.0.
@postphotos
Copy link
Contributor Author

The initial user story has been updated here.

@kienstra kienstra added this to the v1.1 milestone Dec 4, 2018
@westonruter westonruter removed this from the v1.1 milestone Mar 6, 2019
@amedina amedina added Documentation Documentation related tasks and removed Compatibility Tool labels Apr 1, 2020
@westonruter
Copy link
Member

westonruter commented Apr 12, 2020

Depends on #3817 as we need each tag spec to have a discrete spec name. We will be able to automatically link off to the documentation on amp.dev once the validator spec has been fleshed out with spec_url fields for each tag spec.

@amedina amedina changed the title Integrate documentation links to "isolated error" screen Integrate documentation links to Validation Error details May 14, 2020
@westonruter
Copy link
Member

This really depends on ampproject/amphtml#26033

Each tag spec in AMP should have a URL associated with it. This will help both the AMP validator and the AMP plugin.

@amedina amedina added the P1 Medium priority label May 14, 2020
@kmyram kmyram added the WS:Core Work stream for Plugin core label Aug 5, 2020
@kmyram kmyram added the Groomed label Dec 8, 2020
@westonruter
Copy link
Member

Depends on #3817 as we need each tag spec to have a discrete spec name. We will be able to automatically link off to the documentation on amp.dev once the validator spec has been fleshed out with spec_url fields for each tag spec.

Closing that in favor of #4566.

@westonruter westonruter closed this as not planned Won't fix, can't repro, duplicate, stale Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Blocked Documentation Documentation related tasks Groomed P1 Medium priority WS:Core Work stream for Plugin core
Projects
Archived in project
Development

No branches or pull requests

5 participants