From f671b95a6fae23ab52fa74abd0e53899adccf889 Mon Sep 17 00:00:00 2001 From: Swetha Swaminathan Date: Thu, 28 Nov 2024 22:09:52 +0530 Subject: [PATCH] Address review comments --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 228f457f..c0d32fad 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing WordPress on Kubernetes. [WordPress](https://wordpress.com) is the world's most popular website builder, and it's free and open-source. -This charm simplifies initial deployment and "day N" operations of WordPress on Kubernetes, +This charm simplifies the deployment and operations of WordPress on Kubernetes, including scaling the number of instances, integration with SSO, access to OpenStack Swift object storage for redundant file storage and more. It allows for deployment on many different Kubernetes platforms, @@ -29,15 +29,15 @@ To begin, refer to the [Getting Started](https://charmhub.io/wordpress-k8s/docs/ ### Basic Operations -The following actions are available for the charm - +The following actions are available for the charm: - get-initial-password - rotate-wordpress-secrets -You can find more information on this [here](https://charmhub.io/wordpress-k8s/actions) +You can find more information about supported actions in [the Charmhub documentation](https://charmhub.io/wordpress-k8s/actions). ## Integrations -Deployment of WordPress requires a relational database. The integration with the mysql interface is required by the wordpress-k8s charm for which `mysql-k8s` charm can be deployed as follows - +Deployment of WordPress requires a relational database. The integration with the mysql interface is required by the wordpress-k8s charm for which `mysql-k8s` charm can be deployed as follows: ``` juju deploy mysql-k8s --trust @@ -45,12 +45,14 @@ juju deploy mysql-k8s --trust juju integrate wordpress-k8s mysql-k8s:database ``` -Apart from this, the charm can be integrated with other Juju charms and services as well. You can find the full list of integrations [here](https://charmhub.io/wordpress-k8s/integrations) +Apart from this required integration, the charm can be integrated with other Juju charms and services as well. You can find the full list of integrations in [the Charmhub documentation](https://charmhub.io/wordpress-k8s/integrations). ## Learn more - [Read more](https://charmhub.io/wordpress-k8s/docs) +- [Developer documentation](https://codex.wordpress.org/Developer_Documentation) - [Official webpage](https://wordpress.com) +- [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) ## Project and community