docs: improve docs by using code-styled markdown #260
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnstcn
reviewed
Jul 4, 2024
| @@ -16,7 +16,7 @@ func gitAuthDataSource() *schema.Resource { | |||
| SchemaVersion: 1, | |||
|
|
|||
| DeprecationMessage: "Use the `coder_external_auth` data source instead.", | |||
| Description: "Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.", | |||
| Description: "~> **Deprecated**\nUse the `coder_external_auth` data source instead.\n\nUse this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.", | |||
There was a problem hiding this comment.
This makes it rendered as a warning
https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
29 tasks
johnstcn
approved these changes
Jul 4, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
backports d2e2d96 to https://github.com/coder/terraform-provider-coder/tree/release/1.0
We can patch v1.0.1 so users can benefit from the docs improvement.