[feat] Add links for all SD-Core charms

canonical · Sep 22, 2023 · f606775 · f606775
1 parent 6b8012d
commit f606775
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 30 deletions.
diff --git a/docs/reference/charms.md b/docs/reference/charms.md
@@ -0,0 +1,16 @@
+# Charms
+
+Each charm has its own source code repository and CharmHub page. Configuration options and specific charm usage instructions are available on the CharmHub page.
+
+| Charm         | Reference                                                                                                                                                   | 
+|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| SD-Core AMF   | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-amf-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-amf>`     | 
+| SD-Core AUSF  | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-ausf-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-ausf>`   | 
+| SD-Core NRF   | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-nrf-operator>`  {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-nrf>`    |
+| SD-Core NSSF  | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-nssf-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-nssf>`   |
+| SD-Core PCF   | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-pcf-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-pcf>`     |
+| SD-Core SMF   | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-smf-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-smf>`     |
+| SD-Core UDM   | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-udm-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-udm>`     | 
+| SD-Core UDR   | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-udr-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-udr>`     | 
+| SD-Core UPF   | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-upf-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-upf>`     | 
+| SD-Core Webui | {bdg-link-primary-line}`GitHub  <https://github.com/canonical/sdcore-webui-operator>` {bdg-link-primary-line}`CharmHub  <https://charmhub.io/sdcore-webui>` | 
diff --git a/docs/reference/deployment_options.md b/docs/reference/deployment_options.md
@@ -0,0 +1,32 @@
+# SD-Core deployment options
+
+`````{tab-set}
+    
+````{tab-item} Single site deployment
+
+Use the `sdcore` bundle to deploy a standalone 5G core network.
+This bundle contains the 5G control plane functions, the UPF, Webui, Grafana Agent, Self Signed 
+Certificates and MongoDB.
+
+```{image} ../images/sdcore_single_site.png
+:alt: Single site deployment
+:height: 600
+:align: center
+```
+
+````
+
+````{tab-item} Edge deployment
+
+Use the `sdcore-control-plane` to deploy the 5G control plane in a central place and the 
+`sdcore-user-plane` bundle to deploy the 5G user plane in edge sites.
+
+```{image} ../images/sdcore_edge.png
+:alt: Edge deployment
+:height: 600
+:align: center
+```
+
+````
+
+`````
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -1,34 +1,8 @@
 # Reference
 
-## SD-Core deployment options
+```{toctree}
+:maxdepth: 1
 
-`````{tab-set}
-    
-````{tab-item} Single site deployment
-
-Use the `sdcore` bundle to deploy a standalone 5G core network.
-This bundle contains the 5G control plane functions, the UPF, Webui, Grafana Agent, Self Signed 
-Certificates and MongoDB.
-
-```{image} ../images/sdcore_single_site.png
-:alt: Single site deployment
-:height: 600
-:align: center
+charms
+deployment_options
 ```
-
-````
-
-````{tab-item} Edge deployment
-
-Use the `sdcore-control-plane` to deploy the 5G control plane in a central place and the 
-`sdcore-user-plane` bundle to deploy the 5G user plane in edge sites.
-
-```{image} ../images/sdcore_edge.png
-:alt: Edge deployment
-:height: 600
-:align: center
-```
-
-````
-
-`````