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

Add support for content snippets within quick start tasks

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
build-system, documentation

Direzione di ricerca

Start by reviewing the quick-start generation flow and the mod docs build scripts, then reproduce the include behavior using the README.adoc examples linked in the issue. Done means shared content snippets can be included in the generated console quick starts as well as the modular documentation.

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

Descrizione

WHAT
Add support for content snippets within quick start tasks.

WHY
In Managed Application Services (MAS), lots of our quick starts have steps in common. For example, several quick starts use the same set of instructions for creating a Kafka topic. Ideally, we could single-source these common steps using a reusable content snippet that we would include in each applicable quick start. That is just one example, and other opportunities for reuse exist in our quick starts. Similarly, there are plenty of opportunities for content reuse in the non-quick-start documentation that we publish on the Red Hat Customer Portal.

I've already done some work on my fork to test the use of a shared content directory in the app-services-guides repo. For example, the following links show two standard Asciidoc include statements that include the same snippet of content (from a shared-content directory) in two different guides:

My testing shows that with some coding additions to our mod docs build scripts, we can make this approach work for the modular documentation that the Asciidoc splitter tool generates from our README.adoc files.

However, when I test generation of our console quick starts from the same README files, I see that Patternfly cannot handle the type of include statements shown above. That is a significant blocker to progressing with content reuse in the app-services-guides repo.

Jira Issue: PF-1881

Lingua principale
TypeScript
Stelle
15
Fork
47
Nessuna PR unita negli ultimi 30g

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 patternfly/patternfly-quickstarts

Tutte le issue di patternfly/patternfly-quickstarts

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.