Commit Graph

2214 Commits

Author SHA1 Message Date
michael vincerra 0f0eb17809 Replaces telemetry figure with clr-installer 2.0.8 version, live-desktop. (#597)
* Update telemetry figure per Engineering to reflect clr-installer 2.0.8.

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

Revise instruction to match new GUI.

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

* Revise wording of step to match new GUI.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-08 17:30:10 -07:00
Beth Dean fe2194355a Add a note about running stack on other Linux distros (#598)
* Add a note about running stack on other Linux distros

* Add unistall instructions
2019-07-08 15:07:44 -07:00
DougTW 000a3d60df mixer.rst: editorial changes (#585)
* Editorial, spelling, and formatting changes only.

Signed-off-by: DougTW <doug.martin@intel.com>

* Fixed indentation error on mixer.rst

Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-08 12:58:30 -07:00
Kevin Putnam d6c7796382 Added FAQ to sitemap and shortened FAQ title text to "FAQ." (#600)
Closes #599 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-08 11:58:36 -07:00
Beth Dean 09f3f68649 Add link to terms of use in the dlrs tutorial (#596) 2019-07-03 20:00:09 -05:00
bktan8 264001c830 q
* Retested QEMU-KVM doc. against latest Clear and 3rd-party distros.
Updated doc. to reflect any changes.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>

* Added reviewer comments.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-07-03 14:13:50 -05:00
DougTW 66778cc38b Minor editorial changes to swupd-guide.rst. (#591)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-03 13:27:36 -05:00
puneetse 1769d6eff4 Fix minor syntax on nvidia.rst (#594) 2019-07-02 17:03:28 -07:00
michael vincerra b44b744a0a Adds note to clarify BIOS behavior if installing on multiple partitions. (#582)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Rewording revisions.

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

Incorporates reviewer feedback.

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

Editorial change.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-02 15:46:11 -07:00
puneetse 1e29bd2f8f Add a step restart NetworkManager in static IP doc (#584)
* Update assign static IP doc to have NM instructions

* Add step to restart NetworkManager
2019-07-02 15:11:35 -07:00
puneetse 4f86b06936 Update NVIDIA documentation to isolate install even further (#586)
* Add updating section to NVIDIA  doc

* Isolate NVIDIA files under /opt and /etc even more

Adds more parameters to avoid nvidia-installer placing files under /usr and have applications use alternative paths.

* Explicitly add warning about libGL.so conflict

Add a warning about the well-know libGL conflict between mesa and NVIDIA packages.

* Update nvidia.rst
2019-07-02 14:59:46 -07:00
DougTW ea7263c429 minor editorial changes; edits complete. (#580)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-02 12:11:33 -07:00
puneetse a829786be6 Update assign static IP doc to have NM instructions (#574) 2019-07-01 08:55:35 -07:00
Beth Dean 45ce94d4df Add link for launcher.py and note MKL HW reqs for DLRS tutorial. (#570)
* Add link for launcher.py and note MKL HW reqs for DLRS tutorial.

* Reword note about MKL, change from note to warning.  Closes #560, Closes #559

* Add note specifying Kubeflow v0.4 when using launcher.py
* Closes #559 , Closes #560
2019-06-28 10:46:25 -07:00
puneetse 0070d49b94 Add note about AUTOINSTALL=yes in dkms.conf (#575) 2019-06-28 09:15:12 -07:00
puneetse a7fe4595d3 Add a FAQ page (#547)
* Add a new FAQ document

* Clerical changes to faq doc

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-06-28 09:05:29 -07:00
DougTW e489014707 Changed ister.rst for trademarks, branding, and editorial issues. (#573)
* Minor editorial revision to test multiple commits on one file.

Signed-off-by: douglasm <doug.martin@intel.com>

* Minor editorial revisions completes my revisions to this file.

Signed-off-by: douglasm <doug.martin@intel.com>
2019-06-27 13:55:55 -07:00
puneetse 3df0f684d3 Add stateless concept document (#564) 2019-06-26 17:31:16 -07:00
puneetse ab72289223 Add document on debug system (#561) 2019-06-26 17:25:44 -07:00
DougTW 122da5da45 Dm autospec guide editorial (#565)
* Edited for syntax, spelling, trademarking, and branding.

Signed-off-by: douglasm <doug.martin@intel.com>

* Made editorial revisions, e.g., grammar and spelling.

Signed-off-by: douglasm <doug.martin@intel.com>

* changed one phrase to use active voice present tense. Reset autoproxy.rst.

Signed-off-by: douglasm <doug.martin@intel.com>
2019-06-26 15:31:23 -07:00
Beth Dean 18794a66ed Add section for kubectl to dlrs tutorial (#550)
* Add section for kubectl to dlrs tutorial

* Editorial clean up to Kubectl section.

* Minor grammatical edits: missing punctuation and line length clean up.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-06-24 11:41:52 -07:00
puneetse 3c1cfd9056 Add document on CPU power and performance (#542)
* Add document on CPU power and performance

* Minor revisions for:
- grammar
- wording/spelling
- formatting

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-06-20 11:38:28 -07:00
Tom Leavitt 815c250bab Update telemetry about (#549)
* Update telemetry about

Remove link to the features/telemetry, it no longer exists

* Update next steps

Update next steps section

* add backticks

cut and paste zapped the backticks, restore them
2019-06-18 11:08:41 -07:00
George T Kramer e3538c68a5 Remove non-production image types (#555)
container-host-kvm.img is considered developmental and should not be
shown in documentation.  Want to keep list of image types in
documentation oriented toward production.

Signed-off-by: George T Kramer <george.t.kramer@intel.com>
2019-06-18 10:35:49 -07:00
Tom Leavitt be3c7f00d1 Update KVM download script (#551)
update the grep string to isolate and download the -kvm.img file
2019-06-17 14:28:44 -07:00
Kevin Putnam cff315e9c6 Update image types to match current offerings. (#548)
* * updated image types to match current offerings
* fixed broken link in ister.rst - now pointing at image-types.rst

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

* Updates based on peer review.

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

* Removed deprecated cloud image.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-17 12:24:41 -07:00
Kevin Putnam 645c05a10f KP add proxy tutorial (#514)
* First commit of proxy tutorial

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

* First commit of new proxy tutorial content.

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

* Added additional content and some todo items.

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

* Removed todo list.

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

* Added requested proxy variables.

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

* Updates based on peer review.

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

* Fixed typo.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-17 12:23:28 -07:00
Mary Camp d03e0b88bd TCS edits in Creating CL VM on Google Cloud Platform doc (#534)
* Signed-off-by: MCamp859 <maryx.camp@intel.com>
TCS review of GCE guide

* Incorporated feedback.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-06-17 09:39:13 -07:00
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
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 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 216db17df2 Merge pull request #535 from intelkevinputnam/kp-fix-guide-note
Created an RST note for mixin deprecation notice.
2019-06-10 12:55:30 -04: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
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
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
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
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