Standardise how-to guides and reference pages (#291)

* Update how-to pages in index.md (ISD-2296)

Follow convention set in style guide

* Include link to Juju docs in actions.md (ISD-2302)

* Include link to Juju docs in configurations.md (ISD-2302)

* Update integrations.md (ISD-2316)

Put "Interface" and "Supported charms" on two different lines
Put commands into code blocks

* Add blank line 

For consistency between actions.md and configurations.md

docs/index.md

@@ -36,15 +36,15 @@ fixes and constructive feedback.
 1. [Explanation](explanation)
   1. [Charm architecture](explanation/charm-architecture.md)
 1. [How To](how-to)
-  1. [How to access the Rails console](how-to/access--the-rails-console.md)
-  1. [How to configure the container](how-to/configure-container.md)
-  1. [How to configure the hostname](how-to/configure-hostname.md)
-  1. [How to configure S3](how-to/configure-s3.md)
-  1. [How to configure SAML](how-to/configure-saml.md)
-  1. [How to configure SMTP](how-to/configure-smtp.md)
-  1. [How to contribute](how-to/contribute.md)
-  1. [How to upgrade](how-to/upgrade.md)
-  1. [How to backup and restore](how-to/backup-and-restore.md)
+  1. [Access the Rails console](how-to/access--the-rails-console.md)
+  1. [Configure the container](how-to/configure-container.md)
+  1. [Configure the hostname](how-to/configure-hostname.md)
+  1. [Configure S3](how-to/configure-s3.md)
+  1. [Configure SAML](how-to/configure-saml.md)
+  1. [Configure SMTP](how-to/configure-smtp.md)
+  1. [Contribute](how-to/contribute.md)
+  1. [Upgrade](how-to/upgrade.md)
+  1. [Backup and restore](how-to/backup-and-restore.md)
 1. [Reference](reference)
   1. [Actions](reference/actions.md)
   1. [Configurations](reference/configurations.md)

docs/reference/actions.md

@@ -1,3 +1,5 @@
 # Actions
 
-See [Actions](https://charmhub.io/discourse-k8s/actions).
+See [Actions](https://charmhub.io/discourse-k8s/actions).
+
+> Read more about actions in the Juju docs: [Action](https://juju.is/docs/juju/action)

docs/reference/configurations.md

@@ -1,3 +1,5 @@
 # Configurations
 
-See [Configure](https://charmhub.io/discourse-k8s/configure).
+See [Configurations](https://charmhub.io/discourse-k8s/configure).
+
+> Read more about configurations in the Juju docs: [Configuration](https://juju.is/docs/juju/configuration)

docs/reference/integrations.md

@@ -3,17 +3,22 @@
 ### db
 
 _Interface_: pgsql
+
 _Supported charms_: [postgresql-k8s](https://charmhub.io/postgresql-k8s),
 [postgresql](https://charmhub.io/postgresql)
 
 Database integration is a required relation for the Discourse charm to supply
 structured data storage for Discourse.
 
-Database integrate command: `juju integrate discourse-k8s postgresql-k8s`
+Database integrate command: 
+```
+juju integrate discourse-k8s postgresql-k8s
+```
 
 ### grafana-dashboard
 
 _Interface_: grafana-dashboard
+
 _Supported charms_: [grafana-k8s](https://charmhub.io/grafana-k8s)
 
 Grafana-dashboard relation enables quick dashboard access already tailored to
@@ -35,6 +40,7 @@ juju integrate discourse-k8s grafana-dashboard`
 ### ingress
 
 _Interface_: ingress
+
 _Supported charms_: [nginx-ingress-integrator](https://charmhub.io/nginx-ingress-integrator),
 [traefik](https://charmhub.io/traefik-k8s)
 
@@ -43,24 +49,35 @@ Note that the kubernetes cluster must already have an nginx ingress controller
 already deployed. Documentation to enable ingress in MicroK8s can be found in
 [Addon: Ingress](https://microk8s.io/docs/addon-ingress).
 
-Ingress integrate command: `juju integrate discourse-k8s nginx-ingress-integrator`
+Ingress integrate command: 
+```
+juju integrate discourse-k8s nginx-ingress-integrator
+```
 
 ### metrics-endpoint
 
 _Interface_: [prometheus_scrape](https://charmhub.io/interfaces/prometheus_scrape-v0)
+
 _Supported charms_: [prometheus-k8s](https://charmhub.io/prometheus-k8s)
 
 Metrics-endpoint relation allows scraping the `/metrics` endpoint provided by Discourse.
 The metrics are exposed in the [open metrics format](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#data-model) and will only be scraped by Prometheus once the
 relation becomes active. For more information about the metrics exposed, refer to ["How to monitor Discourse metrics using Prometheus"](https://meta.discourse.org/t/discourse-prometheus/72666).
 
-Metrics-endpoint integrate command: `juju integrate discourse-k8s prometheus-k8s`
+Metrics-endpoint integrate command: 
+```
+juju integrate discourse-k8s prometheus-k8s
+```
 
 ### redis
 
 _Interface_: redis  
+
 _Supported charms_: [redis-k8s](https://charmhub.io/redis-k8s)
 
 Discourse uses Redis to run background tasks (with Sidekiq) and keep the application fast and responsive. It enables real-time updates on the pages and helps in managing data efficiently. Redis also helps Discourse in balancing loads by managing rate limits, making it a crucial part of its system.
 
-Redis integrate commands: `juju integrate discourse-k8s redis-k8s`
+Redis integrate commands: 
+```
+juju integrate discourse-k8s redis-k8s
+```