OpenDevicePartnership / OpenDevicePartnership/OpenDevicePartnership.github.io
Dynamic Repository Diagrams
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Rust
- Sterne
- 1
- Forks
- 10
- Ø Merge
- 5 T. 22 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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:
- 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?
- 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.
- 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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Untersuche die Projects-Landingpage und ihre Links für Patina, EC und EC Services und verfolge anschließend, wie die aktuellen Repository-Diagramme bereitgestellt werden. Lege die Diagramm-Engine, erklärenden Text für Neueinsteiger und die erforderliche Repository-Validierung fest; abgeschlossen ist die Arbeit, wenn Diagramme beim Seitenaufruf generiert werden und eine automatisierte Aktion Repositories meldet, denen die erforderlichen Hooks fehlen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github-actions, rust
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100