chore: follow md pulumi best practices

checkly · Jun 18, 2022 · 7144661 · 7144661
1 parent dc15860
commit 7144661
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/docs/_index.md b/docs/_index.md
@@ -62,4 +62,3 @@ new checkly.Check( "brwoser-check", {
 {{< /chooser >}}
 
 > You could find more complete and detailed examples in the [pulumi-checkly repository](https://github.com/checkly/pulumi-checkly/tree/main/examples)
-
diff --git a/docs/how-to-guides/_index.md b/docs/how-to-guides/_index.md
@@ -65,11 +65,14 @@ layout: how-to
     run()`
     })
     ```
+
 1. Setup you Checkly API Key and Account id:
+
     ```bash
     $ pulumi config set checkly:apiKey cu_xxx --secret
     $ pulumi config set checkly:accountId xxx
     ```
+
 1. You are ready to go, run `$ pulumi up` to deploy your stack 🚀
 
-> Check the [examples directory](https://github.com/checkly/pulumi-checkly/tree/main/examples) for more detailed code samples.
+> Check the [examples directory](https://github.com/checkly/pulumi-checkly/tree/main/examples) for more detailed code samples.
diff --git a/docs/installation-configuration.md b/docs/installation-configuration.md
@@ -20,7 +20,7 @@ $ yarn add @checkly/pulumi
 
 ### Python, Go & .NET
 
-*TBA*
+> *TBA*
 
 ## Authentication
 
@@ -31,12 +31,14 @@ The Pulumi Checkly Provider needs to be configured with a Checkly `API Key` and
 Once you generated the `API Key` there are two ways to communicate your authorization tokens to Pulumi:
 
 1. Set the environment variables `CHECKLY_API_KEY` and `CHECKLY_ACCOUNT_ID`:
+
     ```bash
     $ export CHECKLY_API_KEY=cu_xxx
     $ export CHECKLY_ACCOUNT_ID=xxx
     ```
 
 2. Set them using `pulumi config` command, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:
+
     ```bash
     $ pulumi config set checkly:apiKey cu_xxx --secret
     $ pulumi config set checkly:accountId xxx
Original file line number	Diff line number	Diff line change
Expand Up		@@ -62,4 +62,3 @@ new checkly.Check( "brwoser-check", {
		{{< /chooser >}}

		> You could find more complete and detailed examples in the [pulumi-checkly repository](https://github.com/checkly/pulumi-checkly/tree/main/examples)