googleapis / googleapis/java-docfx-doclet
Determine correct library overview for non-standard modules
Nessuno ha ancora preso questa issue.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 5
- Fork
- 9
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Certain non-standard modules such as `api-common-java`, `gax`, and `java-common-protos` don't follow the standard installation instructions of using a bom. We should determine what the library overview page for these modules should look like (potentially just copying the README.md file, similar to how we copy the CHANGELOG.md file).
Depending on the outcome, we may not need to make any doclet changes and the changes could be entirely within the g3 script.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Confronta la gestione di README.md e CHANGELOG.md nello script g3 per api-common-java, gax e java-common-protos, quindi verifica se il doclet necessita di modifiche. Il lavoro è completato quando è stato deciso il comportamento corretto della panoramica della libreria per questi moduli non standard ed è chiara la posizione necessaria per l’implementazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- documentation, tooling
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100