OpenDevicePartnership / OpenDevicePartnership/OpenDevicePartnership.github.io

Dynamic Repository Diagrams

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

Nadie ha tomado este issue todavía.

Lenguaje dominante
Rust
Estrellas
1
Forks
10
Merge medio
5 d 22 h
PR fusionados (30 d)
1

Descripción

The Projects landing page has 3 main links for P (Patina), EC, and ES (EC Services) which bring up a page with What, Why, Who, and a repository diagram.

This task covers improvements for those diagrams:

  1. Create an engine that auto-generates the diagram each time the user opens the page instead of relying on a user updated jpg. Maybe pull topics from each repo for determining how to use the URLs?
  2. Add text to the auto-generated diagram to explain what it is and how to read it. The text needs to be geared to a new engineer browsing the web site.
  3. Create an action in this repo that creates a bug if any repository is found that does not provide the necessary hooks for the diagram engine.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Línea de trabajo

Inspecciona la página de destino Projects y sus enlaces para Patina, EC y EC Services; después, rastrea cómo se proporcionan actualmente los diagramas del repositorio. Define el motor de diagramas, el texto explicativo orientado a quienes se incorporan al proyecto y la validación necesaria del repositorio; se considera terminado cuando los diagramas se generan al acceder a la página y una acción automatizada informa de los repositorios a los que les faltan los hooks requeridos.

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

Evaluación

Stack tecnológico
github-actions, rust
Área
documentation, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.