Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wordpress tutorial reorg #247

Merged
merged 51 commits into from
Oct 4, 2018
Merged

Conversation

krisdale
Copy link
Contributor

Reorg the WordPress tutorial into one folder. Include basic cleanup (reST formatting, attribution, substitutions)

krisdale and others added 12 commits September 24, 2018 11:34
…nk to new guide.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
…cement in the tutorials nav section.

Changes include:
- Move all WordPress tutorial files into WordPress folder (landing page, web server install, wp-install, and related images)
- Update WP landing page to more clearly indicate child pages of tutorial, hide toctree
- All files related to WordPress tutorial: replace CLOSIA with CL-ATTRs, correct attributions
- grammar

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
…aboration guidelines.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
updated telempostd description, kept at high level, will provide more detail in other documentation.  Also changed |CL| to |CL-ATTR| for first instance.
- Clean up section headers
- Add Next steps section, for consistency

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
- Move note into a note box
- enclose flag names in **
- Minor text revisions for readability/grammar

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
… install, which is included in part 1)

- Remove redundant "OS" with use of substitution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
@tpleavitt
Copy link
Contributor

@krisdale , Anthony had some changes he wants made to this tutorial, said there were things that no longer work. I can't find his userid on github

* demonstrate how to use |CL-ATTR| features for cloud, client, distributed
processing, and virtual environments.
* involve specific application of |CL| that often use third-party tools.
* extend the development possibilities of |CL| with specific use cases.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please capitalize first word in bullet list. (Lines 8-11)

@@ -1,15 +1,16 @@
.. _web-server-install:

Create a Clear Linux\* based web server
#######################################
Create a |CL-ATTR| based web server
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krisdale. Check in with me on this title, in person, please. Example: Create a LAMP stack server with |CL-ATTR|.
I recommend that we simplify these doc titles as part 1 and 2--or make them obviously sequential titles.


This tutorial shows you how to create a LAMP server using |CLOSIA| and how to use phpMyAdmin\* to manage an associated database.
This tutorial shows you how to create a :abbr:`LAMP (Linux, Apache, MySQL, PHP)` server
using |CL-ATTR| and how to use phpMyAdmin\* to manage an associated database.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tutorial explains how to use |CL-ATTR| to create an Apache web server and use phpMyAdmin to manage an associated database, following a typical :abbr:LAMP (Linux, Apache, MySQL, PHP) stack model.


.. toctree::
:maxdepth: 2

wordpress
wordpress/wordpress
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krisdale. Let's discuss, in person, potential use of :hidden: directive. See example:
https://github.com/clearlinux/clear-linux-documentation/pull/225/files/9081f8e97d59774fa3304486c54a6a068ffb49e5

@@ -0,0 +1,27 @@
.. _wordpress:

WordPress\* use case tutorial
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Omit "use case" here. It's implied.

.. figure:: figures/wp-install-3.png
:alt: Database connection details
:width: 600
:alt: Database connection details
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch!


Once the installation is complete, you can name your blog and create a Wordpress username and password. See figure 5.
Once the installation is complete, you can name your blog and create a Wordpress username
and password. See figure 5.

.. figure:: figures/wp-install-5.png
:alt: WordPress user creation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The :alt: needs to left-align with line above.

@krisdale
Copy link
Contributor Author

krisdale commented Oct 2, 2018

@tpleavitt thanks for the heads up. I ping'd @odwdinc (Anthony) to see if he wanted to include his changes in this PR.

mvincerx and others added 3 commits October 2, 2018 13:31
…-vs-uncompress

KP decompress vs uncompress
- Hide tutorials landing page toctree
- Revise titles and intro for tutorial pages per discussion with @mvincerx
- web-server-install: Update to use contents:: local with some minor supporting reorg of content; add link to stateless feature in text
- wp-install: Removed note re update with swupd as not relevant to the content of the tutorial

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
@krisdale
Copy link
Contributor Author

krisdale commented Oct 2, 2018

@mvincerx please review the latest revisions (that we discussed in person). There may be content changes coming from @odwdinc (to be confirmed in the next day).

mvincerx and others added 10 commits October 2, 2018 15:50
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
…able

Telemetry-enable: Corrects attributions, formatting, hyperlink.
The |CL-ATTR| substitution includes "OS" causing it to currently appears as "Clear Linux* OS OS Security"
…epth-1

reduced contents depth to 1 in security.rst and mixer.rst
Align  with change from @intelkevinputname 023e0ee
…cement in the tutorials nav section.

Changes include:
- Move all WordPress tutorial files into WordPress folder (landing page, web server install, wp-install, and related images)
- Update WP landing page to more clearly indicate child pages of tutorial, hide toctree
- All files related to WordPress tutorial: replace CLOSIA with CL-ATTRs, correct attributions
- grammar

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Clean up section headers
- Add Next steps section, for consistency

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
… install, which is included in part 1)

- Remove redundant "OS" with use of substitution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Hide tutorials landing page toctree
- Revise titles and intro for tutorial pages per discussion with @mvincerx
- web-server-install: Update to use contents:: local with some minor supporting reorg of content; add link to stateless feature in text
- wp-install: Removed note re update with swupd as not relevant to the content of the tutorial

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
…nux-documentation into kd-wordpress-tut-reorg

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Copy link
Contributor

@mvincerx mvincerx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the amazing reorg and revisions. The Wordpress tutorial landing page now has a logical flow and easy-to-follow titles. Please see minor comment.

#######################################

This tutorial shows you how to install the WordPress components on your |CL| LAMP server. At the end of :ref:`web-server-install`, you created a WordPress\*-ready database using phpMyAdmin\* and MariaDB\*. Now that the LAMP server is up and running, you can add the WordPress components needed to host a WordPress website on your system.
This tutorial shows you how to install the WordPress\* components on your |CL|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krisdale |CL| is correct here; however, frankly mr. shankly... , |CL| is not rendering in test build. Will you please check this page after merge? Please confirm attribution worked. It may be nothing, but we should check.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mvincerx mvincerx merged commit 1437742 into clearlinux:master Oct 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants