docs: minor adjustments in provider docs (#11)

Signed-off-by: Kim Oliver Drechsel <[email protected]>
germanbrew · Jun 14, 2024 · f695c07 · f695c07
1 parent 982e4be
commit f695c07
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/docs/data-sources/dotenv.md b/docs/data-sources/dotenv.md
@@ -5,7 +5,7 @@ subcategory: ""
 description: |-
   Reads and provides all entries of a dotenv file.
   All supported formats can be found here https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs#supported-formats.
-  ~> INFO: If you only need a specific value and/or do not want to store the contents of the file in the state, you can use the get_by_key https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs/functions/get_by_key provider function.
+  -> If you only need a specific value and/or do not want to store the contents of the file in the state, you can use the get_by_key https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs/functions/get_by_key provider function.
 ---
 
 # dotenv (Data Source)
@@ -14,7 +14,7 @@ Reads and provides all entries of a dotenv file.
 
 All supported formats can be found [here](https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs#supported-formats).
 
-~> **INFO:** If you only need a specific value and/or do not want to store the contents of the file in the state, you can use the [`get_by_key`](https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs/functions/get_by_key) provider function.
+-> If you only need a specific value and/or do not want to store the contents of the file in the state, you can use the [`get_by_key`](https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs/functions/get_by_key) provider function.
 
 ## Example Usage
 

diff --git a/docs/index.md b/docs/index.md
@@ -4,7 +4,7 @@ page_title: "dotenv Provider"
 subcategory: ""
 description: |-
   A utility Terraform provider for .env files.
-  Supported formats
+  Supported Formats
   This provider supports the following formats:
   
   SOME_VAR=someval
@@ -21,7 +21,7 @@ description: |-
 # dotenv Provider
 
 A utility Terraform provider for .env files.  
-## Supported formats
+## Supported Formats
 This provider supports the following formats:  
 ```sh
 SOME_VAR=someval
@@ -30,7 +30,7 @@ export BAR=BAZ
 FOO=BAR # comments at line end are OK too
 ```
 You can also do a YAML(ish) style:
-```sh  
+```yaml  
 FOO: bar
 BAR: baz
 ```

diff --git a/internal/provider/file_data_source.go b/internal/provider/file_data_source.go
@@ -39,7 +39,7 @@ func (d *fileDotEnvDataSource) Schema(ctx context.Context, req datasource.Schema
 		// This description is used by the documentation generator and the language server.
 		MarkdownDescription: "Reads and provides all entries of a dotenv file.\n\n" +
 			"All supported formats can be found [here](https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs#supported-formats).\n\n" +
-			"~> **INFO:** If you only need a specific value and/or do not want to store the contents of the file in the state, " +
+			"-> If you only need a specific value and/or do not want to store the contents of the file in the state, " +
 			"you can use the [`get_by_key`](https://registry.terraform.io/providers/germanbrew/dotenv/latest/docs/functions/get_by_key) provider function.",
 
 		Attributes: map[string]schema.Attribute{

diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -35,7 +35,7 @@ func (p *DotenvProvider) Metadata(ctx context.Context, req provider.MetadataRequ
 func (p *DotenvProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		MarkdownDescription: "A utility Terraform provider for .env files.  \n" +
-			"## Supported formats\n" +
+			"## Supported Formats\n" +
 			"This provider supports the following formats:  \n" +
 			"```sh\n" +
 			"SOME_VAR=someval\n" +
@@ -44,7 +44,7 @@ func (p *DotenvProvider) Schema(ctx context.Context, req provider.SchemaRequest,
 			"FOO=BAR # comments at line end are OK too\n" +
 			"```\n" +
 			"You can also do a YAML(ish) style:\n" +
-			"```sh  \n" +
+			"```yaml  \n" +
 			"FOO: bar\n" +
 			"BAR: baz\n" +
 			"```",