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

Docs updates #157

Closed
wants to merge 21 commits into from
Closed

Conversation

yanmastin-astro
Copy link
Collaborator

@yanmastin-astro yanmastin-astro commented Oct 9, 2024

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 the templates folder which is added in this PR. You can also add .md files into the templates/guides folder to add markdown formatted user guides.

This PR:

  • Improves the Astro Terraform Provider listing doc homepage by adding a index.md.tmpl file that has high level descriptions, authentication information, in addition to the existing autogenerated Example Usage and Schema sections.
  • Adds a get-started.md guide that walks through a simple example use case of Astro Terraform Provider.
  • Adds a import-script.md guide that shows how to use the import script to automate the migration of existing resources into Terraform.

@yanmastin-astro yanmastin-astro requested review from vandyliu and a team as code owners October 9, 2024 18:45
docs/guides/get-started.md Outdated Show resolved Hide resolved
docs/guides/get-started.md Outdated Show resolved Hide resolved
docs/guides/get-started.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@vandyliu vandyliu left a 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!!

@vandyliu vandyliu requested a review from ichung08 October 9, 2024 20:08
templates/guides/get-started.md Outdated Show resolved Hide resolved
templates/guides/get-started.md Outdated Show resolved Hide resolved
templates/guides/get-started.md Outdated Show resolved Hide resolved
templates/guides/import-script.md Show resolved Hide resolved
templates/guides/import-script.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ichung08 ichung08 left a 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

templates/guides/get-started.md Show resolved Hide resolved
templates/guides/import-script.md Show resolved Hide resolved
templates/guides/import-script.md Show resolved Hide resolved
templates/guides/import-script.md Show resolved Hide resolved
templates/guides/import-script.md Outdated Show resolved Hide resolved
templates/guides/import-script.md Outdated Show resolved Hide resolved
templates/guides/import-script.md Outdated Show resolved Hide resolved
@yanmastin-astro
Copy link
Collaborator Author

Moved content to #159

@yanmastin-astro yanmastin-astro deleted the docs-updates branch October 18, 2024 20:16
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.

3 participants