ISD-2543 - Update README (#246)

* Update README * Update README * Address review comments * Fix CI issues * Remove some CVEs * Add CVEs back * Update README.md Co-authored-by: Ali UĞUR <[email protected]> --------- Co-authored-by: Ali UĞUR <[email protected]>
canonical · Dec 4, 2024 · 7b93a33 · 7b93a33
1 parent d1e3dfb
commit 7b93a33
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 9 deletions.
diff --git a/.trivyignore b/.trivyignore
@@ -1,8 +1,17 @@
-# openstack-objectstorage-k8s (https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/openstack-objectstorage-k8s)
+CVE-2022-24775
 CVE-2022-29248
-CVE-2022-31042
+CVE-2022-31042 
 CVE-2022-31043
 CVE-2022-31090
 CVE-2022-31091
-CVE-2022-24775
+CVE-2023-24539
+CVE-2023-24540
 CVE-2023-29197
+CVE-2023-29400
+CVE-2023-29403
+CVE-2023-39325
+CVE-2023-45283
+CVE-2023-45287
+CVE-2023-45288
+CVE-2024-24790
+CVE-2024-34156
diff --git 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, 
@@ -21,14 +21,46 @@ For DevOps or SRE teams this charm will make operating WordPress simple and stra
 It will allow easy deployment into multiple environments for testing of changes, 
 and supports scaling out for enterprise deployments.
 
+For information about how to deploy, integrate, and manage this charm, see the Official [wordpress-k8s-operator Documentation](https://charmhub.io/wordpress-k8s/docs).
+
+## Get Started
+
+To begin, refer to the [Getting Started](https://charmhub.io/wordpress-k8s/docs/tutorial) tutorial for step-by-step instructions.
+
+### Basic Operations
+
+The following actions are available for the charm:
+- get-initial-password
+- rotate-wordpress-secrets
+
+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:
+
+```
+juju deploy mysql-k8s --trust
+# 'database' interface is required since mysql-k8s charm provides multiple compatible interfaces
+juju integrate wordpress-k8s mysql-k8s:database
+```
+
+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
 
 The WordPress Operator is a member of the Ubuntu family. 
 It's an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.
 
-* [Code of conduct](https://ubuntu.com/community/code-of-conduct)
-* [Get support](https://discourse.charmhub.io/)
-* [Join our online chat](https://chat.charmhub.io/charmhub/channels/charm-dev)
-* [Contribute](https://charmhub.io/wordpress-k8s/docs/contributing-hacking)
+- [Code of conduct](https://ubuntu.com/community/code-of-conduct)
+- [Get support](https://discourse.charmhub.io/)
+- [Contribute](https://charmhub.io/wordpress-k8s/docs/how-to-contribute)
+- [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
 
-Thinking about using the WordPress Operator for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!
diff --git a/tox.ini b/tox.ini
@@ -110,6 +110,7 @@ commands =
 [testenv:integration]
 description = Run integration tests
 deps =
+    websockets<14.0 
     -r{toxinidir}/requirements.txt
     -r{toxinidir}/tests/integration/requirements.txt
 commands =