Skip to content

Commit ed23c25

Browse files
committed
chore: small markdown tweaks
1 parent 89efd17 commit ed23c25

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

docs/main/03-reference/13-destinations/01-destinations.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ a system that Kratix can write documents to. These documents are then
1010
reconciled by an external tool.
1111

1212
Some example use cases:
13+
1314
- [Kubernetes cluster](https://kubernetes.io/): Kratix will scheduled documents (Kubernetes manifests) to
1415
the Destination, and then a GitOps tool running on the Kubernetes cluster,
1516
such as Flux or ArgoCD with pull down the documents and deploy them. See our
1617
[GitOps Agent documentation](/category/installing-gitops-agent) for more information.
17-
- [Terraform](https://www.terraform.io/): There are many toolings that exist to trigger Terraform applys
18+
- [Terraform](https://www.terraform.io/): There are many toolings that exist to trigger a `teraform apply`
1819
when a new Terraform file is committed to a Git repository. For example
1920
[Terraform
2021
Enterprise](https://www.hashicorp.com/resources/gitops-and-terraform-enterprise-a-match-made-in-heaven-at-state-farm)
@@ -25,8 +26,8 @@ Some example use cases:
2526
filled from a Git
2627
repository](https://backstage.io/docs/integrations/github/discovery).
2728

28-
2929
Below is the full Spec for the Destination CRD:
30+
3031
```yaml
3132
apiVersion: platform.kratix.io/v1alpha1
3233
kind: Destination
@@ -79,7 +80,7 @@ one for `resources`, one for `dependencies`. The path within the `State Store` f
7980

8081
For `dependencies`:
8182

82-
```
83+
```yaml
8384
statestore.Spec.Path/
8485
destination.Spec.Path/
8586
destination.Name/
@@ -89,7 +90,7 @@ statestore.Spec.Path/
8990

9091
For `resources`:
9192

92-
```
93+
```yaml
9394
statestore.Spec.Path/
9495
destination.Spec.Path/
9596
destination.Name/
@@ -101,7 +102,7 @@ statestore.Spec.Path/
101102

102103
For example installing and requesting from a Promise that provides `Redis` as a service you would get:
103104

104-
```
105+
```bash
105106
worker-cluster/dependencies/redis/static/dependencies.yaml
106107
worker-cluster/resources/default/redis/my-request/redis.yaml
107108
```

docs/main/03-reference/15-resources/04-status.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ iam:
150150
```
151151

152152
The end status would be:
153+
153154
```yaml
154155
status:
155156
conditions:
@@ -209,7 +210,7 @@ Configure workflow has completed. `kubectl` also has built-in support for waitin
209210
condition to be met. For example, after requesting a Resource, a user can run the
210211
following to have the CLI wait for the Workflow to be completed:
211212

212-
```
213+
```bash
213214
kubectl wait redis/example --for=condition=ConfigureWorkflowCompleted --timeout=60s
214215
```
215216

docs/ske/60-ske-cli/01-reference/04_ske-upgrade.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Upgrade SKE to the next minor at the latest patch
44

55
## Description
6-
```
6+
7+
```bash
78
> ske upgrade
89

910
Upgrading SKE from v0.9.0 to v0.10.0...
@@ -29,21 +30,20 @@ Upgrade successful!
2930
```
3031

3132
## Usage
32-
```
33+
34+
```bash
3335
ske upgrade [--context] [flags]
3436
```
3537

36-
3738
## Flags
38-
```
39+
40+
```bash
3941
--dry-run Dry run the upgrade
4042
-h, --help help for upgrade
4143
--skip-all-checks Skipping all pre- and post-upgrade checks; use with caution
4244
--timeout duration Timeout for the upgrade (default 5m0s)
4345
```
4446

45-
4647
## See Also
4748

4849
* [ske](/ske/ske-cli/reference/ske): The ske CLI
49-

0 commit comments

Comments
 (0)