-
Notifications
You must be signed in to change notification settings - Fork 4
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
Docs updates #157
Docs updates #157
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
few comments but thanks for doing this!
the docs look much cleaner now!!
Co-authored-by: Vandy Liu <[email protected]>
Co-authored-by: Vandy Liu <[email protected]>
Co-authored-by: Isaac Chung <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for adding more steps to the guide
i think the overall structure is better however it would also be helpful for the guide to be written in a more step by step guide (similar to the get-started.md
one) where you could take the user through the process of creating an org, workspace, deployment, api-token (just a couple resources) in the UI and then walk them through the process of setting up and running the import script. the way it is right now also works, but i think it would be beneficial for this to be a more interactive experience
also you'll notice i have a couple comments on some odd formatting, i think your editor formats <
and >
differently
Moved content to #159 |
Description
The purpose of this PR is to improve the docs in the Astro terraform registry listing.
The files in the
docs
folder are autogenerated from default templates by the tfplugindocs tool during the build. You can overwrite the default templates using .tmpl files in thetemplates
folder which is added in this PR. You can also add .md files into thetemplates/guides
folder to add markdown formatted user guides.This PR:
index.md.tmpl
file that has high level descriptions, authentication information, in addition to the existing autogenerated Example Usage and Schema sections.