Commit Graph
2267 Commits
Author SHA1 Message Date
Mary Camp 9b544a135e TCS review of swupd-guide (#509)
* TCS review of swupd-guide

Signed-off-by: MCamp859 <maryx.camp@intel.com>

* Incoporated feedback.

Signed-off-by: MCamp859 <maryx.camp@intel.com>

* Added minor edits.

Signed-off-by: MCamp859 <maryx.camp@intel.com>

* Fixed bullets

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-06-17 09:36:59 -07:00
Kevin Putnam 6e47f8d986 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-06-12 15:42:45 -07:00
Beth Dean 91b4aa51e1 Add statement to clarify enable/disable default status of client (#537)
* Add statement to clarify enable/disable default status of client

* Fix duplicate -is- and embolden opt-in

* Update the telemetry concept page to reflect opt-in nature of telemetry

* Add important callout regarding enable/disable telemetry

* Reword important note to be stronger.
2019-06-11 21:33:14 -04:00
Kevin Putnam 524bb694ee Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-06-11 10:27:35 -07:00
Kevin Putnam a95c1eede9 Merge pull request #530 from mvincerx/mv-swupd-guide
@MCamp859, @castulo , @mvincerx Thanks for all the work on this PR. Merging. If you catch anything new, we can submit a new PR.
2019-06-10 18:17:42 -04:00
Kevin Putnam b302966d26 Fixed broken :command: role.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-10 15:13:02 -07:00
Kevin Putnam 43dbb3b9e7 * Moved kernel guides to their own section.
* Restored redis tutorial that was orphaned in now nonexistent clear-linux/guides section.
* Fixed includes broken by moving kernel guides

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-10 10:56:18 -07:00
Kevin Putnam b33ec1b46b Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-06-10 10:35:35 -07:00
Kevin Putnam ac2590d4ea Created an RST note for mixin deprecation notice.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-10 09:53:10 -07:00
Mikko Ylinen f874f783c2 Kubernetes doc updates (#531)
* kubernetes: update CNI instructions

CRI-O now supports multiple CNI binary paths and Clear Linux by default
uses /usr/libexec/cni AND /opt/bin/cni so there's no need to give
these instructions anymore.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>

* kubernetes: add RuntimeClass instructions for Kata Containers

Clarify how to enable Kata Containers via RuntimeClass (which is now
enabled by default in Clear Linux kubernetes).

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2019-06-07 12:03:00 -07:00
Michael Vincerra 5086e9180d Incorporates feedback from @castulo on revised swupd commands.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-07 11:14:21 -07:00
Kevin Putnam 7caea349e3 Additional proposed fixes to organization for RTD site.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-07 08:47:45 -07:00
Michael Vincerra 655ec84042 Revise instance where swupd repair is better option than diagnose.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-06 15:42:52 -07:00
Michael Vincerra 7a00983771 Replaces swupd verify and related flag commands per @castulo.
- Closes #522
- Deprecates use of:
 `swupd verify`
 `swupd verify --fix`
 `swupd verify --install`
 `-m / --manifest`

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-06 15:31:47 -07:00
michael vincerra 843abc3ef7 Adds redis tutorial with systemctl service check, 2 example use cases (#525)
* Adds redis tutorial with systemctl service check; add 2 example use cases.
- Closes #519

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

Refine intro and add development examples.

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

Revise wording intro; add hyperlinks in Example 2.

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

Correct description of client libraries.

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

Correct spacing; add note to define syntax behavior.

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

Respond to reviewer's feedback. Revise wording. Add docker command.

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

Apply wording revisions for clarity.

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

Edit for squash.

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

* Resolve build error to avoid duplicate ref's.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-06 14:26:40 -07:00
Kevin Putnam 8a07199ef0 Removed superfluous layer from documentation hiearchy and renamed master doc from clear-linux.rst to index.rst to generate a cleaner url.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-06 12:26:58 -07:00
Kevin Putnam ced53e8df3 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-06-06 12:09:04 -07:00
Kevin Putnam 1d45182130 Moved a bunch of things around. Now at risk of not being able to merge with master.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-06 12:08:33 -07:00
Kevin Putnam 45361ba0b3 Added tooling to main intro.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-06 09:37:33 -07:00
Kevin Putnam 1887b87f6f A bunch of improvements and proof of concept for moving tooling to top level.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-06 09:29:59 -07:00
Beth Dean be8aa2c024 Add link to quantization tools for model conversion (#529) 2019-06-06 07:04:00 -07:00
michael vincerra 1d284eee71 Removes multi-boot tutorial; deferred until further technical review. (#526)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-04 09:29:20 -07:00
Tonny Tzeng f7012bc1ca google-cloud: New tutorial on creating Clear Linux VM on GCP (#505)
* google-cloud: New tutorial on creating Clear Linux VM on GCP

This tutorial documents how to create Clear Linux compute engine on Google
Cloud Platform.

Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
Reviewed-by: Sethi, Puneet <puneet.sethi@intel.com>
Reviewed-by: Vincerra, Michael <michael.vincerra@intel.com>

* virtualbox-cl-installer: Revise figures to match VirtualBox 6.0.8 and new live-server installer. (#502)

* Revises instruciton to match VirtualBox 6.0.8 and new live-desktop installer; -live.img deprecated.
- Incorporates LGA and Troubleshooting from virtualbox.rst
- Replaces virtualbox.rst.
- Refer also to GH-493.
- Closes #495 
- Closes #502
- Closes #498 

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

Resizes figures; reassigns Troubleshooting section from virtualbox this doc.

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

Adds Troubleshooting section.

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

Removes ununsed figures, previously from virtualbox.rst.

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

Re-adds prev removed CAUTION in substitutions.txt

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

Revises guide per reviewer feedback.

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

Adds note on file size if using live-desktop install--below Fig. 6.

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

Incorporates reviewer feedback.

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

Revert to use case of live-server per reviewer feedback.
- Revise all Figures
- Revise all steps

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

Respond to reviewers' feedback.

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

Revise figures; add step for VBoxSVGA; move add desktop-autostart to post-install.

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

Respond to reviewer feedback re clarifying post-installation steps.

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

Simplify steps; define context for steps; correct values in code-block.

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

* Replaces step with note re kernel update in LGA section.

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

* google-cloud: New tutorial on creating Clear Linux VM on GCP

This tutorial documents how to create Clear Linux compute engine on Google
Cloud Platform.

Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
Reviewed-by: Sethi, Puneet <puneet.sethi@intel.com>
Reviewed-by: Vincerra, Michael <michael.vincerra@intel.com>

* Corrects gce filename, rst syntax for proper build and rendering.
- Adds new steps to cover gaps where necessary.
- Closes #504

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-31 13:55:47 -07:00
michael vincerra 52e8e1ff01 virtualbox-cl-installer: Revise figures to match VirtualBox 6.0.8 and new live-server installer. (#502)
* Revises instruciton to match VirtualBox 6.0.8 and new live-desktop installer; -live.img deprecated.
- Incorporates LGA and Troubleshooting from virtualbox.rst
- Replaces virtualbox.rst.
- Refer also to GH-493.
- Closes #495 
- Closes #502
- Closes #498 

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

Resizes figures; reassigns Troubleshooting section from virtualbox this doc.

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

Adds Troubleshooting section.

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

Removes ununsed figures, previously from virtualbox.rst.

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

Re-adds prev removed CAUTION in substitutions.txt

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

Revises guide per reviewer feedback.

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

Adds note on file size if using live-desktop install--below Fig. 6.

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

Incorporates reviewer feedback.

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

Revert to use case of live-server per reviewer feedback.
- Revise all Figures
- Revise all steps

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

Respond to reviewers' feedback.

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

Revise figures; add step for VBoxSVGA; move add desktop-autostart to post-install.

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

Respond to reviewer feedback re clarifying post-installation steps.

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

Simplify steps; define context for steps; correct values in code-block.

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

* Replaces step with note re kernel update in LGA section.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-31 11:10:29 -07:00
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