* Add guide for Media Reference Stack
* Correct errors in syntax and docstring refs for successful build.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Corrects docstring ref title from `tutorial-proxy` to `proxy`
- Resolves build error detected by Travis
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Removed link at left of header that went to clearlinux.org
* Added "home" button on right side of header that goes to clearlinux.org
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* 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>
* 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>
- Substitutions
- Python config file
- Replace hard coded product name in page heading with sub on CL doc landing page
- Replace hard coded product name with sub in system-requirements
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
On 2017-11-30:
--------------
1) Created the download-image.rst file in the Guides/Maintaince. This is a hidden file and not visible under the Maintenance tree. This talks about types of Clear Linux images, how to verify checksum, and how to uncompress for Linux, macOS, and Windows. This is the base for other docs such as the bare-metal, live, bootable USBs (Linux, macOS, Windows), VMware docs...
2) Reworked the bootable-usb-linux.rst to re-use content from download-image.rst.
3) Reworked the bootable-usb-mac.rst to re-use content from download-image.rst.
4) Reworked the bootable-usb-windows.rst to re-use content from download-image.rst.
5) Reworked the live-image.rst to re-use content from bootable-usb-linux.rst and download-image.rst.
6) Reworked the bare-metal doc to re-use content from bootable-usb-linux.rst and download-image.rst.
On 2017-12-01:
--------------
1) Updated the types of images list and created a table.
2) Remove references to the old "releases" repo. Users should only use the "image" folder - per engineering.
On 2017-12-05:
--------------
1) Recaptured the 7zip screenshot and made it look better.
2) Added "download-image.rst" to the Guides/Maintenance/maintenance.rst" tree to make it visible.
3) Moved the "Download the latest Clear Linux image" out of the "download-image.rst" and put it into
the "bootable-usb-linux.rst" and tagged it so it could be used by "bootable-usb-mac.rst" and
"bootable-usb-windows.rst".
On 2017-12-07:
--------------
1) Changed the "Types of images" list Guides/Maintenance/download-image.rst to a table format.
On 2017-12-13:
--------------
1) Changed all instances of <> to [] to indicate substitution.
2) Added |CAUTION-BACKUP-USB| in substitution.rst. This is used in create-usb-linux.rst, create-usb-mac.rst, create-usb-windows.rst.
3) Deleted download-image.rst and created 3 new docs, one for each OS: download-verify-uncompress-linux.rst, download-verify-uncompress-mac.rst, download-verify-uncompress-windows.rst.
4) General fixes based on feedback.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>