clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-09-05 13:21:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
2,199 Commits 25 Branches 3 Tags
revert-604-rtd-theme
Commit Graph
9 Commits
Author SHA1 Message Date
Kevin Putnam f2a5c5a46b Revert "Merge of latest changes into RTD theme to enable multi-language support (#604)" 
This reverts commit 186f1e02b8.
 2019-07-10 15:20:53 -07:00
Kevin Putnam 186f1e02b8 Merge of latest changes into RTD theme to enable multi-language support (#604) 
* 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 (#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>

* Removes multi-boot tutorial; deferred until further technical review. (#526)

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

* Add link to quantization tools for model conversion (#529)

* A bunch of improvements and proof of concept for moving tooling to top level.

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

* Added tooling to main intro.

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

* 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>

* 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>

* 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>

* 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>

* Revise instance where `swupd repair` is better option than `diagnose`.

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

* Additional proposed fixes to organization for RTD site.

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

* Incorporates feedback from @castulo on revised swupd commands.

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

* 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>

* Created an RST note for mixin deprecation notice.

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

* * 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>

* Fixed broken :command: role.

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

* 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.

* 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>

* 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>

* 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>

* 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>

* Update KVM download script (#551)

update the grep string to isolate and download the -kvm.img file

* 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>

* 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

* 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>

* 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>

* 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>

* Add document on debug system (#561)

* Add stateless concept document (#564)

* 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>

* Add a FAQ page (#547)

* Add a new FAQ document

* Clerical changes to faq doc

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

* Add note about AUTOINSTALL=yes in dkms.conf (#575)

* 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

* Update assign static IP doc to have NM instructions (#574)

* Moved new content to new structure. Added FAQ back into top level index.

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

* Simplified tooling label from clear-linux-tooling.

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

* minor editorial changes; edits complete. (#580)

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

* 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

* Add a step restart NetworkManager in static IP doc (#584)

* Update assign static IP doc to have NM instructions

* Add step to restart NetworkManager

* 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>

* Fix minor syntax on nvidia.rst (#594)

* Minor editorial changes to swupd-guide.rst. (#591)

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

* 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>

* Add link to terms of use in the dlrs tutorial (#596)

* Added FAQ to sitemap and shortened FAQ title text to "FAQ." (#600)

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

* 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>

* Add a note about running stack on other Linux distros (#598)

* Add a note about running stack on other Linux distros

* Add unistall instructions

* 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>

* Replaces telemetry figure per Engineering for clr-installer 2.0.8. (#595)

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

Revises Figure 16, telemetry, to remove installer version.
- Closes #590 to address non-UEFI USB entry in BIOS during install

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

Closes #590.

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

* NVIDIA; Trademark, branding, and editorial changes (#601)

* Minor editorial and trademark/branding changes.

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

* Fixed file directive. Made grammatical change suggested by puneetse.

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

* Fixed heading markup requested by mvincerx.

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

* Corrects Step 4 command to verify integrity. (#602)

Signed-off-by: MCamp859 <maryx.camp@intel.com>
 2019-07-09 15:11:22 -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
Kristal Dale 8de92f42d7 Replace CLOSIA substitutions in tutorials 
- Clean up white space
- Replace CLOSIA substitutions with CL-ATTR
- Replace in line Clear Linux text with CL sub
- Update links to not include Clear Linux text in link text

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2018-11-07 15:24:51 -08:00
Kristal Dale 904d62888c Update formatting of code-blocks to use bash color coding (for command examples) 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2018-10-09 11:44:47 -07:00
Kristal Dale 53171a42ec - Update tutorial title to indicate what it will teach 
- Simplify introduction
- Update CL name substitutions
- Update section title "Additional resources" to use standard "Related topics"
- Replace "Install and configure Clear Linux Host.." title with "Prerequisites". Update section to be more consistent with other prereq sections e.g. tutorial assumption and instruction to update CL.
- Correct section title delineation with correct depth

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2018-10-04 16:02:12 -07:00
Rodrigo Caballero 4dcfde73ee Update the path of the code example. 
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2017-08-15 12:57:42 -05: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