Dynamic Repository Diagrams

Aperta
#60 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
github-actions, rust

Direzione di ricerca

Esamina la landing page Projects e i relativi link per Patina, EC ed EC Services, quindi traccia come vengono forniti gli attuali diagrammi dei repository. Definisci il motore per i diagrammi, il testo esplicativo rivolto ai nuovi arrivati e la validazione necessaria dei repository; il lavoro è completato quando i diagrammi vengono generati all’accesso alla pagina e un’azione automatizzata segnala i repository privi degli hook richiesti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
Rust
Stelle
1
Fork
10
Merge medio
5g 22h
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenDevicePartnership/OpenDevicePartnership.github.io

Tutte le issue di OpenDevicePartnership/OpenDevicePartnership.github.io

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.