update auth docs #1587
update auth docs #1587
Conversation
website/docs/index.html.markdown
Outdated
| @@ -58,7 +59,8 @@ The following keys can be used to configure the provider. | |||
| details. On your computer, if you have made your identity available as the | |||
| Application Default Credentials by running [`gcloud auth application-default | |||
| login`](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login), | |||
| the provider will use your identity. | |||
| the provider will use your identity. However, this method is not guaranteed to | |||
There was a problem hiding this comment.
Consider putting it in bold or as a Note. I think this is a very important caveat.
There was a problem hiding this comment.
Not sure if you know this, but if you put ~> and then text like:
~> This is a note
It'll get called out with the right CSS to actually look like a note. There's also:
!>for big red warnings->for info=>for green success
I would like to link to the service accounts section or some kind of documentation. We say "this is the easiest way, but it might break in edge cases", name the replacement, but then don't provide a way to get more information on the replacement.
There was a problem hiding this comment.
Yeah, by Note, I meant ~> like we do here.
But I didn't know about => and ->. Thanks for sharing this tip :)
website/docs/index.html.markdown
Outdated
| @@ -58,7 +59,8 @@ The following keys can be used to configure the provider. | |||
| details. On your computer, if you have made your identity available as the | |||
| Application Default Credentials by running [`gcloud auth application-default | |||
| login`](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login), | |||
| the provider will use your identity. | |||
| the provider will use your identity. However, this method is not guaranteed to | |||
There was a problem hiding this comment.
Not sure if you know this, but if you put ~> and then text like:
~> This is a note
It'll get called out with the right CSS to actually look like a note. There's also:
!>for big red warnings->for info=>for green success
I would like to link to the service accounts section or some kind of documentation. We say "this is the easiest way, but it might break in edge cases", name the replacement, but then don't provide a way to get more information on the replacement.
website/docs/index.html.markdown
Outdated
| @@ -36,7 +36,8 @@ The following keys can be used to configure the provider. | |||
|
|
|||
| * `credentials` - (Optional) Contents of a file that contains your service | |||
| account private key in JSON format. You can download this file from the | |||
There was a problem hiding this comment.
For SEO purposes, we should try to make the link descriptive, like:
You can download your existing [Google Cloud service account file](LINK) from the Google Cloud Console, or you can create a new one from the same page.
|
Thanks @sethvargo for the ideas, should be better now. |
…-google * 'master' of https://github.com/olvesh/terraform-provider-google: (24 commits) Cleanup after v1.14.0 release v1.14.0 Update CHANGELOG.md Add new google_compute_regions (hashicorp#1603) Update CHANGELOG.md Fix forwarding rule data source test (hashicorp#1606) Update CHANGELOG.md Fix redis authorized network and tests. The Redis API currently only accepts partial links. The tests weren't failing because they weren't actually using the network (oops). There were a few other test issues that I fixed while I was there. Fixes hashicorp#1571. (hashicorp#1599) update auth docs (hashicorp#1587) Fix network_tier tests. Add documentation for network tier (hashicorp#1593) Warn about ip_version with ip_address in global forwarding rule (hashicorp#616) Update CHANGELOG.md add support for network tiers (hashicorp#1530) Update CHANGELOG.md Allow using in repo configuration for cloudbuild trigger (hashicorp#1557) Update CHANGELOG.md add update support for redis (hashicorp#1590) Update CHANGELOG.md Added GCP Netblock Data Source (hashicorp#1416) (hashicorp#1580) ...
* Added a link to the console page where you can download a file * Removed instructions on how to get to that page, since now you can just click on the link * Added caveat for application default credentials @sethvargo @theacodes @kimcam let me know if this seems reasonable / you have any suggestions!
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks! |
ghost
locked and limited conversation to collaborators
@sethvargo @theacodes @kimcam let me know if this seems reasonable / you have any suggestions!