2394 Commits

Author SHA1 Message Date
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
Kevin Putnam 112f19c842 Cool columns of tutorials sorted by experience level. (#1143)
* Cool columns of tutorials sorted by experience level.

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

* Fixed wording of 1st paragraph

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

* Moved kubernetes to High category.

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

* Made change to address github action check.

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

* Restored to :ref: from :doc:

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

* Updates tutorial index with latest changes on master.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-05-12 12:59:45 -07:00
bktan8 5481c7707f Update Redis tutorial (#1161)
Closes #1126

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-11 16:32:55 -07:00
bktan8 c7a87aa1ea Update WordPress tutorial (#1154)
Closes #1138

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-11 09:45:13 -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
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
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
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
puneetse f16502291c Update list of display managers (#1152) 2020-05-05 11:14:51 -07:00
bktan8 e2283f9705 Fix "Import Clear Linux Image and Launch Instance on AWS" issues (#1150)
Closes #1146

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-04 09:56:55 -07:00
michael vincerra 6a9522c627 Remove older figure 3 screenshot, inapplicable to Gen 1 Hyper-V. (#1148)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-05-01 15:03:14 -07:00
Kevin Putnam a6204a18cb Adds manpages to reference section of Clear Linux docs (#1110)
* Build manpages with "make man".

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

* Adds "make man" to github workflows.

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

* Remove shell script dependency.

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

* Change git URLs to https.

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

* Moved git clone to Makefile.

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

* Fixed typo.

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

* Adding pandoc install.

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

* Moved to Makefile.

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

* First commit toward programmatic creation of manpages.rst

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

* Multiple updates:

1. man-pages.rst now generated by script.
2. Updated Makefile and make.bat with "man" and "clean-man" recipes.
3. Fixed typo in conf.py.
4. Many improvements to manpages.py

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

* Updated readme for man pages and added man-pages.rst

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-05-01 12:23:21 -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
puneetse 9687374e2a Revise kubernetes documentation (#1030)
Revisions to the order of concepts and consolidating commands to make the document more readable.
2020-04-24 16:16:29 -07:00
Kristal Dale f028d48096 Update copyright to be consistent with clearlinux.org. (#1140)
Updated copyright string in conf.py to be consistent with copyright used on clearlinux.org

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-04-24 16:12:06 -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
Lucius Hu 16ecd84b56 nvidia.rst: Added a section on slow boot times (#1130)
This closes https://github.com/clearlinux/clear-linux-documentation/issues/1101
2020-04-21 09:53:32 -07:00
michael vincerra edd1bc10ff Update bare-metal-install* to use swapfile instead of swap partition (#1124)
* Update bare-metal-install* to use swapfile instead of swap partition

* Scope covers  -server and -desktop versions of clr-installer
* Align with clr-installer release PR-705:
* https://github.com/clearlinux/clr-installer/pull/705
* Respond to reviewer feedback
* Closes #1131

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

* Remove blank line.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-20 13:06:19 -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
michael vincerra a3b015717b Provide overview of CL architecture, including rationale. (#1109)
* Closes #1102
* Creates rationale for architectural design decisions
* Creates component list table and reorganizes content coherently.
* Applies organizational edits, line edits for consistency of voice.
* Respond to reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-14 13:37:30 -07:00
Beth Dean 7a6e9ae4ab Update png in DLRS guide (#1115) 2020-04-14 10:12:41 -07:00
Rahul 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 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 537f7014cb Add caution admonition to introduce option to skip-validation-size in sys-reqs. (#1105)
* Add caution admonition to introduce option to skip-validation-size.
- Aligns minimum system requirements with:
- https://github.com/clearlinux/clr-installer/releases/tag/2.4.3
- Closes #1103.

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

* Respond to reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-03 10:09:02 -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
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 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 9e17ed2172 Update nginx setting for iPXE doc (#1086)
Closes #1085

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-20 08:46:19 -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
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
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
Lucius Hu de72a05153 nvidia.rst: Remove chmod +x on installer (#1070)
With `sudo sh NVIDIA-Linux-x86_64-<VERSION>.run`, we don't need to change its permission.

This commit makes it a bit more convenient for users.
2020-03-10 11:23:06 -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
Lucius Hu 11736014d7 nvidia.rst: Correct the path for desktop files (#1069)
Desktop files should be created under `$HOME/.local/share/applications` instead of `$HOME/.local/share`,
at least on my system only the former one works.

This commit fixed the path for both installation and uninstallation.
2020-03-10 09:50:53 -07:00
Lucius Hu 2e5ca06c35 nvidia.rst: Add a section to restore ld.so.conf (#1068)
During installation, `ld.so.conf` was modified to include `/etc/ld.so.conf.d`, under which
a file `nvidia.conf` was created so that `ld` looks for shared library installed by NVIDIA driver.

This commit adds information on removing `nvidia.conf` file.
Users could optionally remove the line `include /etc/ld.so.conf.d/*.conf` that we added to
`/etc/ld.so.conf`.
2020-03-10 09:40:18 -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
Chadwick Ferguson 311f86d55c Makes driver find application profiles (#1064)
* Makes driver find application profiles

muchas importante

* Update nvidia.rst

* Update nvidia.rst

* Update nvidia.rst
2020-03-06 14:59:39 -08:00