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

Correct getting-started instructions and verify deployed database behavior

Aperta
  • Qualcosa non va?
#2,051 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
kubernetes, postgresql
Ambito
documentation

Direzione di ricerca

Start with docs/content/getting-started/_index.md and the install-radius, deploy-demo, and add-connection pages. Check the supported CLI commands and identify the runtime namespaces from application/resource labels, then verify both rollouts and the documented end-to-end todo and database checks. Done when the PostgreSQL and Secret guidance, scoped commands, rollout waits, and reliable live-session verification are correct for the supported CLI.

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

Descrizione

triaged

What content needs to be created or modified?

The overview and deployment page still promise Redis although the connection tutorial uses PostgreSQL and an authored Secret. Commands assume a namespace and do not wait for both current rollouts.

Describe the solution you'd like

Replace stale Redis text with PostgreSQL/Secret descriptions. Use kubectl config use-context when selecting a context. Find the actual runtime namespaces using application/resource labels rather than assuming the Environment namespace. Scope kubectl commands to those namespaces and wait for both demo and database deployments.

Add an end-to-end check: create and complete a todo, refresh, verify its stored SQL row, delete it, and verify the row is absent. If documenting transport verification, inspect the current demo pod's pg_stat_ssl session rather than a separate client; an empty result must not count as success. The demo closes its pool after each request, so provide a reliable way to observe a live session.

Verify commands against the selected supported CLI. A local test with CLI commit 44eaf65 found that initialize, application graph, and application delete reject the tutorial's --preview flag. Do not replace flags globally without checking the supported version.

Where should the new material be placed?

docs/content/getting-started/_index.md and the install-radius, deploy-demo and add-connection pages.

The associated pull request from the Radius code repo, if applicable

N/A. Split from https://github.com/radius-project/docs/pull/2041.

Additional context

The previous local candidate run verified namespace discovery, both rollouts, HTTP CRUD, persisted rows and the actual demo connection. It required supported-command adaptations and does not prove the unchanged public tutorial works.

Lingua principale
Bicep
Stelle
27
Fork
51
Merge medio
1g 20m
PR unite (30g)
31

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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 radius-project/docs

Tutte le issue di radius-project/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.