Doc updates broken and incorrect

Aperta
#963 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
aws
Ambito
documentation

Direzione di ricerca

Confronta doc_source/resource-type-schema.md con la pagina della documentazione AWS collegata, quindi esamina src/rpdk/core/data/schema/provider.definition.schema.v1.json nella definizione indicata. Conferma la grafia canonica e se timeoutInMinutes è documentato, quindi aggiorna la documentazione sorgente in modo che la sintassi e la spiegazione corrispondano allo schema e alla pagina esterna.

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

Descrizione

documentation

First issue:
This official doc page page maps to this in github and they are not equal. The latest change was from 1 year ago, why is it out of date? I know this because I was going to open a PR for my second issue, but I see the "timeoutinMinutes" isn't even in the Syntax section or the explanation below. Is it deprecated?

Second Issue:
Current AWS Doc page shows timeout in minutes as : "timeoutinMinutes"
image

However the schema definition shows "timeoutInMinutes" which took me 30 minutes to figure out since the docs are out of date.

Lingua principale
Python
Stelle
336
Fork
173
Metriche di merge delle PR
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 aws-cloudformation/cloudformation-cli

Tutte le issue di aws-cloudformation/cloudformation-cli

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.