Docs-core delivery of new PF documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 20/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- javascript
- Ambito
- api, build-system, documentation
Direzione di ricerca
Inizia esaminando l’infrastruttura docs-core basata su Astro e il modo in cui si relaziona al framework di documentazione PatternFly esistente. L’issue è completata solo quando sono stati risolti la documentazione pianificata, la props REST API, la validazione, gli esempi, le prestazioni e le questioni relative alla sostituzione, ma non identifica file, test o una prima attività circoscritta.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
This epic focuses on utilizing the astro-based docs-core infrastructure to continue enhancing PatternFly's documentation.
In Q4, we are going to:
-
leverage the astro framework to build out agent friendly documentation as text files.
-
leverage the astro framework to deliver a Rest API for fetching component props to enable JSON schema validation of PF component definitions.
-
Investigate the power of astro to reconstruct the PF component documentation and resolve questions of:
-
performance
-
server side validation
-
inline live component examples
-
full page demos/examples
-
Determine if this framework is capable of fully replacing the PatternFly documentation-framework for building patternfly.org.
Jira Issue: PF-2190
- Lingua principale
- JavaScript
- Stelle
- 74
- Fork
- 148
- Merge medio
- 3g 18h
- PR unite (30g)
- 3
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi 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.
Altre issue di patternfly/patternfly-org
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
patternfly/patternfly-org#5098 ·
-
PF Team
Difficoltà 1/5 1-3 ore Idoneità per principianti 68/100
patternfly/patternfly-org#4999 ·
-
A11y Documentation PF Team
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
patternfly/patternfly-org#4596 ·
-
Guidelines updates: IconApertaPF Team PF6 Design guidelines
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
patternfly/patternfly-org#4487 · 2 commenti ·
-
Content PF Team
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
patternfly/patternfly-org#3918 ·
Tutte le issue di patternfly/patternfly-org
Issue simili
-
bug confirmed perf
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
videojs/video.js#9400 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
agent/scanner bug hive/hosted-available-lke648397-260827-5n31
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
rescript-lang/rescript#8765 ·
I maintainer di solito rispondono entro 1 giorno
-
feedback simulation workshop
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
githubnext/gh-aw-workshop#4417 ·
I maintainer di solito rispondono entro 1 giorno
-
[Good First Issue]: Add unit tests for NetworkVersionInfoForse già presa Una pull request collegata a questa issue è aperta o già unita. ApertaGood First Issue hacktoberfest
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
hiero-ledger/hiero-sdk-js#4489 ·
I maintainer di solito rispondono entro 1 giorno