Mount autoops-insights cloud docs in site navigation
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 70/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- csharp, github, yaml
- Ambito
- documentation, tooling
Direzione di ricerca
Inizia leggendo config/navigation.yml e la voce AutoOps Elasticsearch esistente. Scopri come le voci di navigazione impostano un path_prefix senza collisioni e montano un TOC di origine; aggiungi il TOC cloud in autoops-insights://cloud con un prefisso proprio. Verifica che il controllo dei prefissi di navigazione accetti le pagine cloud preservando la voce Elasticsearch esistente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
What is getting in your way?
elastic/autoops-insights is adding a second docs folder, generated/docs/cloud/, next to the existing generated/docs/elasticsearch/ catalog. docs-build on those PRs fails in NavigationPrefixChecker because the published navigation only mounts the Elasticsearch toc.
config/navigation.yml today:
# AutoOps insights
# https://github.com/elastic/autoops-insights/blob/main/generated/docs/elasticsearch/toc.yml
- toc: autoops-insights://elasticsearch
path_prefix: reference/autoops-insights
The cloud pages link to each other (cloud/index.md and the insight page). The assembler cannot place autoops-insights://cloud/... in the navigation, and those paths are not phantoms, so the build errors:
Can not validate 'autoops-insights://cloud/incident.md' it's not declared in any link reference nor is it a phantom
Can not validate 'autoops-insights://cloud/index.md' it's not declared in any link reference nor is it a phantom
The same check fails for autoops-insights://cloud/notice.md on the notice PR.
What would you like instead?
Add a navigation entry for autoops-insights://cloud (source toc: generated/docs/cloud/toc.yml in elastic/autoops-insights).
The existing Elasticsearch entry already owns reference/autoops-insights, so the cloud prefix has to be chosen so it does not collide with that prefix. Two open content PRs are blocked on this:
- https://github.com/elastic/autoops-insights/pull/189 (
SERVICE_INCIDENT, run https://github.com/elastic/autoops-insights/actions/runs/38902471178) - https://github.com/elastic/autoops-insights/pull/186 (
CUSTOMER_NOTICE, run https://github.com/elastic/autoops-insights/actions/runs/38899902779)
Anything else?
Vale and the docs prose checks pass. Only the navigation prefix check fails. The cloud toc currently lists index.md plus one insight page (incident.md or notice.md, depending on which PR merges first).
- Lingua principale
- C#
- Stelle
- 25
- Fork
- 45
- Merge medio
- 17h 6m
- PR unite (30g)
- 257
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
-
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
-
enhancement needs triage user-experience
Difficoltà 4/5 3-5 giorni Idoneità per principianti 55/100
elastic/docs-builder#4555 ·
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 78/100
unoplatform/uno.check#591 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
weaviate/csharp-client#378 ·
-
agentic-workflows automated testing
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
Azure-Samples/Legacy-Modernization-Agents#194 ·
I maintainer di solito rispondono entro 1 giorno
-
area-encryption area-security p1-recommended technical-debt
Difficoltà 2/5 Meno di un'ora Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
bug flaky small
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
hexide-io/HexIDE#1906 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno