aws-cloudformation / aws-cloudformation/cloudformation-cli

Doc updates broken and incorrect

Open
#963 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
336
Forks
172
Avg merge
3d 5m
Merged PRs (30d)
3

Description

**First issue:**
[This official doc page](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers-create-timeoutinminutes) page maps to [this in github](https://github.com/aws-cloudformation/cloudformation-cli/blob/master/doc_source/resource-type-schema.md) 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](https://github.com/aws-cloudformation/cloudformation-cli/blob/master/src/rpdk/core/data/schema/provider.definition.schema.v1.json#L18) shows "timeoutInMinutes" which took me 30 minutes to figure out since the docs are out of date.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.