Migrate remaining how-to content out of the Flow reference
I maintainer di solito rispondono entro 1 giorno
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à
- Attiva
- Stack tecnologico
- docker, spring-boot
- Ambito
- documentation
Direzione di ricerca
Start with guidelines/information-architecture.md to learn the reference-page pattern, then compare articles/flow/production/production-build.adoc, docker.adoc and spring-boot.adoc with their Building Apps counterparts under articles/building-apps/production/. The issue also names articles/flow/testing/end-to-end/getting-started.adoc and three page-title lines to reword. Done means each listed page is either cut to reference content or removed with a redirect, and the titles read as neutral reference.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Follow-up to #5120. Most of the articles flagged there have been migrated or removed. These items in articles/flow still don't fit the reference-documentation pattern described in guidelines/information-architecture.md.
1. End-to-end testing tutorial
articles/flow/testing/end-to-end/getting-started.adocis still a step-by-step tutorial. Its own description says "Tutorial to begin doing end-to-end testing".- Action: move the tutorial content to Building Apps, or rewrite the page as reference (TestBench dependency and setup facts only), and add redirects as needed.
2. Production pages that overlap with Building Apps
Building Apps now has production guides (articles/building-apps/production/build.adoc, container.adoc, configure.adoc, and others). These Flow pages cover the same ground in how-to style:
articles/flow/production/production-build.adocarticles/flow/production/docker.adocarticles/flow/production/spring-boot.adoc
Action: review each page against the matching Building Apps guide. Either cut it down to pure reference (e.g. build options, Maven/Gradle settings, packaging facts) or remove it in favour of the guide, with a redirect.
3. How-to wording in page titles
These pages already read as reference, but their page-title front matter is still phrased as a how-to guide:
articles/flow/integrations/spring/spring-boot.adoc: "How to Integrate Vaadin with Spring Boot: A Complete Guide"articles/flow/configuration/development-mode/index.adoc: "How to configure development mode in Vaadin"articles/flow/configuration/live-reload/index.adoc: "How to enable live reload in Vaadin"
Action: reword these titles in neutral reference style.
- Lingua principale
- AsciiDoc
- Stelle
- 38
- Fork
- 225
- Merge medio
- 17h 38m
- PR unite (30g)
- 214
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Nessuna 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 vaadin/docs
-
Creating Tests page uses deprecated TestBench ElementQuery APIForse già presa @jcgueriaud1 l’ha presa 5 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
I maintainer di solito rispondono entro 1 giorno
-
design system
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
vaadin/docs#5773 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
design system
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
a11y design system
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
a11y design system
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
documentation tool triaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
can1357/oh-my-pi#19608 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
documentation good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
liberation-data/drivine-python#529 ·
I maintainer di solito rispondono entro 1 giorno
-
automated documentation maintenance
Difficoltà 1/5 1-3 ore Idoneità per principianti 75/100
github/gh-aw-mcpg#16717 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 2 giorni