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

Expose short descriptions for CSS properties in mdn/data #262

Open
wbamberg opened this issue Aug 16, 2018 · 0 comments
Open

Expose short descriptions for CSS properties in mdn/data #262

wbamberg opened this issue Aug 16, 2018 · 0 comments
Labels
Epic idle Issues and pull requests with no activity for three months.

Comments

@wbamberg
Copy link
Contributor

wbamberg commented Aug 16, 2018

This is to address #199 for CSS properties.

The overall proposal for how we are going to do this is captured in the CSS property short descriptions Wiki document.

Broadly there are two aspects to the work: (1) fixing up the content and then (2) getting it into mdn/data:

Check/fix the content

Create and test sample short descriptions

(Issue #261)

Write short descriptions for a small number (10) of CSS properties, and test how they would work in the different contexts they might appear in (an MDN page, an editor popup, a devtools widget).

On the basis of these samples:

  1. draft some guidelines about how the short descriptions should be written
  2. refine the estimates of how long it will take to update all of them.

Update short descriptions for all CSS properties

Go through all the CSS property pages, checking that the summary is what we want: meaning, it's explicitly marked using "seoSummary", and contains the right content.

Write a script to expose short descriptions in mdn/data

Write a script that works something like this:

  • For each entry in the properties.json file in mdn/data:

    a) Get the corresponding MDN page as a JSON object using the $json parameter (e.g. https://developer.mozilla.org/en-US/docs/Web/CSS/margin$json)

    b) From this object, get the summary property, sanitize it to ensure it only contains the allowed elements and check that it's the correct length.

    c) If the result is different from the current value of shortDescription in properties.json, then add it to a changelist.

  • Open a PR against mdn/data containing the changelist.

@wbamberg wbamberg added the Epic label Aug 16, 2018
@github-actions github-actions bot added the idle Issues and pull requests with no activity for three months. label Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic idle Issues and pull requests with no activity for three months.
Projects
None yet
Development

No branches or pull requests

1 participant