Add a browser-level layout test for the API examples column
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 55/100
Direzione di ricerca
Start by reading the existing visual harness in src/Elastic.Documentation.Site/visual/ and the test setup behind npm run test; those tests use JSDOM and cannot measure layout. Add a Playwright test that loads a fixed local API spec with long request and response examples in both layouts at short and tall window heights. Done means both code blocks keep nonzero, stable heights and the response can be reached by scrolling.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
The API examples column has no automated test that checks its layout, so a window-height bug like the one fixed in #4554 can come back with every check green.
What is getting in your way
npm run test runs in JSDOM, which does no layout. It cannot see a request code block that collapses to zero height or a response pushed out of view. The visual harness in src/Elastic.Documentation.Site/visual/ compares screenshots against seeded baselines. It does not assert block heights or reachability, and the API pages it loads build from specs fetched at run time.
What would you like instead
A Playwright test that opens an API operation with a long request example and a long response example. It runs at a short and a tall window height, in the legacy and the design-system layouts. It asserts that each code block has a nonzero height that stays the same across window heights, and that the response is reachable by scrolling the page. The operation needs a fixed local spec, so the example lengths do not change between runs.
Anything else
Raised in review on #4554 by an automated reviewer.
- Lingua principale
- C#
- Stelle
- 25
- Fork
- 45
- Merge medio
- 17h 9m
- PR unite (30g)
- 292
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 elastic/docs-builder
-
enhancement needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
elastic/docs-builder#4495 ·
I maintainer di solito rispondono entro 1 giorno
-
needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
elastic/docs-builder#4232 ·
I maintainer di solito rispondono entro 1 giorno
-
chore needs triage tech-debt
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
elastic/docs-builder#3567 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
chore needs triage tech-debt
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
elastic/docs-builder#3566 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
ai-triaged bug needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
elastic/docs-builder#3045 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di elastic/docs-builder
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
[Bug] Dashboard renders attachment links that resolve to 404 when the FILES binding is absentApertabug 優先: 低
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
-
.NET area: storage bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Larson-Logan/medal-sync#61 ·
I maintainer di solito rispondono entro 1 giorno