From a8f2b46d0514187e4195e5e3ff79fab616791d7a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 25 Oct 2023 11:44:31 +0200 Subject: [PATCH] modified: docs/how-to/contribute.md,docs/reference/actions.md,docs/explanation/oci-image.md,docs/reference/integrations.md,docs/reference/configurations.md,docs/reference/plugins.md,docs/how-to/enable-waf.md,docs/reference/themes.md,docs/how-to/install-plugins.md,docs/how-to/integrate-with-cos.md,docs/explanation/overview.md,docs/how-to/enable-antispam.md,docs/how-to/install-themes.md,docs/how-to/configure-hostname.md,docs/explanation/containers.md,docs/explanation/lifecycle-events.md,docs/tutorial/getting-started.md,docs/how-to/configure-initial-settings.md,docs/explanation/relations.md,docs/how-to/configure-object-storage.md,docs/how-to/retrieve-initial-credentials.md,docs/how-to/rotate-secrets.md,docs/index.md (#144) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Varshi Gupta Co-authored-by: arturo-seijas <102022572+arturo-seijas@users.noreply.github.com> --- docs/explanation/containers.md | 2 +- docs/explanation/lifecycle-events.md | 2 +- docs/explanation/oci-image.md | 2 +- docs/explanation/overview.md | 2 +- docs/explanation/relations.md | 2 +- docs/how-to/configure-hostname.md | 2 +- docs/how-to/configure-initial-settings.md | 2 +- docs/how-to/configure-object-storage.md | 2 +- docs/how-to/contribute.md | 2 +- docs/how-to/enable-antispam.md | 2 +- docs/how-to/enable-waf.md | 2 +- docs/how-to/install-plugins.md | 2 +- docs/how-to/install-themes.md | 2 +- docs/how-to/integrate-with-cos.md | 2 +- docs/how-to/retrieve-initial-credentials.md | 2 +- docs/how-to/rotate-secrets.md | 2 +- docs/index.md | 26 +++++++++---------- docs/reference/actions.md | 2 +- docs/reference/configurations.md | 2 +- docs/reference/integrations.md | 2 +- docs/reference/plugins.md | 2 +- docs/reference/themes.md | 2 +- .../getting-started.md => tutorial.md} | 2 +- 23 files changed, 34 insertions(+), 36 deletions(-) rename docs/{tutorial/getting-started.md => tutorial.md} (99%) diff --git a/docs/explanation/containers.md b/docs/explanation/containers.md index c6eea7b4..03d83f0f 100644 --- a/docs/explanation/containers.md +++ b/docs/explanation/containers.md @@ -47,4 +47,4 @@ Golang client are exposed that are not part of the WordPress Apache’s metrics This container is the main point of contact with the juju controller. It communicates with juju to run necessary charm code defined by the main `src/charm.py`. The source code is copied to the -`/var/lib/juju/agents/unit-UNIT_NAME/charm` directory. +`/var/lib/juju/agents/unit-UNIT_NAME/charm` directory. \ No newline at end of file diff --git a/docs/explanation/lifecycle-events.md b/docs/explanation/lifecycle-events.md index f5cb8f44..20eded6f 100644 --- a/docs/explanation/lifecycle-events.md +++ b/docs/explanation/lifecycle-events.md @@ -55,4 +55,4 @@ installed themes and plugins with the incoming list of themes and plugins. ### upgrade-charm Upgrade charm event is fired on the upgrade charm command `juju refresh wordpress-k8s`. Sets up -secrets in peer-relation databag for upgraded deployment of WordPress if not already set. +secrets in peer-relation databag for upgraded deployment of WordPress if not already set. \ No newline at end of file diff --git a/docs/explanation/oci-image.md b/docs/explanation/oci-image.md index 48b37897..098a17e5 100644 --- a/docs/explanation/oci-image.md +++ b/docs/explanation/oci-image.md @@ -24,4 +24,4 @@ the latest stable version by default, downloaded from the source. This is the image required for sidecar container apache-prometheus-exporter. Openly available image `bitnami/apache-exporter` is used. Read more about the image from the official Docker Hub -[source](https://hub.docker.com/r/bitnami/apache-exporter/). +[source](https://hub.docker.com/r/bitnami/apache-exporter/). \ No newline at end of file diff --git a/docs/explanation/overview.md b/docs/explanation/overview.md index 97461ab5..f42c16f0 100644 --- a/docs/explanation/overview.md +++ b/docs/explanation/overview.md @@ -4,4 +4,4 @@ The wordpress-k8s charm aims to provide core functionalities of WordPress with h scalable architecture, leveraging its flexible capabilities enhanced by plugins. Operational capabilities are enhanced through integration with the Canonical Observability Stack ([COS](https://charmhub.io/topics/canonical-observability-stack/)) -charms. +charms. \ No newline at end of file diff --git a/docs/explanation/relations.md b/docs/explanation/relations.md index 5e139d56..a82abd14 100644 --- a/docs/explanation/relations.md +++ b/docs/explanation/relations.md @@ -45,4 +45,4 @@ Grafana-dashboard is a part of the COS integration to enhance observability. Thi a pre-made dashboard used for monitoring Apache server hosting WordPress. The wordpress-k8s charm satisfies the `grafana_dashboard` interface by providing the pre-made dashboard template to the Grafana relation data bag under the "dashboards" key. Requires Prometheus datasource to be already -integrated with Grafana. +integrated with Grafana. \ No newline at end of file diff --git a/docs/how-to/configure-hostname.md b/docs/how-to/configure-hostname.md index a8c404fe..a95e1259 100644 --- a/docs/how-to/configure-hostname.md +++ b/docs/how-to/configure-hostname.md @@ -42,4 +42,4 @@ Test the ingress by sending a GET request to the service with `Host` headers. ``` curl -H "Host: " http:// -``` +``` \ No newline at end of file diff --git a/docs/how-to/configure-initial-settings.md b/docs/how-to/configure-initial-settings.md index 247292fe..242eb01b 100644 --- a/docs/how-to/configure-initial-settings.md +++ b/docs/how-to/configure-initial-settings.md @@ -22,4 +22,4 @@ WordPress(`http:///wp-admin/options-general.php`). You can also pass in the wordpress-k8s `configuration.yaml` file with the parameters above. See how to pass in a configuration file in the -[juju documentation](https://juju.is/docs/olm/manage-applications#heading--configure-an-application-during-deployment). +[juju documentation](https://juju.is/docs/olm/manage-applications#heading--configure-an-application-during-deployment). \ No newline at end of file diff --git a/docs/how-to/configure-object-storage.md b/docs/how-to/configure-object-storage.md index d2c3a7d4..ccfec4a2 100644 --- a/docs/how-to/configure-object-storage.md +++ b/docs/how-to/configure-object-storage.md @@ -61,4 +61,4 @@ You can then configure wordpress-k8s charm using the yaml contents above. ``` juju config wordpress-k8s wp_plugin_openstack-objectstorage_config="$(cat )" -``` +``` \ No newline at end of file diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md index eede8abd..78d8e3d6 100644 --- a/docs/how-to/contribute.md +++ b/docs/how-to/contribute.md @@ -83,4 +83,4 @@ The following commands can then be used to run the tests: Canonical welcomes contributions to the WordPress Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing -to the solution. +to the solution. \ No newline at end of file diff --git a/docs/how-to/enable-antispam.md b/docs/how-to/enable-antispam.md index f3f7e68b..337e2e4d 100644 --- a/docs/how-to/enable-antispam.md +++ b/docs/how-to/enable-antispam.md @@ -11,4 +11,4 @@ enable Akismet plugin. juju config wordpress-k8s wp_plugin_akismet_key= ``` -The Akismet plugin should automatically be active after running the configuration. +The Akismet plugin should automatically be active after running the configuration. \ No newline at end of file diff --git a/docs/how-to/enable-waf.md b/docs/how-to/enable-waf.md index fa666d78..d3f38a01 100644 --- a/docs/how-to/enable-waf.md +++ b/docs/how-to/enable-waf.md @@ -47,4 +47,4 @@ Annotations: nginx.ingress.kubernetes.io/enable-modsecurity: true Events: ``` -Note the `nginx.ingress.kubernetes.io/enable-modsecurity: true` annotation. +Note the `nginx.ingress.kubernetes.io/enable-modsecurity: true` annotation. \ No newline at end of file diff --git a/docs/how-to/install-plugins.md b/docs/how-to/install-plugins.md index 0f2c694d..a29e342d 100644 --- a/docs/how-to/install-plugins.md +++ b/docs/how-to/install-plugins.md @@ -17,4 +17,4 @@ juju config wordpress-k8s plugins=, ``` Once the configuration is complete, you can navigate to `http:///wp-admin/plugins.php` to -verify your new plugin installation. +verify your new plugin installation. \ No newline at end of file diff --git a/docs/how-to/install-themes.md b/docs/how-to/install-themes.md index a9c67843..d7f0a644 100644 --- a/docs/how-to/install-themes.md +++ b/docs/how-to/install-themes.md @@ -16,4 +16,4 @@ juju config wordpress-k8s themes=, ``` Once the configuration is complete, you can navigate to `http:///wp-admin/themes.php` to -verify your new theme installation. +verify your new theme installation. \ No newline at end of file diff --git a/docs/how-to/integrate-with-cos.md b/docs/how-to/integrate-with-cos.md index 0d7c6f32..4f4e872c 100644 --- a/docs/how-to/integrate-with-cos.md +++ b/docs/how-to/integrate-with-cos.md @@ -53,4 +53,4 @@ juju run-action grafana-k8s/0 get-admin-password --wait You can now log into the grafana dashboard by visiting `http://:3000`. Navigate to `http://:3000/dashboards` and access the WordPress dashboard named Wordpress Operator -Overview. +Overview. \ No newline at end of file diff --git a/docs/how-to/retrieve-initial-credentials.md b/docs/how-to/retrieve-initial-credentials.md index 0003ac96..17adc753 100644 --- a/docs/how-to/retrieve-initial-credentials.md +++ b/docs/how-to/retrieve-initial-credentials.md @@ -21,4 +21,4 @@ unit-wordpress-k8s-0: You can use the password to login to the admin account in `http:///wp-admin.php`. Note that if `admin_password` value has been passed in the `initial_settings` configuration, the -password from the action is invalid. +password from the action is invalid. \ No newline at end of file diff --git a/docs/how-to/rotate-secrets.md b/docs/how-to/rotate-secrets.md index 9efb6064..7ef0b630 100644 --- a/docs/how-to/rotate-secrets.md +++ b/docs/how-to/rotate-secrets.md @@ -6,4 +6,4 @@ To securely update all the WordPress secrets, run the following action. juju run-action wordpress-k8s/0 rotate-wordpress-secrets –wait ``` -This action will force users to be logged out. All sessions and cookies will be invalidated. +This action will force users to be logged out. All sessions and cookies will be invalidated. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 35a4cbad..7f618237 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,22 +1,27 @@ -# WordPress Operator +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. -A Juju charm 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, 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, from [MicroK8s](https://microk8s.io/) to [Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes offerings. -This charm simplifies initial deployment and "day N" 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, from [MicroK8s](https://microk8s.io/) to [Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes offerings. +As such, the charm makes it easy for those looking to take control of their own content management system whilst keeping operations simple and gives them the freedom to deploy on the Kubernetes platform of their choice. -As such, the charm makes it easy for those looking to take control of their own content management system whilst keeping operations simple, and gives them the freedom to deploy on the Kubernetes platform of their choice. +This charm will make operating WordPress simple and straightforward for DevOps or SRE teams through Juju's clean interface. It will allow easy deployment into multiple environments to test changes and support scaling out for enterprise deployments. -For DevOps or SRE teams this charm will make operating WordPress simple and straightforward through Juju's clean interface. It will allow easy deployment into multiple environments for testing of changes, and supports scaling out for enterprise deployments. +## In this documentation + +| | | +|--|--| +| [Tutorials](https://charmhub.io/wordpress-k8s/docs/tutorials-getting-started)
Get started - a hands-on introduction to using the Charmed WordPress operator for new users
| [How-to guides](https://charmhub.io/wordpress-k8s/docs/how-to-contribute)
Step-by-step guides covering key operations and common tasks | +| [Reference](https://charmhub.io/wordpress-k8s/docs/reference-actions)
Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/wordpress-k8s/docs/explanation-overview)
Concepts - discussion and clarification of key topics | ## Contributing to this documentation -Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://discourse.charmhub.io/t/wordpress-documentation-overview/4052) to enable easy collaboration. Please use the "Help us improve this documentation" links on each documentation page to either directly change something you see that's wrong, ask a question, or make a suggestion about a potential change via the comments section. +Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions, and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://discourse.charmhub.io/t/wordpress-documentation-overview/4052) to enable easy collaboration. Please use the "Help us improve this documentation" links on each documentation page to either directly change something you see that's wrong, ask a question, or make a suggestion about a potential change via the comments section. If there's a particular area of documentation that you'd like to see that's missing, please [file a bug](https://github.com/canonical/wordpress-k8s-operator/issues). ## 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. +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/) @@ -24,10 +29,3 @@ The WordPress Operator is a member of the Ubuntu family. It's an open source pro - [Contribute](Contribute) Thinking about using the WordPress Operator for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)! - -## In this documentation - -| | | -|--|--| -| [Tutorials](https://charmhub.io/wordpress-k8s/docs/tutorials-getting-started)
Get started - a hands-on introduction to using the Charmed Wordpress operator for new users
| [How-to guides](https://charmhub.io/wordpress-k8s/docs/how-to-contribute)
Step-by-step guides covering key operations and common tasks | -| [Reference](https://charmhub.io/wordpress-k8s/docs/reference-actions)
Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/wordpress-k8s/docs/explanation-overview)
Concepts - discussion and clarification of key topics | diff --git a/docs/reference/actions.md b/docs/reference/actions.md index 39e20f9b..87fc65d5 100644 --- a/docs/reference/actions.md +++ b/docs/reference/actions.md @@ -1,3 +1,3 @@ # Actions -See [Actions](https://charmhub.io/wordpress-k8s/actions). +See [Actions](https://charmhub.io/wordpress-k8s/actions). \ No newline at end of file diff --git a/docs/reference/configurations.md b/docs/reference/configurations.md index 0c79d9da..cf25229c 100644 --- a/docs/reference/configurations.md +++ b/docs/reference/configurations.md @@ -1,3 +1,3 @@ # Configurations -See [Configure](https://charmhub.io/wordpress-k8s/configure). +See [Configure](https://charmhub.io/wordpress-k8s/configure). \ No newline at end of file diff --git a/docs/reference/integrations.md b/docs/reference/integrations.md index 43848304..96a420b8 100644 --- a/docs/reference/integrations.md +++ b/docs/reference/integrations.md @@ -60,4 +60,4 @@ Database endpoint can be related to mysql based charms, providing long term stor Database relation connect wordpress-k8s with charms that support the `mysql_client` interface on port 3306 in the database side. -Example database relate command: juju relate wordpress-k8s:database mysql-k8s:database +Example database relate command: juju relate wordpress-k8s:database mysql-k8s:database \ No newline at end of file diff --git a/docs/reference/plugins.md b/docs/reference/plugins.md index 59f2df09..c815c0e2 100644 --- a/docs/reference/plugins.md +++ b/docs/reference/plugins.md @@ -80,4 +80,4 @@ _\*The descriptions of the following plugins are taken from the WordPress plugin - [wp-statistics](https://wordpress.org/plugins/wp-statistics/): GDPR compliant website statistics tool. - [xubuntu-team-members](https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/wp-plugin-xubuntu-team-members): - Adds the role "Xubuntu Team member" + Adds the role "Xubuntu Team member" \ No newline at end of file diff --git a/docs/reference/themes.md b/docs/reference/themes.md index 097714d0..63d33343 100644 --- a/docs/reference/themes.md +++ b/docs/reference/themes.md @@ -19,4 +19,4 @@ By default, the following WordPress themes are installed with the latest version - [xubuntu-website/xubuntu-eighteen](https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/wp-theme-xubuntu-website) - [xubuntu-website/xubuntu-fifteen](https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/wp-theme-xubuntu-website) - [xubuntu-website/xubuntu-fourteen](https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/wp-theme-xubuntu-website) -- [xubuntu-website/xubuntu-thirteen](https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/wp-theme-xubuntu-website) +- [xubuntu-website/xubuntu-thirteen](https://git.launchpad.net/~canonical-sysadmins/wordpress/+git/wp-theme-xubuntu-website) \ No newline at end of file diff --git a/docs/tutorial/getting-started.md b/docs/tutorial.md similarity index 99% rename from docs/tutorial/getting-started.md rename to docs/tutorial.md index f145f4b6..63aac4a8 100644 --- a/docs/tutorial/getting-started.md +++ b/docs/tutorial.md @@ -88,4 +88,4 @@ model environment that you’ve created using the following command. ``` juju destroy model wordpress-tutorial -y --release-storage -``` +``` \ No newline at end of file