Commit Graph

46 Commits

Author SHA1 Message Date
michael vincerra 9a4df878ed Add tut on how to connect to Win share using CL Nautilus (#430)
* Adds smb-desktop for samba sharing from CL Gnome desktop.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Add tut on how to connect to Win share with Nautilus on CL.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Add toc reference.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Adds missing `_` leading space before file name; root cause image failure. (#431)

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Remove older unused openssh-server ref from toctree. (#432)

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* updating dd command to add sync for Linux section (#425)

* Add document on installing proprietary NVIDIA drivers (#429)

* Add document on using YubiKey with U2F  (#416)

* Add document on using YubiKey with U2F

* Add yubikey doc to tutorials TOC

* Update all links to the download website to use the CDN (#434)

Update all links pointing at https://download.clearlinux.org to use
the CDN, i.e. https://cdn.download.clearlinux.org

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>

* Move autoproxy content to updated guide template (#417)

* first draft revision of autoproxy guide with guide template

* removed related topics as there is currently nothing that qualifies

* restructured a bit more to match guide template; removed autoproxy_about.txt and autoproxy_guide.txt as they are no longer needed

* made changes recommended by @mvincerx

* minor corrections based on feedback

* Update to the swupd Guide (#409)

* partial commit to save work

* latest changes

* replaced out of date swupd-guide.rst with contents of swupd-temp.rst; removed swupd-temp.rst

* changed page ref to swupd-guide from swupd; too many existing dependencies

* Added descriptions of manifests and delta packs from How to Clear

* fixed typo

* changed header organization slightly and removed unnecessary text formatting

* updated a couple headers to make more sense

* numerous cosmetic and readability changes based on full render review

* changes to description section based on updated swupd concept page

* updates based on feedback

* updates based on technical review

* removed swupd-search.rst; updated maintenance.rst toc tree after removal; updated references in developer-workstation.rst and kernel-module.rst that linked to swupd-search.rst

* Bootable USB (#436)

* bootable-usb: Add extra caution about unmount

Not unmounting an USB partition before an image is burned could cause
file system checksum errors leading to other issues (including kernel
panics) when trying to boot from the USB drive. This commit adds an extra
caution note to warn the users about the possible issues they could find
when this step is not followed correctly.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>

* bootable-usb: Add o_sync to the dd command

Update the example 'dd' command to burn an image, by adding the 'oflag=sync'
option. This allows to reduce the flashing time in conjunction with the
recommended 'bs=4M', enables a more accurate progress indicator, and allows
to remove the additional sync command, while preserving some cache
optimizations.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>

* Revises intro to add expl of CIFS/SMB in context; removes empty ref.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Adds smb-desktop for samba sharing from CL Gnome desktop.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Add tut on how to connect to Win share with Nautilus on CL.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Add toc reference.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revises intro to add expl of CIFS/SMB in context; removes empty ref.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Revise intro per feedback; corrects hidden indent error; adds note.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-15 10:00:45 -07:00
michael vincerra 306081763f Revise, simplify prefaces to guides' and tutorials' landing pages. (#452)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Closes #446.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-12 17:12:07 -07:00
puneetse 96fa0b1a9e Add document on using YubiKey with U2F (#416)
* Add document on using YubiKey with U2F

* Add yubikey doc to tutorials TOC
2019-03-20 10:43:26 -07:00
puneetse 3fe3bc533a Add document on installing proprietary NVIDIA drivers (#429) 2019-03-20 09:32:10 -07:00
Beth Dean cbb8b26534 rework of telemetry guide & tutorials (#423)
* rework of telemetry guide & tutorials

* adding reference section

* source/clear-linux/guides/telemetrics/telem-guide.rst

* adds missing URL & link to telemetrics.rst

* deleting redundant files

* moving figure files & updating tutorial landing page links

* updating links to png files

* updating links in concept & getting started pages
2019-03-14 16:26:47 -07:00
Michael Vincerra 2036d492b1 Adds :glob: to toctree for new kubernetes subsection.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 11:53:24 -08:00
Michael Vincerra 0d7641aaa5 - kubernetes: Revises headers to omit CL
- Adds new kubernetes/kubernetes to tutorials toctree

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 11:21:55 -08:00
Michael Vincerra d577d20712 Revisions made to telemetry docs to title and toctree links.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-12-13 16:59:55 -08:00
Michael Vincerra ad00e9cac9 Adds link to parent file tutorials.rst to show new dlrs.rst.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-12-07 14:11:07 -08:00
Kristal Dale e04f718fd2 Re-enable show toctree. Update maxdepth to 1.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-01 09:23:48 -07:00
Michael Vincerra 1567b43a22 Initial commit; assigns link in tutorial.rst; first draft.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-10-31 10:55:58 -07:00
michael vincerra 7d658283df Merge pull request #255 from joselamego/lamego-2nd-k8s
kubernetes: Add tutorial
2018-10-11 15:07:05 -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 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
michael vincerra bd0cc2b3f5 Revert "Wordpress tutorial reorg" 2018-10-04 12:34:58 -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 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
Jose Lamego 5ea027a47c kubernetes: Add tutorial
This tutorial describes how to install, configure, and run the Kubernetes
system on Cler Linux OS using either the Kubernetes runtime interface
CRI-O and kata-runtime or Docker* and runc.

Signed-off-by: Jose Lamego <jose.a.lamego@intel.com>
2018-10-03 21:49:02 -05: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
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 29c96a21fa Merge branch 'master' into kata-migration-edits 2018-07-09 13:26:27 -07:00
mvincerx 47a803d0dc Merge pull request #155 from joselamego/master
kata-containers: add tutorial
2018-07-09 13:20:34 -07:00
Michael Vincerra 53ad59e18d Corrects syntax, adds internal TOC, and adds link to tutorials.rst
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-21 13:22:13 -07:00
MCamp859 1d570b8622 Edits for branding and format.
Removed $ prompts. Moved links to end of file.
Updated tutorial.rst.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-06-12 20:16:33 -04:00
Jose Lamego c021c2ead2 kata-containers: add tutorial
This tutorial describes how to install, configure and run Kata Containers on
Clear Linux.

Signed-off-by: Jose Lamego <jose.a.lamego@intel.com>
2018-06-08 13:47:25 -05:00
Rodrigo Caballero bd9630ea4c Merge branch 'master' into smb 2018-04-09 10:50:40 -05:00
Rodrigo Caballero 7803558d92 Merge pull request #86 from joselamego/spark
spark.rst: Add standalone-Spark use case tutorial
2018-03-15 13:41:26 -06:00
Adams c7487bba4a Add SMB file sharing tutorial.
Signed-off-by: Adams <eric.adams@intel.com>
2018-02-20 13:59:14 -08:00
Jose Lamego e4a917545d spark.rst: Add standalone-Spark use case tutorial
Signed-off-by: Jose Lamego <jose.a.lamego@intel.com>
2018-02-14 19:58:35 +00:00
Rodrigo Caballero 329407cb29 Fixed language and markup for clarity and consistency.
Simplified language for clarity. Changed passive voice to active voice.
Modified code blocks' markup to future-proof content for Document Based
Testing.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-13 10:59:22 -06:00
Rodrigo Caballero 192f101cf0 Merge branch 'master' into aws-web 2017-12-12 12:50:16 -06:00
Tom Leavitt 78846def94 Initial checkin of AWS web tutorial
This is the tutorial for creating and accessing a clear linux image on
Amazon Web Services

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-11-17 13:34:44 -08:00
Tom Leavitt b8655a12eb Add the telemetry backend server tutorial
Tutorial to create and use a telemetry backend server

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-11-09 15:02:41 -08:00
Ianeta Hutchinson a9d613b776 Merge branch 'master' into fmv 2017-10-31 11:05:56 -07:00
Rodrigo Caballero 32644a4e4e Fix ambiguous language and merge conflict.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-31 11:46:07 -06:00
Rodrigo Caballero 032b7974fe Add the FMV tutorial content.
The Function Multi-versioning tutorial content was provided by Victor Rodriguez.
This version has been edited and the markup fixed to comply with the
documentation repo's guidelines.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-19 09:38:18 -05:00
Rodrigo Caballero c1f7581692 Add Hadoop use case tutorial.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-21 16:26:08 -05:00
ihutchin 7cb9cb0720 Updated file titles and descriptions to improve readability.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-08-29 18:39:53 -07:00
ihutchin 622b8c0a3e Restructures Clear Linux documentation to have five main sections
Content files are moved, renamed, and relabeled to fit into get started,
concepts, guides, tutorials, and reference sections. Toc-trees were
changed where apropriate and section descriptions were provided.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-08-29 13:18:21 -07:00
Rodrigo Caballero 8956a98d7b Add multi-boot tutorial for multiple operating systems
This tutorial guides users through the process of installing other operating
systems alongside Clear Linux.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-08-22 11:36:00 -05:00
Rodrigo Caballero 40843b600d Merge pull request #14 from 01org/ml
Add machine learning tutorial.
2017-08-15 16:13:55 -05:00
ihutchin 1dd5881251 Separates install options in gs guide.
Moves bare metal install from tutorial to getting started guide.
Removes repeated and/or out of date information about VM and BM
installations and hardware compatibility check. Adds reference
tags for future documentation.
2017-07-17 17:12:59 -07:00
Rodrigo Caballero 7eb1fc790d Add machine learning tutorial.
The machine learning tutorial showcases how to install, configure, and run a
Jupyter notebook on Clear Linux with the MNIST example.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-07-17 11:09:23 -05:00
Rodrigo Caballero 34a0b6050f Restructure all technical content.
This restructure organizes the content into three sections, one per
technology. The content was left as untouched as possible, however
several directives needed to be standardized in order to implement the
new structure. All filenames follow use dashes-as-spaces and are written
using lower-case. Standard labels for files were implemented using the
filename as the label, thus, content can be cross-referenced without
having to open the file to see the label. Figures were moved to
decentralized folders to enable modularity. The scope of the restructure
as well as the dependencies between the changes required me to do it in
a single commit. Lastly, some cleanup had to be done for the
standardized structure to function properly.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-26 16:55:42 -05:00