suggestions for review

canonical · Nov 29, 2024 · 0cf3168 · 0cf3168
1 parent a37dafb
commit 0cf3168
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/charm/docs/tutorial/getting-started.md b/charm/docs/tutorial/getting-started.md
@@ -103,7 +103,7 @@ Once the s3-integrator charm has been deployed, integrate the charm with NetBox:
 juju integrate s3-integrator netbox
 ```
 
-See the [s3-integrator charmhub page](https://charmhub.io/s3-integrator) for more information.
+See the [s3-integrator Charmhub page](https://charmhub.io/s3-integrator) for more information.
 
 ### Deploy the traefik-k8s charm
 
@@ -138,3 +138,12 @@ juju run netbox/0 create-superuser username=admin [email protected]
 
 Congratulations, With the username created and the password provided in the response,
 you have now full access to your own NetBox!
+
+# Clean up the Environment
+
+Well done! You’ve successfully completed the NetBox tutorial. To remove the
+model environment you created during this tutorial, use the following command.
+
+```bash
+juju destroy-model netbox-tutorial
+```
diff --git a/charm/src-docs/tutorial/code/getting-started/task.yaml b/charm/src-docs/tutorial/code/getting-started/task.yaml
@@ -100,3 +100,8 @@ execute: |
 
   # just test that we can get a token with the admin user.
   curl -H "Accept: application/json" -H "Content-Type: application/json" --fail "${NETBOX_URL}/api/users/tokens/provision/" -X POST -d "{\"username\": \"admin\", \"password\": \"${PASSWORD}\"}"
+
+  # [docs:juju-destroy-model]
+  juju destroy-model netbox-tutorial
+  # [docs:juju-destroy-model-end]
+  
diff --git a/charm/src-docs/tutorial/getting-started.md b/charm/src-docs/tutorial/getting-started.md
@@ -122,7 +122,7 @@ Once the s3-integrator charm has been deployed, integrate the charm with NetBox:
 :dedent: 2
 ```
 
-See the [s3-integrator charmhub page](https://charmhub.io/s3-integrator) for more information.
+See the [s3-integrator Charmhub page](https://charmhub.io/s3-integrator) for more information.
 
 ### Deploy the traefik-k8s charm
 
@@ -159,3 +159,14 @@ To be able to log in to NetBox, you can create a super user with the next comman
 Congratulations, With the username created and the password provided in the response, 
 you have now full access to your own NetBox!
 
+# Clean up the Environment
+
+Well done! You've successfully completed the NetBox tutorial. To remove the
+model environment you created during this tutorial, use the following command.
+
+```{literalinclude} code/getting-started/task.yaml
+:language: bash
+:start-after: [docs:juju-destroy-model]
+:end-before: [docs:juju-destroy-model-end]
+:dedent: 2
+```