Commit Graph

1236 Commits

Author SHA1 Message Date
Beth Dean 00cd2b705c Add release note links for V3 release (#472) 2019-05-06 13:14:47 -07:00
Kevin Putnam be8119048a Added beta 29 image to bare-metal-install to fix error caused by include of bare-metal-install-beta content
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-06 09:52:07 -07:00
Kevin Putnam 680eadb806 Fixed incorrectly formed link that was resulting 404 (#471)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-03 09:26:34 -07:00
michael vincerra ea70b3a1ff Add Configure Media Installation section with partition options. (#467)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revises Advanced Configuration, revising several figures.

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

Revert to 1a3b3c7b7bebf8b580d6d9cc6d4d564f46b394bd.

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

Reorders figures from Fig. 9 onward; inserts many new screenshots.

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

Make uniform description of recommended partitioning schema.

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

Revises Fig 7, removing warning; saves edits to Fig 29.

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

Apply edits on encyption per mdhorn feedback.

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

Refines desc of installation methods; distinguish 2 methods of encryption.

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

Remove internal cross-ref; fix duplicate ref to Telemetry.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-29 13:45:01 -07:00
Beth Dean 0333167a97 Add steps for using Jupyter Notebook to tutorial. (#463)
* Add instructions for using Jupyter Notebook

* Update Jupyter Notebook steps and add screenshots
2019-04-26 15:42:49 -07:00
puneetse e3c5d45ea4 Update command to verify CL root partition (#466) 2019-04-26 09:22:19 -07:00
michael vincerra 4e470a178f Adds doc to repair failed installation; adds new target refs. (#455)
* Adds repair of failed installation. Adds, revises target refs where needed.

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

Adds repair of failed installation. Adds, revises target refs where needed.

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

Add cross-ref to swupd-guide per feedback.

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

* Incorporate reviewer feedback; reset refs for includes to `-beta`.

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

* Revise per reviewer feedback on PR.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-24 12:21:53 -07:00
michael vincerra 8897dbb6cd kata: removes configuration step /etc/systemd/system/docker.service.d/50-runtime .conf (#459)
* Removes configuration /etc/systemd/system/docker.service.d/50-runtime.conf
- 50-runtime.conf file automatically created on CL builds > 27000
- Adds Troubleshooting, and adds prev manual conf option
- Closes #453

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

Revises kata.rst adding Troubleshooting link to change devicemapper for production.

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

* Revise to ../50-runtime.conf

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

* Replace storage driver devicemapper with overlay2; add note.

- kata: add note re options of storage drivers.

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

* Remove grep runtime bc of errors; assign bullets to troubleshooting.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-23 09:57:13 -07:00
michael vincerra 8ab6ddfcea yubikey: Add sudo in second command to reload udev rules. (#460)
- Closes #458

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-16 14:48:17 -07:00
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
Beth Dean 4188e47810 fixing typo in authenticity (#451) 2019-04-09 10:35:30 -07:00
michael vincerra 8da517d825 Revise conflict between steps 3 and 4. Closes #419. (#447)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise cp command to use local Downloads directory.

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

Adds curl command to download OVMF.fd; removes note.

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

Remove trailing whitespaces. Closes #419  

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-09 10:31:21 -07:00
michael vincerra 05d017fcd6 swupd-guide: corrects typo; removes trailing spaces. (#450)
- Closes #448

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-09 09:29:24 -07:00
Kevin Putnam 45801309fa removed maintenance and network landing pages; moved all guides to three sections on guides landing page: clear linux tooling, maintenance, and networ. (#444) 2019-04-08 10:32:07 -07:00
michael vincerra b95b80cc69 Make optional adding desktop-autostart bundle. (#443)
- Close #418

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-05 16:24:53 -07:00
Kevin Putnam 470922b28b escaped localhost urls that should not be links (#445) 2019-04-05 15:21:04 -07:00
Beth Dean 14e4dadca7 cleaning up bash commands to make copy/paste cleaner (#441)
* cleaning up bash commands to make copy/paste cleaner

* adding sudo to a swupd command example
2019-04-04 17:00:04 -07:00
michael vincerra cc9196f920 k8s tut: Add new section on cloud native setup automation. (#435)
* Add new section on cloud native setup automation.

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

* Revise repo URL.

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

* Revises new section per reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-04 12:29:42 -07:00
michael vincerra da2a938f3a Remove optional curl method to download installer img. (#440)
- Discontinue support for older txt file and for embedded parsing commands.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-04 11:14:59 -07:00
Kristal Dale a7ce92acdf Mixer guide rework (#372)
* Initial commit of rework

- Restructure organization of content to be task and background oriented
- Include references to available man pages

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

* - Updated bundle section: updates in tooling, simplified and added ref to man page

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

* Tested all examples except Docker proxy info.
Expanded examples and included setup of VM to test image and update content.

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

* Comment removal

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

* Clean up comments and TODOs in preparation for initial review.

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

* Updates based on @intelkevinputnam feedback

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

* Update bundle section based on new info from engineering.

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

* Correct capitalization of mixer name.

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

* Edits per feedback from @bktan8

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

* Update prereq formatting and numbered list formatting (remove bold).

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

* Minor edit to section heading for standardization

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

* Minor edits around prerequirements formatting to bring inline with template.

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

* Revise example intro to be more concise.

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

* Minor revisions to standardize CL tooling guides

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

* Revisions based on feedback from @rchiossi.

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

* updates based on feedback

* slight wording fix

* fixed lack of indent after line break which was causing a problem with numbered list; fixed console code block syntax error

* fixed final instruction to read 'no longer'; added local bundles and upstream RMPs to bullet list

* fixed json proxy urls
2019-04-02 15:20:55 -07:00
Jair Gonzalez 73e154d072 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>
2019-03-28 18:45:16 -07:00
Kevin Putnam 99f9289a67 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
2019-03-27 20:42:55 -07:00
Kevin Putnam 1e0175b195 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
2019-03-25 09:19:58 -07:00
Geoffroy Van Cutsem 8a6d69b82e 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>
2019-03-20 14:31:30 -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 e5aa14b32b updating dd command to add sync for Linux section (#425) 2019-03-19 13:25:49 -07:00
michael vincerra ce37ed3814 Remove older unused openssh-server ref from toctree. (#432)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-18 17:04:11 -07:00
michael vincerra 5d9865ad92 Adds missing _ leading space before file name; root cause image failure. (#431)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-15 17:05:52 -07:00
michael vincerra c8c43c6944 Adds virtualbox-clr-installer to toctree of virtual-machine-install. (#426)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-15 15:31:05 -07:00
michael vincerra 4d40923a4d Revise filepath to figures/architect-lifecycle.png to ensure no embedded char errors. (#428)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-15 15:22:17 -07:00
michael vincerra cca61c722e Removes unnecessary header; replaces 2 words with 1. (#427)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-15 13:51:16 -07:00
puneetse 4c8c9d7526 Add document on installing kernel modules with DKMS (#424)
* Add document on kernel modules with DKMS

* Add changes requested by @bwarden

Update to include dkms for LTS kernel and various kernel dev bundles.
2019-03-15 10:19:46 -07:00
michael vincerra c6bd5e7a55 Add Distro factory guide for DevOps' process automation (#411)
- Adds `architect-lifecycle` as Phase 1 prior to `distro-factory` in guides for a DevOps toolchain. 
- Adds Figure 1 overview.
- Adds architect-lifecycle to toctree in maintenance.rst

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

Incorporate @mbelluzzo feedback. In progress.
Include reference/reference changes.

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

* Redefine scope, title of document: Maintain CL life-cycle.

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

* Revise intro after re-scoping.

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

* Revises scope as overview of life-cycle; context for distro-factory.
Adds new simplified graphic.

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

* Retitles; revises intro and Content Workflow.
Revise Figure 1 and renames it. Revises document filename.

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

* Removes older version.

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

* Adds revised title to toctree. Corrects missing `-`.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-15 09:51:55 -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
puneetse bd4ac010d1 Revise swupd-about to focus more on swupd (#415)
* Stop referring to other distros as "traditional"

* Revise swupd-about to focus on swupd

* Minor fixes

* Revised with feedback from @mvincerx

* Apply line-edits for brevity and readability.

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

* Fix typo Ln 19.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-13 15:10:15 -07:00
puneetse d71cdef1e2 Refresh VirtualBox documentation (#413)
* Add a new document for installing Vbox VM with CL installer

Add a new document for using VirtualBox to setup a new VM and install Clear Linux onto it. This refreshes some of the VirtualBox content and images as well.

*  Update virtualbox document and refactor common content

* Fix typo

Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* Fix typo

Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* Fix typo

Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* Fix typo

Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* Change grep command

Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* Add mention to not remove kernel-install

* Fix typo

Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* Add out of disk to troubleshooting
2019-03-13 12:15:12 -07:00
Anselmo L. S. Melo 11cf27052b kvm: Simplify step to install vncviewer (#422)
swupd bundle-add tigervnc is enough to install a vncviewer (5MB vs 125 MB of desktop-apps-extras)
2019-03-12 09:07:09 -07:00
Anselmo L. S. Melo e83fe4a543 kvm: Configure and start SSH server (#421)
Step 1 actually is a configuration step, it does not enable SSH. Besides that, the server has to be started.
2019-03-11 20:46:55 -07:00
Anselmo L. S. Melo a9cceb9a23 kvm: Add command line to download start_qemu.sh (#420) 2019-03-11 09:45:44 -07:00
michael vincerra 6a5fba7267 Revise and simplify swupd-about concept. (#412)
- Closes #399
- Limit description to swupd functionality and contrasts

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

Line-edits for reading comp.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-05 15:13:43 -08:00
Beth Dean 2a95b25526 dlrs tutorial update (#410)
* adding pytorch section

* updated doc

Minor nits and corrections

* scripts: Code Block rst parser

Signed-off-by: John Andersen <john.s.andersen@intel.com>

* limited to bash code blocks and added description to the header

* added ability to create a list of code blocks to parse

* adding pytorch section

* updating PyTorch image link & name

* updating docker image link and adding PyTorch benchmarking link

* Sphinx syntax corrections; reorganizes contents/toctree; line-edits.

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

* updating link to PyTorch benchmarks
2019-03-05 07:40:47 -08:00
michael vincerra e922cf27ce Merge branch 'master' into kd-autospec-apply-guide-template 2019-03-04 13:47:06 -08:00
Kristal Dale dbb8ba03bd Wording clarification in response to feedback from @mvincerx
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-03-04 12:46:42 -08:00
Kristal Dale 553f4f359c Revisions based on feedback from @bktan8.
- Wording improvments
- Move instructions for required setup for building source to References section.
  This follows similar org to the mixer guide, keeping emphasis in 'how it works' on
  the description of what is required and how it works, and keeping the examples
  section as just examples of autospec. Idea is this setup is a supporting reference
  for using/enabling the tool.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-03-01 16:26:08 -08:00
Kristal Dale c1485ce264 Update wording around prerequisites and example of first time setup to be
presented more as the setup for building source in CL (rather than autospec
specific). So that the setup instructions may be reused. Added section labels
back in for external reference.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-03-01 14:17:18 -08:00
michael vincerra f21f8570d0 Merge pull request #380 from krisdale/kd-new-ister-guide
New ister guide
2019-03-01 13:29:36 -08:00
Kristal Dale 55163e84d4 Update guide title per @mvincerx feedback
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-03-01 11:19:07 -08:00
michael vincerra fbe4e8aa8d Merge pull request #406 from krisdale/kd-mixin-template-revs
Mixin guide: Minor clean up to bring inline with template.
2019-02-28 10:03:25 -08:00