Skip to content

Commit 811ca25

Browse files
docs: update Wordpress README (#120)
Comments are being shown on the docs site, so these must be removed. Also cleaned up some of the content. Co-authored-by: Vishwanath S <[email protected]>
1 parent 8312224 commit 811ca25

File tree

1 file changed

+4
-36
lines changed

1 file changed

+4
-36
lines changed

packs/wordpress-6.4.3/README.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
1-
# Title <!-- It must be the pack’s name -->
2-
3-
<!-- A brief overview of the application or service the pack provides. -->
1+
# Wordpress
42

53
WordPress is the world's most popular blogging and content management platform. Powerful yet simple, everyone from students to global corporations use it to build beautiful, functional websites.
64

75
## Prerequisites
86

9-
<!-- List the required software version or hardware the user is required to have installed and available in order to integrate the pack. -->
107
- Kubernetes 1.25+
118

129
## Parameters
1310

14-
<!-- If applicable, list and describe only the most commonly used parameters, especially if there are 10 or more that might apply.
15-
16-
You can use a table to list parameters with a **Parameter** and a **Description** column. Additionally, include a **Type** column to specify the parameter's type and a **Default Value** column for the parameter's default values. Last, you can include a **Required** column to indicate that the user must provide a value for it.
17-
18-
| **Parameter** | **Description** | **Type** | **Default Value** | **Required** |
19-
|---|---|---|---|---|
20-
| Parameter 1 | Description for Parameter 1 | String | “always” | Yes |
21-
| Parameter 2 | Description for Parameter 2 | Int | 10 | No |
22-
23-
-->
24-
25-
2611
| Name | Description | Value |
2712
| -------------------------------------- | ------------------------------------------------------------------------------------- | ------------------ |
2813
| `wordpressUsername` | WordPress username | `user` |
@@ -92,30 +77,13 @@ You can use a table to list parameters with a **Parameter** and a **Description*
9277

9378
## Usage
9479

95-
<!-- Provide instructions for the user to add the pack and configure essential settings. If there are any specific configurations users should be aware of, explain them in detail and use examples if possible. In summary, the usage section should provide a practical demonstration of how to use the pack. This could involve specifying parameters, creating extra layers, or interacting with other components or services, such as the use cases described below.
96-
97-
- How to handle dependencies.
98-
Example - when using the [Prometheus](https://docs.spectrocloud.com/integrations/prometheus-operator/) pack, Grafana can be utilized to visualize the metrics scrapped by Prometheus.
99-
- How to acquire credentials.
100-
Example - when deploying the [Vault](https://docs.spectrocloud.com/integrations/vault/) pack, you need to get the root token.
101-
- How to connect to an exposed UI or dashboard.
102-
Example - when using the [Kubernetes Dashboard](https://docs.spectrocloud.com/integrations/kubernetes-dashboard/) pack, use the port-forward command to expose and access the dashboard at a specific port from your localhost.
103-
- How to add and integrate an extra layer.
104-
Example - when using the [ngrok](https://docs.spectrocloud.com/integrations/ngrok) pack, you need to create an ingress service definition for your application, which requires a new manifest layer.
105-
106-
> [!CAUTION]
107-
> Call-out notes must follow the GitHub Flavored Markdown syntax. -->
108-
User can set "wordpress-chart.charts.wordpress.wordpressPassword" and "wordpress-chart.charts.wordpress.wordpressUsername" as per the need before deploying the addon pack. Similarly make the changes in the Mariadb paramenters
80+
User can set `wordpress-chart.charts.wordpress.wordpressPassword` and `wordpress-chart.charts.wordpress.wordpressUsername` as per the need before deploying the addon pack. Similarly make the changes in the Mariadb parameters.
10981

11082
After the pack comes up running. you can access the wordpress app using the External Ip assigned to the service.
111-
To login to the wordpress admin console one must use the URL '"http/https"://{ExternalIP}/admin'
83+
To login to the wordpress admin console, use the URL `http/https"://{ExternalIP}/admin`.
11284

113-
User can create more users from the admin console settings.
85+
You can create more users from the admin console settings.
11486

11587
## References
11688

117-
<!-- List one or more sources users can reference to learn more about the pack. References can comprise the official application or service documentation, a dedicated tutorial, the Helm Chart documentation, and more.
118-
References must be in a bullet list that adheres to the standard MarkDown link format.
119-
- [link_label](https://link) -->
120-
12189
[Overview of WordPress](http://www.wordpress.org)

0 commit comments

Comments
 (0)