Skip to content

Commit

Permalink
Capitalize WordPress in docs correctly (#1702)
Browse files Browse the repository at this point in the history
## Description

To make the docs more appealing to WordPress users spell the software
name correctly with a capital P.

See e.g.
https://developer.wordpress.org/reference/functions/capital_p_dangit/

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------
  • Loading branch information
ottok committed May 12, 2023
1 parent ac41e98 commit 6fffbd7
Show file tree
Hide file tree
Showing 9 changed files with 67 additions and 67 deletions.
16 changes: 8 additions & 8 deletions docs-website/static/docs/tutorials/package_create_wordpress.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@
<b style="color:#55ffff;">kind</b>:<b style="color:#ff55ff;"> ZarfPackageConfig</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">metadata</b>:<b style="color:#55ffff;"></b>
<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> wordpress</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> A Zarf Package that deploys the Wordpress blogging and content management platform</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> A Zarf Package that deploys the WordPress blogging and content management platform</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">version</b>:<b style="color:#ff55ff;"> 16.0.4</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">components</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> wordpress</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> Deploys the Bitnami-packaged Wordpress chart into the cluster</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> Deploys the Bitnami-packaged WordPress chart into the cluster</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">required</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"> </b><b style="color:#55ffff;">charts</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> wordpress</b>
Expand All @@ -82,27 +82,27 @@
<b style="color:#ff55ff;"> </b>-<b style="color:#ff55ff;"> docker.io/bitnami/wordpress:6.2.0-debian-11-r18</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">variables</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_USERNAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The username that is used to login to the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The username that is used to login to the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> zarf</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_PASSWORD</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The password that is used to login to the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The password that is used to login to the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"> </b><b style="color:#55ffff;">sensitive</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_EMAIL</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The email that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The email that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> [email protected]</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_FIRST_NAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The first name that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The first name that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> Zarf</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_LAST_NAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The last name that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The last name that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> The Axolotl</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_BLOG_NAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The blog name that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The blog name that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> The Zarf Blog</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>

Expand Down
16 changes: 8 additions & 8 deletions docs-website/static/docs/tutorials/package_deploy_wordpress.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<b style="color:#55ffff;">kind</b>:<b style="color:#ff55ff;"> ZarfPackageConfig</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">metadata</b>:<b style="color:#55ffff;"></b>
<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> wordpress</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> A Zarf Package that deploys the Wordpress blogging and content management platform</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> A Zarf Package that deploys the WordPress blogging and content management platform</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">version</b>:<b style="color:#ff55ff;"> 16.0.4</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">architecture</b>:<b style="color:#ff55ff;"> amd64</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">aggregateChecksum</b>:<b style="color:#ff55ff;"> 8375743b716d39346967c70b1bcaf2480a09417c8aa302e4868dd9793663b1ef</b>
Expand All @@ -75,7 +75,7 @@
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">differential</b>:<b style="color:#ffffff;"> false</b>
<b style="color:#ffffff;"></b><b style="color:#55ffff;">components</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> wordpress</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> Deploys the Bitnami-packaged Wordpress chart into the cluster</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> Deploys the Bitnami-packaged WordPress chart into the cluster</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">required</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"> </b><b style="color:#55ffff;">charts</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> wordpress</b>
Expand All @@ -95,27 +95,27 @@
<b style="color:#ff55ff;"> </b>-<b style="color:#ff55ff;"> docker.io/bitnami/wordpress:6.2.0-debian-11-r18</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">variables</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_USERNAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The username that is used to login to the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The username that is used to login to the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> zarf</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_PASSWORD</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The password that is used to login to the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The password that is used to login to the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"> </b><b style="color:#55ffff;">sensitive</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_EMAIL</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The email that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The email that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> [email protected]</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_FIRST_NAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The first name that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The first name that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> Zarf</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_LAST_NAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The last name that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The last name that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> The Axolotl</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_BLOG_NAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The blog name that is used for the Wordpress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The blog name that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> The Zarf Blog</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,17 @@
<body>
<pre>
<b class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Deploy this Zarf package? </b>(y/N) <span style="color:#55ffff;">Yes</span> <br/>
<b style="color:#55ff55;"> The username that is used to login to the Wordpress admin account</b>
<b style="color:#55ff55;"> The username that is used to login to the WordPress admin account</b>
<b class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Please provide a value for "WORDPRESS_USERNAME"</b><span style="color:#55ffff;">zarf</span> <br/>
<b style="color:#55ff55;"> The password that is used to login to the Wordpress admin account</b>
<b style="color:#55ff55;"> The password that is used to login to the WordPress admin account</b>
<b class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Please provide a value for "WORDPRESS_PASSWORD"</b><span style="color:#55ffff;">password</span> <br/>
<b style="color:#55ff55;"> The email that is used for the Wordpress admin account</b>
<b style="color:#55ff55;"> The email that is used for the WordPress admin account</b>
<b class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Please provide a value for "WORDPRESS_EMAIL"</b><span style="color:#55ffff;">[email protected]</span> <br/>
<b style="color:#55ff55;"> The first name that is used for the Wordpress admin account</b>
<b style="color:#55ff55;"> The first name that is used for the WordPress admin account</b>
<b class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Please provide a value for "WORDPRESS_FIRST_NAME"</b><span style="color:#55ffff;">Zarf</span> <br/>
<b style="color:#55ff55;"> The last name that is used for the Wordpress admin account</b>
<b style="color:#55ff55;"> The last name that is used for the WordPress admin account</b>
<b class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Please provide a value for "WORDPRESS_LAST_NAME"</b><span style="color:#55ffff;">The Axolotl</span> <br/>
<b style="color:#55ff55;"> The blog name that is used for the Wordpress admin account</b>
<b style="color:#55ff55;"> The blog name that is used for the WordPress admin account</b>
<b class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Please provide a value for "WORDPRESS_BLOG_NAME"</b><span style="color:#55ffff;">The Zarf Blog</span> <br/>
<b style="background-color:#555555"></b><b style="background-color:#555555"> </b>
<b style="background-color:#555555"></b><b style="background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"> 📦 WORDPRESS COMPONENT </b><b style="background-color:#555555"></b><b style="background-color:#555555"></b>
Expand All @@ -81,8 +81,8 @@
<b style="color:#55ff55;"></b><b style="color:#55ff55;"></b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Zarf deployment complete</b>

<b style="color:#55ffff;"></b><b style="color:#55ffff;">Connect Command </b><b style="color:#555555;"></b><b style="color:#555555;"> | </b><b style="color:#55ffff;"></b><b style="color:#55ffff;">Description</b>
<b style="color:#55ffff;"></b>zarf connect wordpress-blog <b style="color:#555555;"></b><b style="color:#555555;"> | </b>The public facing Wordpress blog site
zarf connect wordpress-admin<b style="color:#555555;"></b><b style="color:#555555;"> | </b>The login page for the Wordpress admin panel
<b style="color:#55ffff;"></b>zarf connect wordpress-blog <b style="color:#555555;"></b><b style="color:#555555;"> | </b>The public facing WordPress blog site
zarf connect wordpress-admin<b style="color:#555555;"></b><b style="color:#555555;"> | </b>The login page for the WordPress admin panel
</pre>
</body>
</html>
Loading

0 comments on commit 6fffbd7

Please sign in to comment.