Automate upstream schema sync with docs
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 52/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Área
- documentation, tooling
Línea de trabajo
Revisa los PRs 178 y 179 completados y, después, inspecciona el esquema upstream actual y la estructura de la documentación. Añade comprobaciones de cobertura que señalen las políticas del esquema sin documentación correspondiente y las políticas documentadas sin entradas en el esquema; el trabajo estará terminado cuando ambas direcciones de discrepancia se notifiquen claramente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Background:
Right now, updates here are still mostly manual, which means docs tend to drift from (Firefox) code. We have the opportunity to sync with upstream definitions, so to make things a little more stable, I'm going to make the following changes:
Tasks:
- https://github.com/mozilla/enterprise-admin-reference/pull/178
- https://github.com/mozilla/enterprise-admin-reference/pull/179
- Add some checks for docs coverage against the schema
Motivation:
-
At minimum, we should flag policies that exist in schema that do not have matching docs pages, and the inverse is also detectable, although rare.
-
Longer term, the schema should drive generated reference elements on docs pages: policy description, defaults, compatibility, examples. The goal would be to have hand-written docs focus on explanation & context, gotchas etc. while the reference details come from upstream.
- Lenguaje dominante
- MDX
- Estrellas
- 12
- Forks
- 17
- Merge medio
- 9 h 19 min
- PR fusionados (30 d)
- 39
Preparar el entorno
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de mozilla/enterprise-admin-reference
-
Remove compat info from proseAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 55/100
mozilla/enterprise-admin-reference#339 ·
Los mantenedores suelen responder en 1 día
-
Missing details about AutoConfigAbiertodocumentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
mozilla/enterprise-admin-reference#292 ·
Los mantenedores suelen responder en 1 día
-
Missing identity / certs guideAbiertodocumentation
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
mozilla/enterprise-admin-reference#291 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
mozilla/enterprise-admin-reference#290 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
mozilla/enterprise-admin-reference#289 ·
Los mantenedores suelen responder en 1 día
Todos los issues de mozilla/enterprise-admin-reference
Issues similares
-
Broken links found in docsAbiertodocs pydanty:is-working
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
pydantic/pydantic-ai#8863 ·
Los mantenedores suelen responder en 1 día
-
documentation from-review-extraction github-actions priority: low severity:nit
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
LearningCircuit/local-deep-research#6946 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
esphome/device-builder#2856 ·
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 78/100
mantinedev/mantine#9223 ·
Los mantenedores suelen responder en 6 días