Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

U - Fix CSS linter errors: data.examples/missing-example-h3 #3434

Closed
1 task
wbamberg opened this issue Jun 27, 2020 · 6 comments
Closed
1 task

U - Fix CSS linter errors: data.examples/missing-example-h3 #3434

wbamberg opened this issue Jun 27, 2020 · 6 comments
Assignees
Labels
Content:CSS This is related to CSS content User Story Incremental value deliverable witin a Sprint / Iteration cycle and meeting part of an Epic's AC

Comments

@wbamberg
Copy link

wbamberg commented Jun 27, 2020

The linter's spec for data.examples expects that each example under the H2 "Examples" section lives under its own H3 heading.

The linter raises "data.examples/missing-example-h3" if a page doesn't appear to meet this expectation.

Currently we have 87 "data.examples/missing-example-h3" errors. They are listed in the spreadsheet, in the "data.examples/missing-example-h3" tab.

Usually, these are where there is only one example, and it has been placed directly under the "Examples" H2. So to fix it we need to:

  • come up with a useful descriptive name for the example
  • make that the H3
  • move any subheadings to the next level down (preferably following the convention in E - Fix CSS linter errors #3139 (comment)).
  • if necessary, adjust the argument to the {{EmbedLiveSample}} macro

Acceptance criteria

@Elchi3 Elchi3 added the Content:CSS This is related to CSS content label Jul 2, 2020
@wbamberg wbamberg changed the title U - Fix CSS linter errors: data.examples errors U - Fix CSS linter errors: data.examples/missing-example-h3 Jul 28, 2020
@chinikes chinikes added this to the Mike November (S2 Q3 2020) milestone Jul 29, 2020
@chinikes chinikes added the User Story Incremental value deliverable witin a Sprint / Iteration cycle and meeting part of an Epic's AC label Jul 29, 2020
@rachelandrew
Copy link
Collaborator

There are a few in here that direct people to another page for examples (https://wiki.developer.mozilla.org/en-US/docs/Web/CSS/animation-delay). Not sure what to do with these.

@wbamberg wbamberg removed their assignment Oct 12, 2020
@wbamberg
Copy link
Author

Not sure if my opinion is relevant, but since I filed this: IMO, reference pages shouldn't send people off somewhere else for examples.

If I'm looking at the reference page for an item I want to see directly relevant examples right there, not have to visit another (more generic) page to hunt them down. In the case of animation-delay, the linked page https://wiki.developer.mozilla.org/en-US/docs/CSS/CSS_animations doesn't actually include any examples of animation-delay, so it would be doubly frustrating.

(This points to another problem with this practice, which is that https://wiki.developer.mozilla.org/en-US/docs/CSS/CSS_animations doesn't know that other pages are relying on it to include particular examples, so it's easy for an author to remove them and inadvertently break the linking page.)

@rachelandrew
Copy link
Collaborator

@wbamberg I agree. I'll see if there are obvious ones to copy over, if not I'll raise issues to add examples to missing example pages.

@rachelandrew rachelandrew self-assigned this Oct 15, 2020
@rachelandrew
Copy link
Collaborator

I have fixed all of these other than a couple of drafts, and a 404 which I've marked in the spreadsheet.

I've made quite a few examples along the way for pages which referred to other pages for examples.

@rachelandrew
Copy link
Collaborator

@chrisdavidmills there doesn't seem to be any in review status but you can take a look at this.

@chrisdavidmills
Copy link
Contributor

This looks great; thanks @rachelandrew !

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:CSS This is related to CSS content User Story Incremental value deliverable witin a Sprint / Iteration cycle and meeting part of an Epic's AC
Projects
None yet
Development

No branches or pull requests

5 participants