search

aws-quickstart / quickstart-documentation-base-common

Common components of the quickstart-documentation-base repo. Stored here to facilicate a centralized source-of-truth for common components of our documentation
Apache License 2.0
14 stars 17 forks source link

Helper text for editing parameter table files #21

Open annaone opened 4 years ago

annaone commented 4 years ago

The writers would LOVE for you to add some helper text to the "preview" mode that says "the following parameters are generated from templates/blah.template.yaml". This way, we know exactly what files need to be edited for the deployment guide review. Thank you!

vsnyc commented 4 years ago

This will be addressed by https://github.com/aws-quickstart/quickstart-documentation-base-common/issues/33 if we add back the template link at the top of the table/section. You can follow the link to jump to the right template

tbulding commented 4 years ago

https://github.com/aws-quickstart/quickstart-documentation-base-common/pull/50#issue-474968029 this is not helper text in the preview mode, but when you generate the adoc locally along with the parameter tables, the output will show the index, the display name, and the file name of each document the parameter tables are built from.

Index - a - Launch into a new VPC - Master.template.adoc Index - b - Launch into an existing VPC - ExistingVPC.template.adoc Index - c - Launch into Sagemaker Guardrails - SagemakerProduct.template.adoc

The .adoc filenames match the .yaml filenames in the template directory.