wordpress-charmers team mailing list archive

[Tom Haddon <tom.haddon@xxxxxxxxxxxxx>]

Tom Haddon has proposed merging ~mthaddon/charm-k8s-wordpress/+git/charm-k8s-wordpress:readme-formatting into charm-k8s-wordpress:master.

Commit message:
Update formatting of README for better display on jaas.ai

Requested reviews:
  Wordpress Charmers (wordpress-charmers)

For more details, see:
https://code.launchpad.net/~mthaddon/charm-k8s-wordpress/+git/charm-k8s-wordpress/+merge/381989

Update formatting of README for better display on jaas.ai
-- 
Your team Wordpress Charmers is requested to review the proposed merge of ~mthaddon/charm-k8s-wordpress/+git/charm-k8s-wordpress:readme-formatting into charm-k8s-wordpress:master.

diff --git a/README.md b/README.md
index e5bb693..7361f8e 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-= Wordpress k8s charm =
+# Wordpress k8s charm
 
 A Juju charm for a Kubernetes deployment of Wordpress, using the
 official Dockerhub Wordpress image or image built from this base.
 
-== Overview ==
+## Overview
 
 This is a k8s charm and can only be deployed to to a Juju k8s cloud,
-attached to a controller using 'juju add-k8s'.
+attached to a controller using `juju add-k8s`.
 
-The image to spin up is specified in the 'image' charm configuration
+The image to spin up is specified in the `image` charm configuration
 option using standard docker notation (eg. 'localhost:32000/mywork-rev42').
 Images must be publicly accessible. Default is the Dockerhub
 `wordpress:php7.3` image.
@@ -23,16 +23,16 @@ In particular:
    as those providing monitoring or metrics endpoints.
 
 Additional runtine configuration is specified as YAML snippets in the charm config.
-Both 'container_config' and 'container_secrets' items are provided,
-and they are combined together. 'container_config' gets logged,
-'container_secrets' does not. This allows you to configure customized
+Both `container_config` and `container_secrets` items are provided,
+and they are combined together. `container_config` gets logged,
+`container_secrets` does not. This allows you to configure customized
 Wordpress images.
 
-== Details ==
+## Details
 
 See config option descriptions in config.yaml.
 
-== Quickstart ==
+## Quickstart
 
 Notes for deploying a test setup locally using microk8s: