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

Refresh the repo README #10481

Closed
wants to merge 2 commits into from
Closed

Refresh the repo README #10481

wants to merge 2 commits into from

Conversation

rileykarson
Copy link
Collaborator

Largely based on the current AWS one. I'll clone changes against tpgb after, but figured I'd get approval here first to avoid having to do work twice.

@rileykarson rileykarson requested a review from megan07 November 2, 2021 21:35
@github-actions github-actions bot requested a review from slevenick November 2, 2021 21:35
Copy link
Contributor

@megan07 megan07 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

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

I'm approving so I don't block, but I had a couple of thoughts about organization. It's so great you're reworking this - I think it's going to be a really nice update! :-). I'm happy to take another look if you want me to if/when you make changes.

Comment on lines +11 to +12
The Terraform Google provider is a plugin for Terraform that allows for management of GCP resources.
This provider is maintained by the [Terraform team at Google](https://cloudplatform.googleblog.com/2017/03/partnering-on-open-source-Google-and-HashiCorp-engineers-on-managing-GCP-infrastructure.html) and the Terraform team at [HashiCorp](https://www.hashicorp.com/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Terraform Google provider is a plugin for Terraform that allows for management of GCP resources.
This provider is maintained by the [Terraform team at Google](https://cloudplatform.googleblog.com/2017/03/partnering-on-open-source-Google-and-HashiCorp-engineers-on-managing-GCP-infrastructure.html) and the Terraform team at [HashiCorp](https://www.hashicorp.com/)
The Terraform Google provider is a plugin that allows Terraform to manage resources on Google Cloud Platform. This provider is maintained by the [Terraform team at Google](https://cloudplatform.googleblog.com/2017/03/partnering-on-open-source-Google-and-HashiCorp-engineers-on-managing-GCP-infrastructure.html) and the Terraform team at [HashiCorp](https://www.hashicorp.com/)


Using the provider
Documentation
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need this section? I only ask because I see we have documentation linked above already!


This provider plugin is maintained by:
Also see the ['google-beta' provider](https://github.com/hashicorp/terraform-provider-google-beta) for preview features and features at a beta [launch stage](https://cloud.google.com/products#product-launch-stages). See [Provider Versions](https://www.terraform.io/docs/providers/google/provider_versions.html) for more details on how to use `google-beta`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I also think you should start the README off with this nice description of what this is :-) Then I think you can move into the get started section and any links. I just think if folks come here, the first thing they'd want is to understand what the google provider is.

Suggested change
Also see the ['google-beta' provider](https://github.com/hashicorp/terraform-provider-google-beta) for preview features and features at a beta [launch stage](https://cloud.google.com/products#product-launch-stages). See [Provider Versions](https://www.terraform.io/docs/providers/google/provider_versions.html) for more details on how to use `google-beta`.
The ['google-beta' provider](https://github.com/hashicorp/terraform-provider-google-beta) contains preview features and features at a beta [launch stage](https://cloud.google.com/products#product-launch-stages). Refer to the [provider versions](https://www.terraform.io/docs/providers/google/provider_versions.html) documentation for more information about how to use `google-beta`.

------------

- [Terraform](https://www.terraform.io/downloads.html) 0.12+
Quick Starts
Copy link
Contributor

Choose a reason for hiding this comment

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

Okay I think you could make this a true get started section and have the get started quick start you have linked plus maybe the tutorials and documentation link? Then I wonder if it might be nice to have a "Community" or a "Contribute" section where you link the community forum and provide a link to the instructions about provider development?

Suggested change
Quick Starts
Get Started

@@ -2,33 +2,29 @@ Terraform Provider for Google Cloud Platform
==================

- Website: https://www.terraform.io
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the website for terraform, but this provider isn't on it. Instead of doing this here, I actually wonder if you could do an in-text link in the initial description like "The google provider is a plugin that allows Terraform to manage infrastructure on Google Cloud Platform."

@megan07
Copy link
Contributor

megan07 commented Oct 10, 2022

closing due to more recent changes

@megan07 megan07 closed this Oct 10, 2022
@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 10, 2022
@rileykarson rileykarson deleted the rileykarson-patch-8 branch September 15, 2023 19:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants