Expose short descriptions for CSS properties in mdn/data

Abierto
#262 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
data, tooling

Línea de trabajo

Comienza con el documento wiki de descripciones breves de propiedades CSS, issue 261 y el archivo properties.json descrito en este issue. Revisa cómo se recuperan las páginas de MDN mediante el parámetro $json y cómo deben sanitizarse y comprobarse la longitud de los resúmenes. La tarea está terminada cuando se comprueban las descripciones de las propiedades CSS y un script produce una PR de cambios para las diferencias en shortDescription.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Epic idle

This is to address https://github.com/mdn/data/issues/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 https://github.com/mdn/data/issues/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.

Lenguaje dominante
JavaScript
Estrellas
786
Forks
216
Merge medio
22 h 24 min
PR fusionados (30 d)
4

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de mdn/data

Todos los issues de mdn/data

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.