Docs: Remove -ignore deprecated #879
Conversation
|
In order to lower resource usage and have a faster runtime, PRs will not run Cloud tests automatically. To do so, a Grafana Labs employee must promote the Drone build. For maintainers, it's better to run only the Cloud tests you need, rather than all of them. You can do so by setting the following parameter when promoting:
|
| @@ -1,7 +1,7 @@ | |||
| #!/usr/bin/env bash | |||
|
|
|||
| # Generate docs! | |||
| go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs -ignore-deprecated | |||
| go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs | |||
There was a problem hiding this comment.
this is the meat of the change
| @@ -18,6 +18,8 @@ func ResourceAPIKey() *schema.Resource { | |||
| return &schema.Resource{ | |||
| Description: `Manages a single API key on the Grafana Cloud portal (on the organization level) | |||
| * [API documentation](https://grafana.com/docs/grafana-cloud/reference/cloud-api/#api-keys) | |||
|
|
|||
| !> Deprecated: please use ` + "`grafana_cloud_stack_service_account`" + ` and ` + "`grafana_cloud_stack_service_account_token`" + ` instead, see [Migrate API keys to Grafana service accounts using Terraform](https://grafana.com/docs/grafana-cloud/reference/migrate-api-keys-to-service-accounts/) for more information. | |||
There was a problem hiding this comment.
This is the wrong resource. This is a Cloud API key, this is absolutely not deprecated. What we should have deprecated is the cloud_stack_api_key resource
There was a problem hiding this comment.
i think we have to revisit the previous PR then - https://github.com/grafana/terraform-provider-grafana/pull/872/files#diff-04961555cdd45e8547f47c42af9a867501a2b2ebf4004768ae8d8830d728f77eR28
as we deprecated the cloud_api_key and not the cloud_stack one
There was a problem hiding this comment.
il update this PR with these changes
There was a problem hiding this comment.
does this mean we have to make a new release no?
julienduchesne
deleted the
eleijonmarck/docs/remote-ignore-depreacted-for-docs-to-show
branch
|
@julienduchesne From the docs linked https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#api-keys it says: |
No description provided.