Commit Graph

190 Commits

Author SHA1 Message Date
michael vincerra bd693d2b1c Merge pull request #263 from krisdale/kd-web-server-install-edits
Updates to "Create a Clear Linux* based web server" tutorial (resolves issue #256).
2018-10-09 20:43:00 -07:00
Kristal Dale 386acead9a Remove unneeded back ticks from stateless link definition.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-09 16:48:31 -07:00
michael vincerra 4db7e3e5d6 Merge pull request #259 from krisdale/kd-machine-learning-edits
Update machine learning tutorial title and content clean up
2018-10-09 14:52:07 -07:00
Kristal Dale 904d62888c Update formatting of code-blocks to use bash color coding (for command examples)
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-09 11:44:47 -07:00
Kristal Dale 6ed2ba376e - Applied requested updates from issue #256. Verified changes/full tutorial.
- Minor grammatical/text edits for clarity.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-08 16:56:35 -07:00
Kristal Dale 46b7bcb845 - Revise tutorials landing page text per discussion with @mvincerx
- 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>
2018-10-04 21:34:42 -07:00
Kristal Dale 3ae68432b0 - simplify tutorial landing page (remove duplicate info re bare metal install, which is included in part 1)
- Remove redundant "OS" with use of substitution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 21:32:54 -07:00
Kristal Dale ef8ab0cd88 - Clean up reST formatting
- Clean up section headers
- Add Next steps section, for consistency

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 21:32:16 -07:00
Kristal Dale c70d105c98 Reorg of WordPress tutorial (and related) files, to correct their placement 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>
2018-10-04 21:28:58 -07:00
Kristal Dale 53171a42ec - Update tutorial title to indicate what it will teach
- Simplify introduction
- Update CL name substitutions
- Update section title "Additional resources" to use standard "Related topics"
- Replace "Install and configure Clear Linux Host.." title with "Prerequisites". Update section to be more consistent with other prereq sections e.g. tutorial assumption and instruction to update CL.
- Correct section title delineation with correct depth

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 16:02:12 -07:00
Kristal Dale b1d133291e - Continues previous branch: kd-wordpress-tut-reorg
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 15:46:59 -07:00
michael vincerra bd0cc2b3f5 Revert "Wordpress tutorial reorg" 2018-10-04 12:34:58 -07:00
Kristal Dale 0ed5d4e203 Merge branch 'kd-wordpress-tut-reorg' of github.com:krisdale/clear-linux-documentation into kd-wordpress-tut-reorg
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 11:25:12 -07:00
Kristal Dale 3856ab90fe - minor clean up as part of conflict merge
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 11:15:00 -07:00
Kristal Dale 5c85eb2a47 - Revise tutorials landing page text per discussion with @mvincerx
- 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>
2018-10-04 11:05:25 -07:00
Kristal Dale 1b0e7414cb - simplify tutorial landing page (remove duplicate info re bare metal install, which is included in part 1)
- Remove redundant "OS" with use of substitution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 11:05:24 -07:00
Kristal Dale c8c4fc842d - Clean up reST formatting
- Clean up section headers
- Add Next steps section, for consistency

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-04 11:05:24 -07:00
Kristal Dale e4ffc495c6 Reorg of WordPress tutorial (and related) files, to correct their placement 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>
2018-10-04 11:05:24 -07:00
Kristal Dale 1862a2593d - Revise tutorials landing page text per discussion with @mvincerx
- 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>
2018-10-02 14:33:13 -07:00
Kevin Putnam ecffbf09e5 changed usage of uncompress to decompress where it made sense 2018-10-01 11:14:42 -07:00
Kristal Dale 5ef00db52c - simplify tutorial landing page (remove duplicate info re bare metal install, which is included in part 1)
- Remove redundant "OS" with use of substitution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-09-28 13:22:19 -07:00
Kristal Dale e884735a73 - Clean up reST formatting
- Clean up section headers
- Add Next steps section, for consistency

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-09-27 13:50:19 -07:00
Kristal Dale 16354e3872 Reorg of WordPress tutorial (and related) files, to correct their placement 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>
2018-09-24 15:21:42 -07:00
Michael Vincerra fca6168266 Adds |CL-ATTR| to title for maintainability.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-14 14:47:44 -07:00
Michael Vincerra 71ebc35287 Adds |CL-ATTR| on first use in body text to reflect branding change.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-14 10:16:11 -07:00
Michael Vincerra 12e17d7883 Applies Sphinx syntax and branding edits:
- Revises headers to follow convention per collab guidelines
- Revises CL in accordance with new branding
- Removes `$` for CLI prompts and corrects code-blocks to bash
- Adds sentence in para 2, `download it here`, a previously unused link

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-13 18:19:48 -07:00
Simental Magana, Marcos 4f80aecda3 clear-linux/tutorials/flatpak/figures: cleanup
this commit removes the *png files that are no longer used
for the flatpak tutorial.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2018-09-11 14:51:32 -05:00
Simental Magana, Marcos 00cd5de43d clear-linux/turorials/flatpak: update tutorial
This commit updates the Flatpak tutorial to make use
of the gnome-software application and keep the command
line setup as well.

LibreOffice flatpak repository changed to Flathub.
This commit  updates the instructions to install it
as documented in https://www.libreoffice.org/download/flatpak/

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2018-09-11 14:51:32 -05:00
Kevin Putnam 90418a9195 asm code-block is not recognized by sphinx 1.2.2 - changed to :: 2018-08-24 10:23:46 -07:00
Michael Vincerra 1bea0ec609 Reduces wordiness of descriptions.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-15 16:52:34 -07:00
Michael Vincerra 769c922fbc Revises wording of tutorials for simplicity.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-09 16:51:38 -07:00
Michael Vincerra 51ceff5817 Redefines guides and tutorials by:
- Revising clear-linux top-level TOC
- Adding a clear definition of what a guide is
- Adding a clear definition of what a tutorial is

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-09 14:57:15 -07:00
mvincerx a5e0dcc6e0 Merge pull request #205 from intelkevinputnam/kp-rm-warnings
Fixed last of the warnings in the Sphinx Build
2018-08-01 09:49:43 -07:00
Kevin Putnam ab15d98ddc Fixed the last of the warnings - not at zero 2018-07-30 14:25:56 -07:00
mvincerx 1b52463239 Merge pull request #198 from MCamp859/telemetry-edits
Add telemetry concept to CL docs.
2018-07-27 15:27:10 -07:00
MCamp859 27e2ab30a6 Corrected references and ref label spelling.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-27 13:41:08 -04:00
MCamp859 51cf60b2d2 Incorporated review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-26 16:32:37 -04:00
MCamp859 e8f6a074b9 Updated kata and kata_migration tutorials.
Updated info for selecting runtime and edits for text flow and clarity.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-25 21:55:58 -04:00
Kevin Putnam cbea9d3f4d up to 27 fixes and down to 68 warnings 2018-07-23 16:52:02 -07:00
Kevin Putnam 0b08cf0cb0 first 23 fixes to remove warnings from build - down to 75 warnings 2018-07-23 16:25:15 -07:00
MCamp859 1b55b0d487 Add telemetry concept to CL docs.
Update related telemetry rst files to add links.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-19 15:31:14 -04:00
Michael Vincerra 32d44093f7 Replaces hash with asterisk below 'More information about Docker in |CLOSIA|'
- If hash is used, there are two 'titles' rendered in webpage left menu

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-17 17:40:35 -07:00
Kevin Putnam e056361c6e fixed figure links 2018-07-17 12:15:34 -07:00
Kevin Putnam 3e8a8889a7 fix to make sure ms azure changes are visible in final rendered site 2018-07-17 12:11:18 -07:00
mvincerx 34ba21d28c Merge branch 'master' into edit/ps-docker-tutorial 2018-07-16 16:00:26 -07:00
Michael Vincerra b7a99447df Corrects grammatical errors. Corrects Sphinx syntax for URLs.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-16 15:52:00 -07:00
puneetse 18ca599fe1 Remove Clear Containers reference. Add Kata
Clear Containers runtime integration was removed. Updating documentation to reflect that.
2018-07-12 12:20:26 -07:00
Michael Vincerra e23dcbbe9c Removes instances of s/cc-runtime for kata per @devimc
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-12 10:06:35 -07:00
Kevin Putnam 0eaa2542c7 added link to clear container migration 2018-07-11 14:40:42 -07:00
Kevin Putnam bf70fb60fd corrected runtime references 2018-07-11 14:09:53 -07:00