Doc updates broken and incorrect

Ouverte
#963 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
aws
Domaine
documentation

Piste de recherche

Comparez doc_source/resource-type-schema.md avec la page de documentation AWS liée, puis examinez src/rpdk/core/data/schema/provider.definition.schema.v1.json au niveau de la définition référencée. Confirmez l’orthographe canonique et vérifiez si timeoutInMinutes est documenté, puis mettez à jour la documentation source afin que sa syntaxe et son explication correspondent au schéma et à la page externe.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
336
Forks
173
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de aws-cloudformation/cloudformation-cli

Toutes les issues de aws-cloudformation/cloudformation-cli

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.