Commit Graph

53 Commits

Author SHA1 Message Date
michael vincerra a72721e8a5 Removes error message re "Missing CLR_SWAP partition" (#1188)
- Error message no longer accurate given default change to swapfile.
- Closes #1132.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-06-03 16:44:56 -07:00
michael vincerra d31ed849ff Align bare-metal-install-* docs with clr-installer verify-iso-integrity (#1186)
* Align bare-metal-install-* docs with clr-installer verify-iso-integrity

- New clr-installer feature, uses checksum to verify ISO image
- See also: https://github.com/clearlinux/clr-installer/pull/737
- Closes #1185
- Adds new section, Choose boot menu option.
- Figure 01 revised in bare-metal-desktop and -server
- Changes hierarchical levels of headers for consistency.
- Removes Software(optional) section from bare-metal-install-desktop
- Latter section is not relevant to installation process; no value
- Respond to reviewer feedback on wording.

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

* Wording revisions per reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-06-03 11:27:41 -07:00
michael vincerra 0866c4a17f Revises tutorial ratings flowchart for logical coherence. (#1176)
- "Will impact of errors cause system failure" had 2 "yes" outputs.
- Export flowchart as SVG for improved scalability in web/mobile
- Closes #1175

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-05-21 11:34:49 -07:00
bktan8 3a28d5d548 Tutorial: Create a mirror of upstream update server (#1153)
Closes #1133

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-15 16:22:42 -07:00
michael vincerra 179a464571 Adds rationale for tutorial difficulty ratings (#1144)
- Closes #1082
- Add flowchart, and relocate skill-levels to reference dir
- Revises flowchart to show revised rating categories
- Revises title to "Tutorial difficulty ratings"
- Incorporates reviewer feedback
- Adds link in tutorials index to tutorial-ratings
- Revises filename and title for consistency

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-05-12 16:15:34 -07:00
bktan8 3ad6b68275 Update SMB server tutorial (#1156)
Closes #1128

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-07 13:27:03 -07:00
bktan8 0a15dd90b6 Simple HPC tutorial (#1121)
Closes #1080

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-05 11:47:01 -07:00
Beth Dean 7a6e9ae4ab Update png in DLRS guide (#1115) 2020-04-14 10:12:41 -07:00
Beth Dean 572467cef9 Update DLRS tutorial with instructions for using Transformers (#1111)
* Update DLRS tutorial with instructions for using Transformers

* Update source/guides/stacks/dlrs.rst

Co-Authored-By: michael vincerra <37549381+mvincerx@users.noreply.github.com>

* Add browser instructions for Notebook

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
2020-04-10 11:02:29 -07:00
michael vincerra d0748f3734 Align bare-metal-install-server and -desktop docs with clr-installer release 2.4.3. (#1104)
- "Only advertise the latest LTS kernel as an alternative to the Native kernel."
- clr-installer 2.4.3: https://github.com/clearlinux/clr-installer/releases/tag/2.4.3
- Revise bare-metal-install-server-30.png to support above.
- Revise bare-metal-install-desktop-21.png to support above.
- Closes #1100
- Revise Fig 21 to align with kernel selection in clr-installer release 2.4.3.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-03 10:09:36 -07:00
michael vincerra 40559931b6 Replace Fig. 32 to update embedded URL for swupd on docs.01.org. (#1097)
Closes #1038.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-03-25 14:37:25 -07:00
bktan8 f15f84ba81 Import Clear AWS image, create AMI, and launch. (#1072)
Closes #890

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-10 16:39:49 -07:00
Kevin Putnam ce716eff61 Update to CPU performance guide. (#1037)
* Changed .. code:: to .. code-block:: to match project standards.

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

* Updates to power and performance for readability and consistency with project reST standards.

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

* Further updates to CPU performance guide with BIOS snapshot to show what DPTF setting might look like.

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

* Addressing editorial feedback.

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

* Added disclaimer for Intel Turbo Boost Technology.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-02-24 13:56:08 -08:00
michael vincerra 851a41de88 Revise steps for clarity and dist UI components, bootable-usb. (#1035)
* Revise steps for clarity and dist UI components.
- Resize all images for uniformity
- Revise from balenaEtcher to Etcher per USPTO trademark

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

* Add intro and revise wording where applicable.

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

* Resizes image to be slightly larger.

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

* Resizes Figure 2 for uniformity and makes minor edits.

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

* Add Advanced Linux CLI section per group discussion.

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

* Responds to user feedback applies editorial changes.

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

* Corrects `lsblk` command labels to reflect output; adds ! for Flash complete.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-02-21 14:15:17 -08:00
michael vincerra 4d62a23039 Revises telemetry figure to correct URL; reorders steps. (#1040)
* Revises telemetry figure to correct URL; reorders steps.
- Reorders Assign Hostname to match oreder of menus in UI
- Corrects typos and grammatically unclear sentences.
- Renames figures as a result of reordering sections, above.
- Closes #1039.

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

* Recaptures Fig 31, Swupd Mirror menu:
- Adds "allow installation over insecure connections..." checkbox

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-02-20 15:43:15 -08:00
odwdinc ca40794a49 Images to update USB install instrusctions
Signed-off-by: Anthony Pray <anthony.s.pray@intel.com>
2020-02-19 13:37:11 -08:00
puneetse 3957464189 Add OpenFaaS tutorial (#1023) 2020-02-12 09:54:15 -08:00
puneetse b2ecf5f144 Add a workarounds section (#1016)
Add a section for known workarounds to NVIDIA driver issues
2020-02-05 17:02:52 -08:00
bktan8 07a1a9372f Update Clear on VMware Workstation player. (#1010)
Closes #988

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-02-03 12:29:29 -08:00
xiaoww 6627f3105a Qing cloud (#971)
* Added pngs for QingCloud

* Added QingCloud

* Update qingcloud.rst

* Update qingcloud.rst

* Update QingCloud-19.png

* applied the changes

Applied the changes based on Linjia's comments.

Names and picture have been modified accordingly.

* changed figure numbers

* changed figures number

* Create QingCloud-13.png

* 1. Fixed 2nd level section headers.
2. Changed title to include English.

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

Co-authored-by: Kevin Putnam <kevin.putnam@intel.com>
2020-01-17 11:59:49 -08:00
bktan8 52ea187067 Clear Linux on Proxmox hypervisor. (#996)
Closes #938 

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-01-16 15:42:36 -08:00
Beth Dean ff5f2e41c7 Add inference and multinode guide page for DLRS stack (#877)
Closes #876 

* Add inference and multinode guide page for DLRS stack

* Add images for Locust, add section on autoscaling & comms

* update Seldon autoscaling, move INGRESS_DDRSS section

* Move INGRESS_ADDRESS to benchmarking section, changes for readabiity, reduce ToC to 1

* remove gitlab URL

* Move INGRESS_ADDRESS section and reword introduction
2020-01-13 10:49:27 -08:00
bktan8 1b8fe35939 Alternative - install Windows after Clear Linux (#981)
Closes #967 

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-01-10 14:36:39 -08:00
Tonny Tzeng 8e32449d47 doc: refresh the Clear Linux OS on GCP guide (#976)
Update the Clear Linux OS on Google Cloud Platform guide with:

- Screenshots for the new Storage bucket creation.
- Remove the black dot in the username limitation warning.

Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
2020-01-07 09:32:02 -08:00
bktan8 7b21fb9159 Update increase-virtual-disk-size doc. (#958)
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-12-16 14:46:23 -08:00
bktan8 edbb9286e5 Deploy Clear to DigitalOcean guide. (#952)
Closes #886 
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-12-13 14:20:18 -08:00
michael vincerra 7a4e6c6d1c Combine two VMWare guides into one: vmw-player. (#950)
* Combine VMWare guides into one, separate image types with tabs in vmw-player.

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

* Re-arrange all figures into _figures dir and manage file dependencies.

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

* Fix indentation error in tabs preventing successful build.
- Reorganize vmw-player-preconf figures.

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

* Replace Figure 11; move Detach the |CL| installer ISO to Desktop tab.

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

* Reorg figures and order of ops per forked flow, reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-12-09 10:16:36 -08:00
bktan8 8ca656b901 iPXE updated to use clr-installer. (#932)
ister and icis deprecated.

See also: https://github.com/clearlinux/clr-bundles/issues/171
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-11-21 15:39:14 -08:00
puneetse dbf84a7bb9 Add guide for Media Reference Stack (#929)
* 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>
2019-11-20 11:38:42 -08:00
bktan8 23bbd6ba73 Update VNC doc. (#900)
* Update dual-boot-win with better systemd-boot screenshot.

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

* Revised VNC doc.
Minor tweaks.

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

* Correct minor formatting indentation error.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-06 21:47:55 -08:00
bktan8 5eebaea1f6 Update dual-boot-win with better systemd-boot screenshot. (#898)
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-11-05 18:07:20 -08:00
michael vincerra d5dcf8a7a0 Add dual-boot-linux for CL with other grub-based linux distros. (#884)
* Adds dual-boot tut for CL with other grub-based linux distros.

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

* Change lowercase grub to uppercase in intro.

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

* Revise indentation levels of substeps; add new Fig. 12.

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

* Fix trailing space in command.

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

* Create additional indented ordered lists for partition config.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-05 17:59:08 -08:00
Kevin Putnam 58cba207fa Add Wi-Fi guide (#882)
* First commit.

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

* update

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

* Added content for CLI and TUI.

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

* * Removes unused .png files
* Addresses feedback:
  1. Changed title to leave room for updates include wpa_supplicant.
  2. Minor editorial updates.
  3. Added Other resources section including links to nmcli examples and documentation.
  4. Added note recommending using the TUI if concerned with having password in bash history.

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

* Adds contextual link to bare metal desktop installer in first paragraph.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-31 09:35:19 -07:00
michael vincerra 20af82abd8 Move Manage User to Required options; secure root in bare-metal-install-server (#874)
* Move Manage User to Required options; secure root in bare-metal-install-server.

- Align with clr-installer merged PR: https://github.com/clearlinux/clr-installer/pull/576
- Replace Figures 18-21 to reflect TUI with Admin selected by default
- Renumber all figures after 18 and reassign
- Add note to Manage User re requirement to assign Admin to proceed.

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

* test new machine settings.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-23 19:35:05 -07:00
michael vincerra 59c745abfd Revise bare-metal-install-desktop and -server to allow offline installation. (#851)
- -desktop: Removes Fig. 4; renumbers all subsequent Figures
- -desktop: Revises header to Select Additional Bundles and add note on network
- -server: Adds similar preface as above in Select Additional Bundles
- -server: Adds missing `_` in MOUNT point, Fig. 15.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-09 12:50:28 -07:00
michael vincerra b2e82fe887 Revises scale of figures for better UI XP in dual-boot-win. (#845)
Resizes Fig. 2 for consistency.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-07 09:33:34 -07:00
michael vincerra eb5c874627 Adds CL with Windows OS in new dual-boot tutorial & multi-boot index. (#820)
- Adds more details, explanation to Method 1; adds 2 figures.
- Update to using Windows 10 OS throughout
- Add Fig. 3
- Update source/tutorials/multi-boot/multi-boot.rst
- Incorporate Advanced section -- in progress.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-04 18:05:35 -07:00
michael vincerra a4b24d7f86 Adds OpenVINO tutorial with image classification app and benchmark app. (#830)
- Add example of automobile in Run image classification.
2019-10-02 14:42:47 -07:00
michael vincerra 87930e2f2b Adds Example 6 and 7 to show how to remove a bundle and do a format bump. (#770)
- Subdivides prev Example 3 into two:
  - Create an update for the mix
  - Build an image
- Adds subsection Format Bump to explain its purpose and swupd protocols
- Adds Figure 1 and new _figures/mixer dir to illustrate Format Bump
- Modifies some commands to clarify intent, purpose
- Closes #507 

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-20 17:37:22 -07:00
michael vincerra a2de1ee7ba Removes encryption option in notes, screenshots in bare-metal-install-server (#814)
* Removes encryption option in notes, screenshots in bare-metal-install-server.

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

* Adds notes on use of _F for formatting option.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-20 14:50:31 -07:00
michael vincerra 565560ee7b Replace Figures 8, 11, new menu name, Advanced Installation, in bare-metal-live-desktop (#802)
* Replace Figures 8, 11 for new menu name: Advanced Installation
- Change from Advanced Disk Config -> Advanced Installation
- Revise word choice in above section for clarity

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

* Replaces Figure 8 to default with warning.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-17 17:39:53 -07:00
michael vincerra 03943a1774 Adds Advanced Disk Partitioning section with gparted. (#742)
- Add 6 new screenshots to show usding gparted for partitioning
- Add new screenshot for Fig. 8, for updated Select Inst. Media
- Reorder, rename Figures 11-25 to accomodate inclusion of new section

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-17 10:55:44 -07:00
michael vincerra 21ae1da040 bare-metal-install-server: Adds new section on Advanced Installation with cgdisk (#732)
* Adds new section on Advanced Installation with cgdisk.
- Adds new figures 08-16; renumbers subsequent figures
- Makes minor editorial corrections throughout

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

* Removes note indicating multiple swap partitions possible.
- Per discussion with @mdhorn.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-16 16:30:35 -07:00
Mary Camp 3b59eef4a5 Updated Flatpak tutorial with Filezilla examples. (#753)
* Updated Flatpak tutorial with Filezilla examples.

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

* Fixed refs to flatpak in FAQ doc

Closes #481

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-08-30 17:51:17 -07:00
Beth Dean 17f4c7fab4 Add examples to support DLRS v4 release (#738)
* Add examples to support DLRS v4 release

* Add AIXPRT and PyTorch training examples to DLRS guide

* adds necessary white space before code block

* updates openvino examples

* adds links to referenced scripts

* Move dlrs into tutorials for immediate publication

The dlrs guide and images are moving -- the images into the source/_figures directory, and the dlrs file into tutorials, so they can be immediately published. This change enables partners working with DLRS v4 to continue development.  When possible the dlrs.rst file will be returned to the guides section, and further edits added then.

Signed-off-by: Beth Dean <beth.e.dean@intel.com>
2019-08-29 11:51:12 -07:00
Kristal Dale 5a0144e6ee New tutorial to run CL in Parallels (#749)
This PR replaces PR 605 (including feedback/edits)

- New tutorial with screen shots
- Updated to reflect reorg of docs
- Updated title to reflect updated tutorial nameing convention
- Included feedback on previous PR (that this PR replaces)

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-29 11:13:38 -07:00
puneetse 806748336a Clean up get-started section (#714)
* Clean up get-started section

Renames titles of get-started documents to be concise and consistent. Moves GCE from VM to cloud.

* Replaces include with ref to download-verify-decompress.
- Resolves duplication of Figure 1.
- Declutters guide.

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

* Revises header for brevity.

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

* Adds missing URL to correspond to in-text reference to image repo.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-08-09 08:46:07 -07:00
Kristal Dale 3c3a1c3757 Minor revisions as part of transition to new location
-Edits to about page (per request)
-Edits to landing page (per request)
-Moved bootable usb out of containing folder (unnecessary)
-Update conf future version name

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-06 16:01:05 -07:00
Kevin Putnam c6cf74e087 Fixed URLs for intall docs.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-06 12:10:22 -07:00
Kevin Putnam bff6f34e06 Moved images to subdirectories in _figures for easier management.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-05 15:22:28 -07:00