Commit Graph

71 Commits

Author SHA1 Message Date
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
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
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
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
Beth Dean
2102b71d83 Add kubectl section for basic use case verification (#867) 2019-10-15 17:09:50 -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
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
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
puneetse
7030b996e9 Add a new document for firewall options (#639) 2019-10-04 11:22:49 -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
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
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
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
claudex
d0de8ee64a Replace "sudo echo >" with "echo | sudo tee" (#821)
"sudo echo > " will not work as the current shell will make the redirection and it doen't have the root privileges
2019-09-24 09:52:37 -07:00
Beth Dean
1806ec04dd Add link to benchmark results to DBRS (#819) 2019-09-23 13:46:34 -07:00
Beth Dean
8cf25310af Add link to terms of use (#817)
* Add link to terms of use

* Adds missing * in header below Running DBRS with Cassandra.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-23 11:54:46 -07:00
Beth Dean
fa708972f4 Create DBRS guide (#805)
* Create DBRS guide

* guides/stacks/dbrs.rst

* Add new config parameters for K8S section; clean up whitespace.

* Correct link format to Docker image

* Update links and edit for clarity

* Remove duplicate link

* Applies trademarks and simplifies intro para.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-23 08:48:05 -07:00
Daniela Plascencia
c04bbed8cb guides/dlrs.rst: updates Kubeflow sections on DLRS guide (#808)
* Removes "Kubeflow multi-node benchmarks" section as the steps there
  reference deprecated methods/code
* Updates TF Benchmarks branch 1.12 --> 1.13 on "TensorFlow single and
  multi-node benchmarks" section

Signed-off-by: Daniela Plascencia <daniela.plascencia@linux.intel.com>
2019-09-20 18:01:49 -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
Beth Dean
ee38997188 Fix incorrect image name; update link to benchmark (#791)
Signed-off-by: Beth Dean <beth.e.dean@intel.com>
Closes #767 
Closes #727
2019-09-16 09:24:33 -07:00
Kevin Putnam
69ec80848d Merge pull request #786 from intelkevinputnam/kp-repair-failing-links
Fixes several links that were failing
2019-09-13 10:39:32 -07:00
Kevin Putnam
49efe4f7bc Fixes several links that were failing
* Added one link to whitelist (nvidia downloads)
* Added "/" to download images link
* Updated to swupd update link

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-09-13 10:14:05 -07:00
michael vincerra
79daa13b75 Moves tutorials/dlrs to guides/stacks/dlrs. (#782)
* Moves tutorials/dlrs to guides/stacks/dlrs.
- Revises relative paths of figures
- Adds missing captions for figures 3,4,5

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

* Closes #752

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-12 09:24:10 -07:00
puneetse
a19948e235 Update clr-boot-manager commands (#740)
Update clr-boot-manager commands to call update before setting kernel and optinally increase the timeout.
2019-09-09 17:56:48 -07:00
puneetse
bb874bec89 Move guides inside networking section (#726)
* Move static IP document to networking section

* Move customer container document  outside of networking section

* Move NTP document to networking section
2019-09-09 17:12:22 -07:00
Kevin Putnam
7a9c102925 Restores old DRLS content for translation team QA. (#760)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-30 10:52:27 -07:00
michael vincerra
8830c289e9 Add label link to dlrs2 for stacks/guides (#759)
* add label link to dlrs2

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

* Fix.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-08-30 10:14:58 -07:00
michael vincerra
7e83487235 Adds back dlrs.rst in guides/stacks/ to avoid redirect issues. (#758)
* Replaces dlrs.rst in guides/stacks to avoid redirect issues.

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

* Corrects typo on % for image at 50.

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

* Corrects .. figure:: ref relative path from inside guides/stacks/dlrs

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

* Corrects relative path in figure 5.

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

* Revises label to avoid buld error.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-08-30 10:07:17 -07:00
Kevin Putnam
62e82d3cc5 Had to update .po files.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-29 17:32:59 -07:00
Kevin Putnam
b1e039e870 A small change.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-29 17:16:21 -07:00
Kevin Putnam
1605650039 Fixed a warning that was occurring due to a link reference in the English version of the docs. Changed to inline.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-29 17:13:46 -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
puneetse
1054aff322 Update kernel-development codeblocks (#716)
Change RPM spec file codeblocks to use the spec pygments formatting, add line numbers, and emphasize important lines.
2019-08-09 15:37:21 -07:00
michael vincerra
3b70eb23d5 Corrects swupd search command. (#715)
- Removes `bundle-add`
- Removes [-b] flag; deprecated

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-08-08 20:11:24 -07:00
Kristal Dale
3a18501f30 Minor revisions on wording and spacing.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-08 13:46:02 -07:00
Kristal Dale
a8aa87ec9d Remove redundant content + associated clean up
- Remove concepts (content migrated to Clear guides)
- Remove reference for bundle commands (quick ref in swupd guide)
- Moved bundle about page to Clear guide
- Updated links to concepts page, to instead link to the associated guide

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-07 16:54:15 -07:00
Kristal Dale
bc2bd3537c Minor grammatical updates requested in support of upcoming translated content.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-06 17:17:57 -07:00
Kevin Putnam
e67a9d0c7b Fixed include broken by moving bare metal install docs.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-06 12:23:51 -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
Kristal Dale
352cfc5614 Revisions to new about page. Added section link to guides index, for
reference from about page.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-02 16:43:17 -07:00
Kevin Putnam
ef133322bd Merge branch 'rtd-theme' into development
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-01 16:57:12 -07:00
Kevin Putnam
e16ffe2f9b Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-01 15:59:06 -07:00
Kevin Putnam
ef4c06cd61 Changed landing pages names from dir name to index to improve URLs.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-31 13:57:58 -07:00