Skip to content

Commit

Permalink
docs: Use markdown emphasize-syntax in demo documentation (#3786)
Browse files Browse the repository at this point in the history
Signed-off-by: Sascha <[email protected]>
  • Loading branch information
baysideengineer authored Jan 17, 2025
1 parent 8b6b614 commit a669b9b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
10 changes: 6 additions & 4 deletions demo/agilebank/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
> NOTE:
Be sure to look at the [prerequisite](https://open-policy-agent.github.io/gatekeeper/website/docs/install#prerequisites) and Gatekeeper [installation](https://open-policy-agent.github.io/gatekeeper/website/docs/install#installation) steps before attempting to run the script.
> [!NOTE]
> Be sure to look at the [prerequisite](https://open-policy-agent.github.io/gatekeeper/website/docs/install#prerequisites) and Gatekeeper [installation](https://open-policy-agent.github.io/gatekeeper/website/docs/install#installation) steps before attempting to run the script.
> NOTE: Use the latest version of Gatekeeper as some of the features are only available in the latest Gatekeeper release and some of the features are only compatible with Kubernetes v1.19+.
> [!NOTE]
> Use the latest version of Gatekeeper as some of the features are only available in the latest Gatekeeper release and some of the features are only compatible with Kubernetes v1.19+.
> TIP: If you are new to k8s, you can stand up a simple cluster using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/): `kind create cluster`.
> [!TIP]
> If you are new to k8s, you can stand up a simple cluster using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/): `kind create cluster`.
This is a demo involving a fictitious bank named Agile Bank.

Expand Down
6 changes: 4 additions & 2 deletions demo/basic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
> NOTE: Be sure to look at the [prerequisite](https://open-policy-agent.github.io/gatekeeper/website/docs/install#prerequisites) and Gatekeeper [installation](https://open-policy-agent.github.io/gatekeeper/website/docs/install#installation) steps before attempting to run the script.
> [!NOTE]
> Be sure to look at the [prerequisite](https://open-policy-agent.github.io/gatekeeper/website/docs/install#prerequisites) and Gatekeeper [installation](https://open-policy-agent.github.io/gatekeeper/website/docs/install#installation) steps before attempting to run the script.
> TIP: If you are new to k8s, you can stand up a simple cluster using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/): `kind create cluster`.
> [!TIP]
> If you are new to k8s, you can stand up a simple cluster using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/): `kind create cluster`.
Demo of basic Gatekeeper functionality.

Expand Down

0 comments on commit a669b9b

Please sign in to comment.