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

Doc Updates #159

Merged
merged 47 commits into from
Oct 31, 2024
Merged

Doc Updates #159

merged 47 commits into from
Oct 31, 2024

Conversation

yanmastin-astro
Copy link
Collaborator

@yanmastin-astro yanmastin-astro commented Oct 18, 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.

🧪 Functional Testing

Manual review

@yanmastin-astro yanmastin-astro requested review from vandyliu and a team as code owners October 18, 2024 20:07
@yanmastin-astro yanmastin-astro self-assigned this Oct 18, 2024
@yanmastin-astro yanmastin-astro mentioned this pull request Oct 18, 2024
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 taking the time to make the adjustments we discussed last week! this looks much better now

a few small comments but overall looks good to me

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
Copy link
Contributor

@lzdanski lzdanski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yanmastin-astro This is fantastic work! My feedback is almost completely style guide conventions that are more or less variations on:

  • reduce future tense and 'to be' verb constructions
  • Position the voice to be "Astronomer recommends" vs "we recommend"

🎉 fantastic. Almost there!

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/get-started.md Show resolved Hide resolved
templates/guides/get-started.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
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
Copy link
Contributor

@lzdanski lzdanski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some copyediting and voice suggestions!

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/get-started.md Outdated Show resolved Hide resolved
templates/guides/get-started.md Outdated Show resolved Hide resolved
templates/guides/import-script.md Outdated Show resolved Hide resolved
templates/guides/get-started.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
templates/guides/import-script.md Outdated Show resolved Hide resolved
Copy link

@chobberoni chobberoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After taking Laura's considerations in, this will be good to go!

Copy link
Contributor

@lzdanski lzdanski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found one possible typo? LGTM!

templates/guides/import-script.md Outdated Show resolved Hide resolved
@yanmastin-astro yanmastin-astro merged commit 40a4737 into main Oct 31, 2024
9 checks passed
@yanmastin-astro yanmastin-astro deleted the tf-doc-updates branch October 31, 2024 20:03
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.

4 participants