void-linux / void-linux/void-docs

Unify `xbps/repositories/signing.md` with `void-packages/README.md`?

Offen
#642 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
CSS
Sterne
217
Forks
212
Ø Merge
2 T. 21 Std.
Gemergte PRs (30 T.)
1

Beschreibung

https://github.com/void-linux/void-docs/pull/641 made me wonder if it's better to drop the section Signing Repositories and link to the README instead. Alternatively, drop the section in the README and link to the docs. Goal: not having duplicate documentation, which will probably lead to divergence in the future again.

But both "solutions" would make one document less self-contained... I don't really like either of them. But right now the README seems more of a "start to finish" guide without many links, so it's probably better to link from the docs to the README?

Another wild idea: Include the whole README into the docs, somewhere below 4. XBPS Package Manager. Not sure if that makes sense...

Maybe I'm just overthinking.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Vergleiche xbps/repositories/signing.md mit void-packages/README.md und prüfe void-linux/void-docs#641 auf die damit verbundene Dokumentationsänderung. Entscheide, welche einzelne Quelle die Hinweise zum Signieren enthalten sollte, und überprüfe anschließend, dass die resultierende Dokumentation keinen doppelten Abschnitt enthält und für Leser verständlich bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.