Commit Graph
140 Commits
Author SHA1 Message Date
jurobystricky d92c70bd91 Update vnc.rst 2020-06-26 17:39:09 -07:00
Kristal Dale 552db8b0f5 Update TM&B in guides section of docs (#1187)
* Update TM&B in guides section of docs

- Add disclaimers for Intel trademarks
- Update/correct product names in text per Intel guidance

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

* Fix syntax/indent errors.

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

* - Add link back in (accidental removal) (dlrs-inference.rst) - Minor language clarifications
(compatible-kernels.rst) - Correct missed trademark (performance.rst)

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

* - Correct product name in dlrs-inference.rst (confirmed with original author)
- Correct product name in dbrs.rst (confirmed with original author)
- Correct product name in compatible-kernels.rst

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

* Add in missing (r) in dbrs.rst

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-06-16 10:59:01 -07:00
Kevin PutnamandMichael Vincerra f6b6364490 Implements copy button (#1180)
* Adds support for sphinx_copybutton.

Closes #1134

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

* Additional config.

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

* Remove cruft.;)

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

* **DO NOT MERGE** Please verify changes with tutorials/proxy.rst. Once verified remove changes to proxy.rst.

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

* Provides example usage of new codeblock copy behavior:

1. ShellSession (line 228 in kernel-modules-dkms.rst) - will copy everything except prompt.
2. Console (line 74 in kernel-modules-dkms.rst) - will copy only the input line without the prompt.

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

Co-authored-by: Michael Vincerra <michael.vincerra@intel.com>
2020-06-02 11:21:34 -07:00
bktan8 f4670e50bf Update "Proxy Configuration" tutorial (#1165)
Closes #1125

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-20 10:02:12 -07:00
michael vincerra 3a84441854 Deprecate OpenVINO tutorial; CL no longer supports computer-vision-openvino (#1177)
* Deprecate OpenVINO tutorial; CL no longer supports computer-vision-openvino.

- Closes #1166
- openvino was also removed from containers-basic bundle
- See also: https://community.clearlinux.org/t/openvino-in-clear-linux-os-moving-to-docker/4566

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

* Remove ref to computer-vision-openvino in developer-workstation.

- Remove ref to openVINO in tutorials index.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-05-19 11:54:20 -07:00
puneetse f50e5f5057 Update MeRS page for V2 release (#1163)
Updates the MeRS page with information about the V2 release,  examples,  information on adding AOM support, and updates to new Intel Stacks locations.
2020-05-08 09:23:53 -07:00
Kevin Putnam 3fe2853c02 Escaped local host link, so it isn't turned into active link. (#1162)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-05-07 13:29:07 -07:00
Kristal Dale b3d262ffe6 Performance doc (#1149)
* Performance doc

New doc providing an outline of the approach and tactics used by CL
for performance optimizations.

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

* Edits and clarification based on feedback.

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

* - Fix typo
- Update Overview formatting for readability

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

* - Replace 'hardware' with 'Intel architecture' for consistency with
About page.
- Added required TM&B disclaimer.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-05-06 17:47:42 -07:00
michael vincerra acb0f8e2db Align Hyper-V docs to align w change from hyper.vhdx to azure-hyperv.vhd. (#1145)
- Remove images azure-docker, azure-machine-learning, and hyperv.
- Closes #1141
- Revises from Hyper-V Gen 2 to Gen 1, with relative changes to settings.
- Replaces figure 3 because Gen 1 settings are different from Gen 2
- Revises image type to remove previous default `hyperv.vhdx`,
  a Gen 2 image -- no longer supported.
- Respond to reviewer feedback; fix typos.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-29 17:04:08 -07:00
Beth Dean 1e08802399 Update DLRS guide with correct V6 link (#1137) 2020-04-21 16:37:36 -07:00
Beth Dean 9f5605dfff Update DLRS guide for v6 release (#1123)
* Update DLRS guide for v6 release

* Update versions for release

* update image name to sysstacks/... and change model path.

* Update for oneDNN and update links

* Update Docker version

* Update for branding and clarity
2020-04-21 11:40:37 -07:00
bktan8 df2078fab1 Minor updates to swupd 3rd-party (#1129)
Closes #1096

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-04-20 11:31:30 -07:00
Beth Dean 817b1f55ce - Add HPCRS guide to Stacks guides. (#1120)
- Correct URLs and formatting
- Add warning about image choice
- Corrects syntax, formatting errors for proper sequence of steps
- in ResNet50 workload section.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-20 10:59:30 -07:00
bktan8 ee83925330 Update fix broken installation (#1127)
Closes #1106

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-04-17 17:03:11 -07:00
RahulandMichael Vincerra 2f1b250cf8 update transformers section (#1112)
* update transformers section

Adding distilbert example, and the user does not need to install tensorflow or pytorch, but upgrade transformers library.

* Correct Sphinx syntax errors in code-blocks.

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

Co-authored-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-10 17:14:01 -07:00
bktan8 ef7fa72d94 Capture kernel boot messages in journal. (#1114)
Closes #1113

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-04-10 15:52:19 -07:00
Beth Deanandmichael vincerra 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 2ffff6fa9e Adds swupd-3rd-party option; removes instruction on Docker. (#1050)
- Use of Docker with mixer is now deprecated.
- Recreates grid table as list-table for future maintenance.
- Adds new section, Bundle definition files, for illustration
- Revises builder.conf in References, removing docker path.
- Updates mixer builder.conf to VERSION 1.2.
- Fix typo in filepath for LOCAL_RPM_DIR in builder.conf.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-03-30 17:02:59 -07:00
puneetse 154beef96e Fix version of OpenVINO and branding on Media Reference Stack (#1095)
* Fix OpenVINO version branding

MeRS uses the open source OpenVINO not the Intel® Distribution of OpenVINO™ toolkit

* Fix line length warnings

* Fix OpenVINO trademark branding

Fix OpenVINO trademark branding and add required acknowledgement
2020-03-26 13:10:27 -07:00
bktan8 c740464e73 Minor updates to the Stateless doc. (#1094)
Closes #1089

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-25 09:15:32 -07:00
puneetse 6c1d61b9d2 Add path to kernel source headers (#1092)
Add the path to kernel source headers in kernel module documentation for reference.
2020-03-24 11:25:42 -07:00
bktan8 1e048709b1 Remove CBM "update" after "set-timeout" (#1091)
Closes #1090

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-24 10:47:08 -07:00
Kevin Putnam cdb5531bcc Fixed broken links: (#1087)
Added escape character so they aren't turned into links:
guides/clear/mixer.rst:1127:
   [broken] http:/
guides/clear/swupd-3rd-party.rst:61:
   [broken] http:/

Pointed to containers and bundles that still exist:
guides/maintenance/developer-workstation.rst:58:
   [broken] https://clearlinux.org/software/docker/machine-learning/
guides/maintenance/developer-workstation.rst:187:
   [broken] https://clearlinux.org/software/bundle/web-server-basic
guides/maintenance/developer-workstation.rst:193:
   [broken] https://clearlinux.org/software/bundle/database-basic

Unable to fix - this document doesn't appear to exist. Recommend removing reference.
guides/stacks/dbrs.rst:41:
   [broken] https://clearlinux.org/news-blogs/database-reference-stack-dbrs-v2-now-available

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-03-20 11:20:23 -07:00
Beth Dean cb1e5c3942 Fix broken link (#1088) 2020-03-20 11:19:52 -07:00
bktan8 2417f133c6 Create, Install, and Manage 3rd-party Bundles (#1075)
Closes #528

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-19 17:43:25 -07:00
Beth Dean 57929c7af8 Add memcached instructions for v2.0 (#1081)
* Add memcached instructions for v2.0

* Fix broken link, update Optane branding

* Add link to release announcement
2020-03-19 14:23:54 -07:00
bktan8 c5db9bbaa7 Update unattended installation doc and deprecate ister doc. (#1079)
Closes #1052

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-18 19:18:02 -07:00
odwdinc 3b467b9682 Added fix for swupd bundle-add Error (#1067)
Signed-off-by: Anthony Pray anthony.s.pray@intel.com
When using the docker image you may see error
"Failed to install x of x"
ruining  "swupd clean" will fix the problems.
2020-03-10 11:25:22 -07:00
Beth Dean 9e94e80ef8 Update instructions for X11 forwarding and SFTP (#1066)
* Update instructions for X11 forwarding and SFTP, closes #1027

* Clean up instruction steps for consistency
2020-03-10 11:11:50 -07:00
Eric Adams 5bc7d20547 Adds hugepages config guide to explain defaults and config settings (#1061)
* Adds hugepages config guide to explain defaults and config settings

Closes #1005

Signed-off-by: Adams, Eric <eric.adams@intel.com>

* Made revisions per feedback from reviewer.

Signed-off-by: Adams, Eric <eric.adams@intel.com>
2020-03-06 15:26:02 -08:00
Beth Deanandmichael vincerra 990966b5b4 Add Horovod and OpenMPI section, closes #1041 (#1055)
* Add Horovod and OpenMPI section, closes #1041

* changing pygment lexar to console to fix build issue

* Remove single quotation mark inside code-block to correct build error.

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

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
2020-02-28 17:33:47 -08: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
Adeel Mujahid 83b12c65fd Fix typo: s/bundle <search term>/search <term>/ (#1025) 2020-02-07 12:44:25 -08:00
Eric Adams 855153c10e Updated time.rst (#1013)
* Updated time.rst

When I tried this I had an error when I tried to set ntp to true that polkit was missing. Adding that bundle allowed the step to complete.

* Update time.rst 

Removed adding the polkit and instead added sudo to the timecatectl set-ntp command.
2020-02-05 13:52:09 -08:00
bktan8andmichael vincerra 77d7631e37 Update mixer build image to use clr-installer. (#1015)
* Update mixer build image to use clr-installer.

Closes #1006

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

* Reverts Example 7 to recent master, omitting Tutorials header, etc.
- Reason: Separate branches not sync'ed based on upstream master

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

* Adds line in Example 4 to assure Example 2 is known prereq.

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

* Simplify sentence.

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

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
2020-02-05 10:59:47 -08:00
Kristal Dale 1dc3d59bc4 Minor edit to mixer guide for clarity (#1007)
In Example 7:
- Remove 'tutorial' subsection as it was not clear that it was an example of the
advanced example of manual format bump.
- Roll existing tutorial content under 'advanced' as it is the advanced example.
- Result is a basic and advance example for Example 7: execute format bump

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-31 12:49:19 -08:00
Kevin Putnam d0e71c8f5a 1. Fixes link to http://try.redis.io in redis tutorial. (#1012)
2. Fixes link to pmem-csi readme in DBRS stack guide.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-01-31 10:30:36 -08:00
bktan8 c0981002a6 Update lsblk commands to make it easier to identify devices. (#1000)
Closes #984

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-01-23 14:59:29 -08:00
Kristal Dale 10165b31ba Correct capitalization of DKMS to make standard with rest of doc. (#990)
Remove extra use of :abbr: (per contribe guide).

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-14 10:20:18 -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
puneetse ce3a6c3321 Add document for Broadcom drivers (#980) 2020-01-10 14:25:15 -08:00
michael vincerra c913639121 Prepends mixer build commands with sudo for successful execution. (#979)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-01-07 14:27:32 -08:00
df0063ef02 cpu-performance.rst: add thermal configuration section (#961)
* cpu-performance.rst: add thermal configuration section

* Apply suggestions from code review

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

* remove workaround part and add BIOS requirement

* ensure acpi tools is installed

* Apply suggestions from code review

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

* format fixup

* Apply suggestions from code review

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
Co-authored-by: puneetse <22071208+puneetse@users.noreply.github.com>
2019-12-31 11:58:38 -08:00
puneetse 41ca0a41b9 Update note on wireless in live-server getting started (#966)
* Add reference to configuring wifi guide

Add reference to configuring wifi guide and place the note according the required order of operations

* Fix line too long RST warning.
2019-12-27 10:38:35 -08:00
Beth Dean 056119551c Update readme URL and remove redundant Seldon section (#965)
LGTM
2019-12-20 16:26:00 -08:00
Kevin Putnam 4e16119846 Fixed two broken links found in weekly check. (#963)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-12-20 11:15:26 -08:00
Kevin Putnam f975d1dc00 Update to wifi guide to include wpa_supplicant. (#939)
* Update to wifi guide to include wpa_supplicant.

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

* Addressed reviewer feedback.

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

* Missed one piece of feedback.

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

* Small changes based on testing on Clear Linux to verify the current solution.

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

* Caught a couple small things.

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

* Update wifi.rst

Add more context and update commands to be as executable as possible.

* Fixed a typo and a couple of formatting problems.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-12-18 14:24:37 -08:00
Beth Dean e90885986f Update for DLRS V5 release (#962) 2019-12-17 21:20:01 -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
DougTW 1b15019f03 vnc.rst: corrected figure numbering to be sequential (#944)
* vnc.rst: corrected figure numbering to be sequential, starting with Figure 5.

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

* Fixed incorrectly numbered reference to a figure.

Signed-off-by: Doug Martin <doug.martin@intel.com>
2019-12-13 09:43:18 -08:00