Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

Document default values for CloudFormation properties #1239

Closed
mnapoli opened this issue Jul 12, 2022 · 4 comments
Closed

Document default values for CloudFormation properties #1239

mnapoli opened this issue Jul 12, 2022 · 4 comments
Labels

Comments

@mnapoli
Copy link

mnapoli commented Jul 12, 2022

This is a follow-up of #272 which was closed without being fixed.

The CloudFormation documentation documents whether a property is required, but it doesn't document the default value when the property is not set.

It would be much more useful to know what the default value is for each optional property.

@dlenski
Copy link
Contributor

dlenski commented Jul 13, 2022

Thank you. As @rob3c wrote in #272 (comment):

I shudder to think at the collective hours spent by all developers world-wide using CloudFormation and independently wasting their time searching for the same basic information that should obviously be provided by AWS here (or, if there's a single source of truth for these values for each resource to avoid sync problems, then the CloudFormation docs should maintain links to that info).

There's clearly a single source-of-truth for default values of CloudFormation properties in the code that implements each CFN entity, but somehow…

The Markdown documentation in this repository consistently has these default values wiped out when it's regenerated… even after end-users take the effort to manually add the default values from other sources (which is what happened after I contributed some of these in #767).

What we're ultimately asking for here is for the maintainers to ensure that the docs in this repository, which are apparently auto-generated from some underlying source, include all of the default values for all optional CFN properties everywhere whenever they're regenerated.

@mnapoli
Copy link
Author

mnapoli commented Jul 13, 2022

The HTML documentation consistently ends up with up-to-date information on these default values

Could you clarify? I've opened this issue because the online docs do not systematically contain documentation for default values.

Random example:

image

@dlenski
Copy link
Contributor

dlenski commented Jul 13, 2022

Could you clarify? I've opened this issue because the online docs do not systematically contain documentation for default values.

You're right, @mnapoli, my statement was wrong.

In #767 (comment), I explained how I went around hunting for the default values of these parameters, but I found them in human-written blog posts about new features, rather than in the (also auto-generated?) HTML docs.

@joshbean
Copy link
Contributor

joshbean commented Dec 7, 2023

Closing this issue or pull request in advance of archiving this repo. For more information about the decision to archive this repo (and others in the "awsdocs" org), see the announcement on the AWS News Blog.

@joshbean joshbean closed this as completed Dec 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants