Commit Graph

2205 Commits

Author SHA1 Message Date
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
Mary Camp
d744224c8e Editorial changes for grammar and formatting. (#892)
* Editorial changes for grammar and formatting.

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

* Added reviewer feedback. Standardized captions.

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

* Fixes nested auto-enumerated list.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-01 16:42:21 -07:00
Kevin Putnam
4df2dfdc15 Fixes a problem where nested collapsible sections do not expand correctly. (#887)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-11-01 09:15:05 -07: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
R Primus
9095e06aad https://github.com/clearlinux/clear-linux-documentation/issues/857: F… (#885)
* https://github.com/clearlinux/clear-linux-documentation/issues/857: Fix assorted typos

* Update for changes made since initial cloning of repository

* Fix case of word
2019-10-28 16:32:46 -07:00
Kevin Putnam
992a703fbe Fixes a problem caused by there being two ways of indicating reStructuredText code blocks: (#883)
* rst
* rest

Now both are handled gracefully.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-28 09:25:57 -07:00
Tom Leavitt
fab1ad6f85 Add virt-manager getting started guide (#880)
* Add virt-manager getting started guide

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Update virt-manager.rst

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* fix link

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Fix missing downloads link

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Minor editorial changes for virt-manager

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Add header back into virt-manager

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Applies minor edits for transitions and continuity.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-25 18:31:05 -07:00
Beth Dean
b3ca8be1a5 Clean up DLRS release section (#879)
* Clean up DLRS release section

* added a space after a link.
2019-10-25 09:02:28 -07:00
mns6070
7e74e7b8ca Update nvidia-cuda.rst (#878)
The installation path is set to /opt so the path to test nvcc needs to be updated.
2019-10-25 08:53:52 -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
Mary Camp
1b24b3629f Editorial changes in Hyper-v guide for grammar and formatting. (#871)
* Editorial changes for grammar and formatting.

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

* Closes #774 

* Added reviewer feedback.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-10-18 09:20:13 -07:00
Beth Dean
211e5c1bdd Add tutorial for PHP install & config (#869)
* Add tutorial for PHP install & config

* Add php-fpm configuration detail to php tutorial

* Change bundle name to httpd

* Remove httpd references from php tutorial

* Fix typos, change instructions to active verbs
2019-10-17 14:04:53 -07:00
Tom Leavitt
718e480d71 Update PXE tutorial to add client requirements (#873)
* Update PXE tutorial to add client requirements

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Additional changes to PXE tutorial

Move client requirements to the top of the prerequisite section
2019-10-17 13:17:15 -07:00
Beth Dean
46a25b42e7 Add examples for Hadoop and Kubernetes (#863)
* Add examples for Hadoop and Kubernetes

* Edits to new content in DARS for readability
2019-10-17 12:11:55 -07:00
michael vincerra
9b13de39be Update compatible version to CL-31130; replace bundles to install in dpdk (#854)
* Update compatible version to CL-31130; replace pkgs:
- Replace network-basic-dev w/ dpdk, devepkg-dpdk
- Revise instances of linuxapp to linux and other commands

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

* Resolve hyperlink error and preface to install bundles.

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

* Re-add network-basic-dev to Prereqs for bundles in dpdk.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-16 08:47:38 -07:00
puneetse
72cca8f019 Update NVIDIA drivers documentation (#850)
* Simpplify headings and download instructions

* Add note about NVIDIA Optimus systems

* Add step to symlink nvidia-settings.desktop

* Add section on brightness control
2019-10-15 17:26:49 -07:00
Beth Dean
2102b71d83 Add kubectl section for basic use case verification (#867) 2019-10-15 17:09:50 -07:00
Kristal Dale
0fcb703eeb Remove AES requirement from Sys Req doc (#859)
Remove AES requirement from the recommended minimum system requirements.
AES has been removed as a hard requirement for installation.

Closes #840

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-15 15:37:29 -07:00
BirokratskaZila
deb72b741c Update index.rst (#865)
Removed white trailing space and optimized the grammar.
2019-10-15 12:17:29 -07:00
michael vincerra
1688e2241a Revert "Tl telem (#794)" (#861)
This reverts commit 1bc2804b1b.
2019-10-14 12:33:16 -07:00
puneetse
a1822e21e8 Update modify container images document (#855)
* Consolidate and update examples

* Bump to 31110

* Be explicit with all docker build parameter names
2019-10-14 11:49:00 -07:00
Kevin Putnam
3fa6558b07 Adds labels for code blocks used in Clear Linux docs (#852)
* Added support for labeling code blocks. Currently supported code blocks:

* yaml
* bash
* console
* reStructuredText
* Python
* PowerShell

Handling added for re-aligning code blocks with line numbers with labels.

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

* Adds the following code block handlers:

* Diff
* C
* json
* spec
* Perl
* PHP
* xml

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-11 09:48:33 -07:00
Mary Camp
c811324028 Upleveled Contribution guidelines, edited text. (#848)
* Upleveled Contribution guidelines, edited text.

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

* Simplify doc title and sub-bullets under Contrib. guidelines per standup, 10/10/19.
Closed GH-828.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-10 18:16:23 -07:00
Tom Leavitt
1bc2804b1b Tl telem (#794)
* update telemetry opt-in requirement

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>

* update telemetry docs for opt-in changes

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Update telemetry guide

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* telemetry typo and bundle name update

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Spelling correction line 186

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

* Formatting revisions:
-Removed EOL spaces
- broke lines longer than 78 characters
- re-wrapped text as needed

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

* Minor editorial changes to telemetrics.rst

Signed-off-by: DougTW <doug.martin@intel.com>
2019-10-10 13:14:48 -07:00
Beth Dean
a3f72d407a Remove -version flag from os-install command (#853)
* Remove -version flag from os-install command

* Remove weird whitespace
2019-10-09 14:23:39 -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
Tom Leavitt
2387065e74 typo fix for :command: directive (#849)
Removed the space between the :command: and the text
2019-10-08 14:17:02 -07:00
bktan8
73e5ba9f6f Remove reference to "decompress" in bare metal installer docs. (#847)
- In Preliminary steps, remove penultimate step on verify.
- Verify integrity of image is already included in `bootable-usb`
- If `bootable-usb` is referenced in installation docs, `verify` is implied
- Edits `..-install-server` to make Prelim steps consistent with `..-install-server`

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-07 19:48:32 -07:00
Kristal Dale
265469c584 Correct example commands in autoproxy guide (#838)
* Correct example commands in autoproxy guide

- Fix example commands that were split into two snippets (should be one)
- Spelling corrections and minor edits for readability

Fixes #795

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Minor edits to improve clarity with
 output samples.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Add sudo to commands that require it.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-07 15:50:32 -07:00
Kevin Putnam
3bbc77a187 Removes Previous/Next buttons on each page of docs. (#846)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-07 11:45:04 -07:00
Kristal Dale
6e7c909fef Update 400 http error pages (#844)
- Update paths to search and image to be absolute URLs
- Correct typo in CSS

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-07 09:34:54 -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
bktan8
cace98df58 Updated bootable USB Linux per https://github.com/clearlinux/clear-li… (#842)
* Updated bootable USB Linux per https://github.com/clearlinux/clear-linux-documentation/issues/796.
Also minor updated the macOS and Windows as well.

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

* Applies editorial corrections only.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-04 17:38:26 -07:00
Kevin Putnam
29d9bd2233 Fixed broken link to dev mailing list. (#843)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-04 15:03:45 -07:00
puneetse
7030b996e9 Add a new document for firewall options (#639) 2019-10-04 11:22:49 -07:00
Kevin Putnam
0df6c38203 * Adds ability to create code blocks with prepended "$" that won't be copied (wip). (#837)
* Fixes behavior and appearance of permalinks in collapsible sections.
* Fixes links to collapsible sections so that header is now target.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-04 11:12:11 -07:00
Mary Camp
fbfe5f43c6 New doc: create custom application container image (#775)
- Add CLI steps to contextualize diff output.
- Add Sphinx roles for clarity of command flags.
- Apply edits for clarity of sequence and prior to output diffs.

<michael.vincerra@intel.com>
2019-10-04 10:46:53 -07:00
Kristal Dale
d4529b126b Add custom 404 and 403 pages. (#841)
- Added static html pages for 404 and 403 server responses.
- Added conf.py setting html_extra_path to copy static _errors folder
  with static 404/403 files into build output

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-04 09:38:41 -07:00
puneetse
2f0a056995 Add document on firmware (#824)
Adds a new document on firmware laoding and a reference to it from the stateless document.
2019-10-03 07:36:40 -07:00
michael vincerra
8c588b9ac2 Apply wording corrections to to bootable-usb. (#839)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-02 18:19:50 -07:00
Sergey Ponomarev
36c8cf81da bootable-usb.rst small improvement (#833)
* Added a note to keep label as `CLR_ISO`

* UDB drive size requirements: make them lower
2019-10-02 18:04:08 -07:00
michael vincerra
6cc03629a3 Remove title case for sample application and fix typo, OpenVINO. (#836)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-02 16:03:05 -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
Kevin Putnam
d671e584aa Adds youTube video tutorial for autospec to guide page. (#835)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-02 13:40:06 -07:00
DougTW
fc972821c1 bootable-usb.rst: Editorial changes (#832)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-09-30 22:33:43 +02:00
michael vincerra
7861c356db Add Example 5 for updating an existing package in autospec. (#827)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-27 23:46:32 +02:00
Beth Dean
4707f1d3e4 Add useage examples to DARS guide (#823)
* Add useage examples to DARS guide

* Add detail on docker commands, reference custom-app-container doc

* Back out reference to custom-app-containers.
2019-09-26 22:41:32 +02:00
Kristal Dale
1f82cf1dab Move Parallels tutorial to Get Started (#826)
- Moved tutorial to Get Started virtual install section
- Updated title and intro to be consistent with other get started guides
- Updated reference to 'tutorial' to be 'guide'

Closes #776

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-09-24 16:52:48 -07:00
Beth Dean
6cd5f65b17 Update K8S tutorial for clarity (#825) 2019-09-24 16:01:53 -07:00