Doc updates broken and incorrect

Aberta
#963 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
aws
Domínio
documentation

Direção de pesquisa

Compare doc_source/resource-type-schema.md com a página vinculada da documentação da AWS e, em seguida, inspecione src/rpdk/core/data/schema/provider.definition.schema.v1.json na definição referenciada. Confirme a grafia canônica e se timeoutInMinutes está documentado e, depois, atualize a documentação de origem para que sua sintaxe e explicação correspondam ao schema e à página externa.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
336
Forks
173
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de aws-cloudformation/cloudformation-cli

Todas as issues de aws-cloudformation/cloudformation-cli

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.