FEATURE: Have a link for toplevel sections

Offen Anfängerfreundlich
#941 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Finde die Dokumentationsseite mit dem Abschnitt „Installation and configuration“ und prüfe, wie die Unterabschnitte Links erhalten. Füge einen verlinkbaren Abschnitt auf oberster Ebene hinzu, zum Beispiel eine Liste mit Links zu diesen Unterabschnitten. Fertig ist die Aufgabe, wenn Leser direkt auf die Übersicht verlinken können, wie EESSI installiert oder aufgerufen wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

While writing emails and documentations i've often found myself wanting to link to a toplevel How to install/access EESSI section which right now would be the Installation and configuration section in the doc.

Currently links are available only for its subsections, but i think it would be useful to introduce a top level sections (even a list with links to its subsection) that can be linked to for reporting

Vorherrschende Sprache
Python
Sterne
14
Forks
54
Ø Merge
11 Std. 2 Min.
Gemergte PRs (30 T.)
41

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus EESSI/docs

Alle Issues in EESSI/docs

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

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