Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.98 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.98 KB
Raw

Interactive AWS CloudFormation Docs

A simple JavaScript that can be ran on AWS CloudFormation Documentation to make it more interactive.

The hope is that this is a building block to make an interactive template builder based on the docs.

To try it out

  1. Visit this typical CloudFormation Documentation URL: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html

  1. Open the Developers Tool JavaScript console.

  2. Paste the contents of the test_script_to_paste_into_console.js file from this repository.

  3. Hover over the YAML version of the "Syntax" section.

A typical CloudFormation Docs web page

Screenshot of a typical CloudFormation Docs web page

The same CloudFormation Docs page using this script

Screenshot of Demo

The future

It would be great to have an interactive builder where it looks like this demo. Hover to read about it. Click to make changes to the template. When done, copy/download the finished template.

Some UX ideas for a future builder

  • Clicking property values that are Objects would pull in the YAML syntax for that specific Object.
  • Clicking to edit String property values will also show a list of suggested or recent Intrinsic Functions.
  • When intrinsic functions like Ref: are selected, a list of resources and parameters in the working template is listed.
  • When intrinsic functions like Fn::Sub are selected, the syntax for them are pulled into that location for editing.