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

[Markdown] [Web/API] Remove summary and seoSummary classes #8110

Closed
wbamberg opened this issue Aug 19, 2021 · 5 comments
Closed

[Markdown] [Web/API] Remove summary and seoSummary classes #8110

wbamberg opened this issue Aug 19, 2021 · 5 comments
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.

Comments

@wbamberg
Copy link
Collaborator

Part of #7898.

See also #3923 for some background here.

There are three cases:

  1. seoSummary or summary are used to mark up the first non-macro paragraph. In these cases the classes are effectively a no-op and can be removed without anything changing. We can also automate these cases.

  2. seoSummary or summary are used to truncate the first non-macro paragraph (usually taking the first sentence). In these cases it's probably worth checking that the whole first paragraph is reasonable to use as the summary, or whether we should split it. We don't have very precise guidelines for how long this should be though, and given that seoSummary and summary are usually omitted, I think it's OK to be pretty forgiving here.

  3. seoSummary or summary are used to mark up a completely different part of the doc. In this case we should make sure that the first paragraph provides an appropriate summary. https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet is a good example of a page that uses these classes intentionally, to provide an indirect opening paragraph with a direct summary. We'll need to stop doing things like this.

As far as I can tell the breakdown for Web/API is:

4072 pages - no summary or seoSummary
1423 pages - summary or seoSummary matches the first paragraph (case 1)
345 pages - summary or seoSummary truncates the first paragraph (case 2)
86 pages - summary or seoSummary selects a different text (case 3)

@wbamberg wbamberg added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Aug 19, 2021
@teoli2003
Copy link
Contributor

Case 1 should be easy to script (a bit tedious to review)

@wbamberg
Copy link
Collaborator Author

Yes, we should automate these. Do you think it's OK to have it in 1 PR?

@teoli2003
Copy link
Contributor

teoli2003 commented Aug 19, 2021

Yes, we should automate these. Do you think it's OK to have it in 1 PR?

It is much easier to review by batches of 400. That's what I have done for the spec macros. So they can land quickly, and do not rot.

(I review by opening all the pages and checking if all is ok, then a quick scroll of the code)

@wbamberg
Copy link
Collaborator Author

I think this is now done!

@wbamberg
Copy link
Collaborator Author

...and thanks Jean-Yves for all the reviews!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.
Projects
None yet
Development

No branches or pull requests

2 participants