Commit Graph

2759 Commits

Author SHA1 Message Date
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
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
michael vincerra
da2334e3ab In top Makefile, adds venv target to use virtualenv: (#741)
- Contributors may run `make venv` and install requirements.txt without modifying host OS
- Innermost `requirements.txt`, 2 dependencies, moved to uppermost requirements.txt
- Adds `venv` to .gitignore in case contributors/developer forget to remove.
- Reverts source/conf.py to original.
- Replaces python command with python3 in innermost _python/Makefile

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-22 21:06:08 -07:00
grouch0
8c0ad119e7 Update vmw-player.rst (#815)
Text references ESXi instead of Workstation Player though that is the topic.
2019-09-22 20:45:58 -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
DougTW
c1c4e6793f kata migration.rst: Editorial changes (#810)
* Editorial changes for kata-migratios

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

* Editorial changes to kata_migration.rst

Signed-off-by: DougTW <doug.martin@intel.com>
2019-09-20 17:48:52 -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
DougTW
f3ffba44a1 proxy.rst: Editorial changes (#803)
* Editorial changes to proxy.rst

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

* Fixes minor formatting errors.:)

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-20 16:34:17 -07:00
DougTW
0fa7d2bc64 redis.rst: Editorial changes (#797)
* Editorial changes to redis.rst

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

* Editorial changes to redis.rts
- fixed space between heading and text

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

* Fixes formatting errors for successful build in CI. Simplifies intro.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-20 16:33:56 -07:00
DougTW
5549a0a186 Editorial changes to smb-desktop.rst (#807)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-09-20 16:07:15 -07:00
DougTW
2ec68b4ab1 apache-spark.rst: Editorial and organizational changes (#798)
* Editorial and organizational changes to apache-spark.rst

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

* fixed indent alignment changes requested by mvincerx

Signed-off-by: DougTW <doug.martin@intel.com>
2019-09-20 15:50:36 -07:00
michael vincerra
22e1af3d7e Corrects SIMD extensions from 4.1 to 4.2. (#813)
- Closes #809

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-20 15:10:21 -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
Kevin Putnam
5a041baa1c Updated readme to reflect recent changes and latest doc BKMs. (#737)
* Updated readme to reflect recent changes and latest doc BKMs.

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

* Fixes typo in subheader, Cleaning up.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-19 18:30:26 -07:00
DougTW
6ac6b4812b Editorial changes to smb.rst (#806)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-09-19 08:47:31 -07:00
Kevin Putnam
c085b1e12d Merge pull request #804 from clearlinux/master
Synchronize development with master
2019-09-18 12:04:01 -07:00