Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Split plugin index page summary for better anchor links

Aperta
  • Qualcosa non va?
#69 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
html
Ambito
documentation

Direzione di ricerca

Start from the plugin index page linked in the issue and inspect how its summary and table of contents are generated. Restructure the summary into the requested General, User, and optional Admin sections, with anchor links and conditional admin content; done when long plugin indexes are easier to navigate.

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

Descrizione

enhancement

Split the summary into sections, like:

# Welcome to plugin

{{ Plugin index page }}

---

## Summary

### General

* RESTAPI
* Changelog
* Github (maybe add this too)

### User

* User Home  # use plugin/user/index.md if it exists
* Guides
* Learn
* etc

### Admin

# omit Admin Home, if {plugin}/admin/index.md doesnt exit
* Guides
* Learn
* etc

The benefits of this are:

  • We can link to the whole "Admin" section of pulpcore, for example, if that doesnt have an index page.
  • Some repositories have long ToC (example, pulp-operator). This can help readabillity
Lingua principale
HTML
Stelle
2
Fork
17
Merge medio
7g 18h
PR unite (30g)
3

Preparare l'ambiente

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 pulp/pulp-docs

Tutte le issue di pulp/pulp-docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.