Commit Graph
1893 Commits
Author SHA1 Message Date
Kevin Putnam 2376e19023 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-05-30 10:52:56 -07:00
puneetse 3d6e624aa5 Fix license in autospec example. (#511)
* Fix license in autospec example.

The correct identifier for the Intel Open Source license is just "Intel" not "Intel Corporation"

* Revert back to MIT license

* Add link to SPDX license list

* Specify opae-sdk example licenses.

* Elaborate on why multiple licenses in the opae-sdk example
2019-05-29 14:55:54 -07:00
Kevin Putnam ea0915365b Fixed header underline in security.rst that was causing build error. (#515)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-29 14:44:54 -07:00
Beth Dean a8943625b1 Remove statement about dm-verity (#513)
* Remove statement about dm-verity

* Add * to first instance of Linux*
2019-05-28 13:59:39 -07:00
michael vincerra 4b00a981d7 Removes mixin.rst and all references to it. (#506)
- Closes #478

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-24 12:16:47 -07:00
puneetse 90bf8f6256 Add updating section to NVIDIA doc (#501) 2019-05-23 16:19:02 -07:00
Kevin Putnam 8da654bea6 Improved layout and decided to avoid trying to create a full width header to avoid wasting screen space.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-22 13:00:21 -07:00
Kevin Putnam f180f88dc0 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-05-22 10:15:05 -07:00
Mary Camp 9fa3a0a0e7 Completed TCS editorial review (#454)
* Completed TCS editorial review

* Includes feedback from Kris & Puneet

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-05-20 14:55:44 -07:00
Beth Dean 206bf71728 Add introductory text and link to benchmark results (#494) 2019-05-17 13:19:17 -07:00
leonardus a9da3b0366 Corrects typo in Confirm network connection (#497)
exmaple -> example
2019-05-17 13:11:55 -07:00
Mary Camp 046cfd2bd2 Completed TCS editorial review (#490)
* Completed TCS editorial review

* Resolved feedback.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-05-16 14:40:12 -07:00
michael vincerra de8f97102c Corrects typo in intro para. (#491)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-15 18:39:59 -07:00
Kevin Putnam 56b9ff52c3 Update to parse-link-check.py (#437)
* changed python script to ignore anchors as we want to fail only when the link fails to resolve to a site. Broken anchors are still flagged in the results.

* Improved comments in parse-link-check.py to make it easier to run outside of Makefile.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Added more comments to parse-link-check.py

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Small wording update.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-15 12:24:49 -07:00
michael vincerra 53ab457fb9 Update available bundles 05-14-19. Revise intro, bundles.rst. (#489)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise wording per reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-14 12:31:59 -07:00
michael vincerra 9a5106c834 Revises Create a bootable USB drive on Windows, Rufus upgrade to 3.5 (#487)
- Revises 2 screenshots and adds note.
- Closes #469
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Removes empty spaces.

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

Incorporates reviewer feedback on Rufus 3.5.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-14 10:55:39 -07:00
michael vincerra 2ea2d5f14d Revises title and all internal refs to Data Analytics Ref Stack. (#488)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-14 10:02:13 -07:00
puneetse b198747958 Update NVIDIA driver documentation to include openGL support (#474)
* Update NVIDIA installer command to isolate files and support OpenGL

* Update source/clear-linux/tutorials/nvidia.rst

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

* Elaborate on not using swupd verify with NVIDIA

* Add compat32-libdir

Some installation flows don't work without explicitly setting compat-libdir when compat-prefix is specified.

* Add note about drivers not being updated automatially.
2019-05-13 19:37:14 -07:00
Beth Dean 603207ea43 Add DARS v1 tutorial (#486)
* Add DARS getting started tutorial

* Update links to live DARS images

* updating link text in bash cmd

* Fix formatting & link ref

* Corrects sphinx directives; revises intro and other para for readability.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-13 18:31:22 -07:00
michael vincerra 02aec48b78 Adds Confirm Network Connection and Software sections. (#484)
- Figure 0 will be renumbered after reviewer confirmation.

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

Renumber all Figures due to insertion of Network Connection.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-13 15:52:23 -07:00
Kevin Putnam 151ccc32b7 Repairs links broken be removing https://clearlinux.org/containers (#483)
* Fixed broken links to now non-existant page: https://clearlinux.org/containers

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Changed link to /downloads/containers

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-13 12:02:23 -07:00
puneetse bdb43254c8 Update autospec guide to include testing methods (#461)
* Add section for testing autospec packaged software

Adds a 2nd level section with two methods for testing autospec created RPMs before being used in the mixer/mixin process.

* Revised based on feedback from @phmccarty

* Add reference to swupd verify
2019-05-10 16:19:58 -07:00
michael vincerra 5ff59f975d Revise to incorporate new GUI installer and screenshots. (#477)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Creates live desktop installation instructions based on clear-29180-0502-live-desktop.iso.
- Renames dir from bare-metal-install-beta to bare-metal-install-desktop
- Creates and assigns new screenshots for UI
- Re-links default ref from tutorials, etc. to bare-metal-install-desktop

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

Revise per developer feedback on PR.

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

Revises Finish Installation steps. Correct scale Figures 1-3.

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

Revises intro para.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-09 14:27:21 -07:00
michael vincerra 5b20941aeb Creates bare-metal-install-server; replaces bare-metal-install. (#476)
- Revises majority of figures.
- Revises User Manager to Manage User
- Revise all other submenus per release: clear-29180-0502-live-server.iso

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

Revises para under Install CL| on your target system.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-09 13:40:30 -07:00
Kevin Putnam 979f0c2979 experimenting with formatting 2019-05-07 09:44:31 -07:00
Beth Dean 00cd2b705c Add release note links for V3 release (#472) 2019-05-06 13:14:47 -07:00
Kevin Putnam 467ea0d195 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-05-06 11:12:10 -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 9c1772e594 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme
And fix of kernel-development.rst to match master

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-03 11:11:05 -07:00
Kevin Putnam 065904177f Renamed clearlinux directory in guides to "tooling" to match master branch
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-03 11:07:11 -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
michael vincerra 7d7bb474d2 CVE patch. Update requirements.txt to Jinja2-2.11.dev0. (#456)
- Address CVE: https://nvd.nist.gov/vuln/detail/CVE-2019-8341

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-12 17:08:10 -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
Kevin Putnam 5db336d01a fixed class conflict causing issue with comments in code blocks; fixed include caused by moving a file; changed top level of site to make it pretty; marked old index as orphan. 2019-04-03 12:49:01 -07:00