Browse Source

add missing commands to the getting started guide (#2751)

* add missing commands to the getting started guide

Update "Create your first SecretStore" and "Create your first ExternalSecret" topics to be easy to understand

Signed-off-by: Nícolas Roberto <66215835+Nicolas-Roberto@users.noreply.github.com>
Signed-off-by: nicolas.queiroz <nicolas.roberto987@gmail.com>

* change nano command to echo command

Signed-off-by: Nícolas Roberto <66215835+Nicolas-Roberto@users.noreply.github.com>
Signed-off-by: nicolas.queiroz <nicolas.roberto987@gmail.com>

* fix changes in getting started file

Signed-off-by: nicolas.queiroz <nicolas.roberto987@gmail.com>

---------

Signed-off-by: Nícolas Roberto <66215835+Nicolas-Roberto@users.noreply.github.com>
Signed-off-by: nicolas.queiroz <nicolas.roberto987@gmail.com>
Signed-off-by: Shuhei Kitagawa <shuheiktgw@users.noreply.github.com>
Co-authored-by: Shuhei Kitagawa <shuheiktgw@users.noreply.github.com>
Nícolas Roberto 2 years ago
parent
commit
8a60df68f7
1 changed files with 21 additions and 5 deletions
  1. 21 5
      docs/introduction/getting-started.md

+ 21 - 5
docs/introduction/getting-started.md

@@ -15,7 +15,7 @@ Uncomment the relevant line in the next steps to disable the automatic install o
 
 
 ### Option 1: Install from chart repository
 ### Option 1: Install from chart repository
 
 
-``` bash
+```bash
 helm repo add external-secrets https://charts.external-secrets.io
 helm repo add external-secrets https://charts.external-secrets.io
 
 
 helm install external-secrets \
 helm install external-secrets \
@@ -29,7 +29,7 @@ helm install external-secrets \
 
 
 Build and install the Helm chart locally after cloning the repository.
 Build and install the Helm chart locally after cloning the repository.
 
 
-``` bash
+```bash
 make helm.build
 make helm.build
 
 
 helm install external-secrets \
 helm install external-secrets \
@@ -49,17 +49,33 @@ kubectl create secret generic awssm-secret --from-file=./access-key --from-file=
 
 
 ### Create your first SecretStore
 ### Create your first SecretStore
 
 
-``` yaml
+Create a file 'basic-secret-store.yaml' with the following content.
+
+```yaml
 {% include 'basic-secret-store.yaml' %}
 {% include 'basic-secret-store.yaml' %}
 ```
 ```
 
 
+Apply it to create a SecretStore resource.
+
+```
+kubectl apply -f "basic-secret-store.yaml"
+```
+
 ### Create your first ExternalSecret
 ### Create your first ExternalSecret
 
 
-``` yaml
+Create a file 'basic-external-secret.yaml' with the following content.
+
+```yaml
 {% include 'basic-external-secret.yaml' %}
 {% include 'basic-external-secret.yaml' %}
 ```
 ```
 
 
-``` bash
+Apply it to create an External Secret resource.
+
+```
+kubectl apply -f "basic-external-secret.yaml"
+```
+
+```bash
 kubectl describe externalsecret example
 kubectl describe externalsecret example
 # [...]
 # [...]
 Name:  example
 Name:  example