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

Find alternative way to create AWS CloudFormation/SAM doc index #199

Open
3 tasks done
pitkley opened this issue Dec 15, 2023 · 2 comments
Open
3 tasks done

Find alternative way to create AWS CloudFormation/SAM doc index #199

pitkley opened this issue Dec 15, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@pitkley
Copy link
Owner

pitkley commented Dec 15, 2023

Following the announcement of "Retiring the AWS Documentation on GitHub", the aws-cloudformation-user-guide was finally removed of its content last week (2023-12-08). The aws-sam-developer-guide hasn't had content since June 2023.

We now need an alternative way of creating an index for the CFN docs. The AWS CloudFormation resource specification is a potential candidate for programmatically identifying resources that exist. The main challenge is going to be generating valid URLs out of it -- from what I recall, the naming scheme of the URLs for the individual pages in the CFN docs was not consistent. It also does not solve the problem of getting a summary into ASE, but we could worst-case just skip out on that.

I don't yet know if something similar for SAM exists.

@pitkley pitkley added the bug Something isn't working label Dec 15, 2023
@pitkley pitkley changed the title Find alternative way to create AWS CloudFormation doc index Find alternative way to create AWS CloudFormation/SAM doc index Dec 15, 2023
@pitkley
Copy link
Owner Author

pitkley commented Dec 16, 2023

The CFN resource specification is likely the way to go, since it does contain links to docs. We would likely lose the summary though.

We do need something else to get the intrinsic-function docs, though.

@pitkley
Copy link
Owner Author

pitkley commented Dec 18, 2023

#201 gets the CFN-related content, including data on intrinsic functions, from the CFN-specs stored in the aws-cloudformation/cfn-lint repository. #209 "hardcodes" the last SAM status from before the documentation shutdown.

Issues currently remaining:

  • No summaries for any CloudFormation resources
  • No summaries for any CloudFormation intrinsics
  • SAM resources are now static and won't update if they change

I did a little further digging and stumbled upon these additional structured sources:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant