golang/go

x/website: ref/mod's vcs-find section should mention the "mod" version control system

Open

#48.867 geöffnet am 8. Okt. 2021

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (19.008 Forks)batch import
DocumentationNeedsFixhelp wantedmoduleswebsite

Repository-Metriken

Stars
 (133.883 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

I recently asked a question which boils down to: can I publish a Go module in plain zip archives, without using a standard VCS like git?

@bcmills helpfully pointed me towards https://golang.org/ref/mod#serving-from-proxy, which is basically what I want :)

The reason I had failed to find that section of the reference doc is because I looked in https://golang.org/ref/mod#vcs-find, which does not list "mod" in its table. It probably should, and have the mention link to the serving-from-proxy section.

Contributor Guide

Research-Richtung
Das Problem bezieht sich auf die Go Modul Referenzdokumentation, wahrscheinlich im Repository 'golang/website' unter 'content/ref/mod'. Der Abschnitt 'vcs find' enthält eine Tabelle von Versionskontrollsystemen; das 'mod' System fehlt. Die Lösung besteht darin, eine Zeile für 'mod' in dieser Tabelle hinzuzufügen, die auf den Abschnitt 'serving from proxy' verlinkt. Es gibt einen Kommentar von @bcmills, der den bestehenden Abschnitt für das Bereitstellen von einem Proxy klärt. Mitwirkende sollten die bestehende Dokumentationsstruktur im Website Repository überprüfen und dem Stil der anderen VCS Einträge folgen.
Tech Stack
go
Domain
backenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90