Keeping only index.md

Signed-off-by: gatici <[email protected]>
canonical · Aug 18, 2023 · 26a2ff1 · 26a2ff1
1 parent 459cf35
commit 26a2ff1
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 96 deletions.
diff --git a/docs/explanation/.gitkeep b/docs/explanation/.gitkeep
diff --git a/docs/how-to/.gitkeep b/docs/how-to/.gitkeep
diff --git a/docs/index.md b/docs/index.md
@@ -3,33 +3,41 @@ The Self Signed Certificates Operator provides self-signed X.509 certificates to
 This charm relies on the `tls-certificates` charm relation interface. When a requirer charm inserts a Certificate Signing Request in its unit databag, the `self-signed-certificates-operator` will read it, generate a self-signed X.509 certificates and
 inserts this certificate back into the relation data.
 
-This charm [Self-Signed-Certificates-Operator](https://github.com/canonical/self-signed-certificates-operator) is useful when developing charms or when deploying charms in non-production environment on top of [Juju](https://juju.is/).
+The [Self-Signed-Certificates-Operator](https://github.com/canonical/self-signed-certificates-operator) is useful when developing charms or when deploying charms in non-production environment on top of [Juju](https://juju.is/).
+
+## Usage
+
+To deploy Self Signed X.509 Certificates Operator, all you need to do is run the following command, which will fetch the charm from [Charmhub](https://charmhub.io/self-signed-certificates?channel=edge) and deploy it to your model and relate it with an existing requirer charm:
+
+```shell
+juju deploy self-signed-certificates --channel edge
+juju relate self-signed-certificates <your charm which needs tls certificates>
+```
+
+Juju will now fetch self-signed-certificates operator and begin deploying it to the local MicroK8s. This process can take several minutes depending on how provisioned (RAM, CPU, etc) your machine is. You can track the progress by running:
+```shell
+juju status --watch 1s
+juju status --relations
+```
+
+The Self Signed Certificates Operator works with single replica for the moment and scale up operation is not supported yet.
+
+## License:
+The Self Signed X.509 Certificates Operator [is distributed](https://github.com/canonical/self-signed-certificates-operator/blob/main/LICENSE) under the Apache Software License, version 2.0.
 
 ## Project and community
 The Self Signed Certificates Operator is an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.
 - [Read our Code of Conduct](https://ubuntu.com/community/code-of-conduct)
 - [Join the Discourse forum](https://discourse.charmhub.io/tag/self-signed-certificates)
 - Contribute and report bugs to [Self-Signed-Certificates-Operator](https://github.com/canonical/self-signed-certificates-operator)
 
-## In this documentation
-|                                                                                                                                                                                         |                                                                                                                                                      |
-|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [Tutorial](/t/self-signed-x-509-certificates-tutorial-overview/11600?channel=edge) </br>  Get started - a hands-on introduction to using Self Signed X.509 Certificates for new users </br> | [How-to guides]() </br> Step-by-step guides covering key operations and common tasks    |
-| [Reference](https://charmhub.io/self-signed-certificates/actions?channel=edge) </br> Technical information - specifications, APIs, architecture                                         | [Explanation]() </br> Concepts - discussion and clarification of key topics |
-
 # Navigation
 
 | Level | Path                      | Navlink                                                                                                  |
 | ----- |---------------------------|----------------------------------------------------------------------------------------------------------|
-| 1 | tutorial                  | [Tutorial]()                                                                                             |
-| 2 | t-overview                | [1. Introduction](/t/self-signed-x-509-certificates-tutorial-overview/11600)                             |
-| 2 | t-deploy                  | [3. Deploy Self Signed Certificates Operator](/t/self-signed-x-509-certificates-tutorial-overview/11600) |
-| 2 | t-get-signed-certificates | [4. Get Signed Certificates](https://charmhub.io/self-signed-certificates/actions?channel=edge)          |
-| 1 | how-to                    | [How To]()                                                                                               |
 | 1 | reference                 | [Reference]()                                                                                            |
 | 2 | r-actions                 | [Actions](https://charmhub.io/self-signed-certificates/actions?channel=edge)                             |
 | 2 | r-configurations          | [Configurations](https://charmhub.io/self-signed-certificates/configure?channel=edge)                    |
 | 2 | r-libraries               | [Libraries](https://charmhub.io/self-signed-certificates/libraries?channel=edge)                         |
 | 2 | r-integrations            | [Integrations](https://charmhub.io/self-signed-certificates/integrations?channel=edge)                   |
-| 1 | explanation               | [Explanation]()                                                                                          |
 
diff --git a/docs/reference/.gitkeep b/docs/reference/.gitkeep
diff --git a/docs/tutorial/t-overview.md b/docs/tutorial/t-overview.md