Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: CloudFormation docs in schema #2816

Merged
merged 16 commits into from
Jan 26, 2023
Merged

feat: CloudFormation docs in schema #2816

merged 16 commits into from
Jan 26, 2023

Conversation

hoffa
Copy link
Contributor

@hoffa hoffa commented Jan 25, 2023

Issue #, if available

Description of changes

Full diff here: https://github.com/aws/serverless-application-model/pull/2816.diff

Adds CloudFormation docs to schema:

Screen Shot 2023-01-26 at 13 39 02

Currently uses heuristics to guess the documentation page matching definitions in the CloudFormation JSON schema.

It works reasonably well (e.g. AWS::EC2::CapacityReservationFleet.TagSpecification corresponds to aws-properties-ec2-capacityreservation-tagspecification.md), but there are exceptions such as AWS::EC2::Instance.Ebs which correspond to aws-properties-ec2-blockdev-template.md. 🤔

There are probably more robust ways of cross-referencing, without depending on a specific format as provided by GoFormation, and without heuristics (e.g. using the CloudFormation resource specification, which includes a Documentation URL which has the correct slug).

The decompressed sizes are relatively large (7 to 11 MB), but all compress nicely (3 MB in total gzipped).

Description of how you validated changes

Checked diff and tested sample templates in VS Code.

Checklist

Examples?

Please reach out in the comments if you want to add an example. Examples will be
added to sam init through aws/aws-sam-cli-app-templates.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@hoffa hoffa marked this pull request as ready for review January 26, 2023 21:46
@hoffa hoffa requested a review from a team as a code owner January 26, 2023 21:46
Makefile Show resolved Hide resolved
@hoffa hoffa merged commit 9c4f0da into aws:develop Jan 26, 2023
@hoffa hoffa deleted the cfn-docs branch January 26, 2023 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants