Commit Graph

2784 Commits

Author SHA1 Message Date
Kristal Dale b42486ccb3 Update TM&B in Reference section of docs (#1181)
- Add disclaimers for Intel trademarks
- Minor corrections to a couple of Intel trademarks
- Add required nouns to Intel trademarks
- Remove duplicate '* Other names and brands ...'
- Remove SKU from table header in compatible hardware (as SKU is only part of the name)

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-06-02 11:35:42 -07:00
Kevin Putnam 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
Kristal Dale 7afc835e56 Update TM&B in About section of docs (#1182)
* Update TM&B in About section of docs

- Add disclaimers for Intel trademarks
- Add asterisk for 3rd party trademarks
- Remove redundant asterisks (only first use needed)

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

* Adds "See Note below" for legacy support of `systemd-networkd`.

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

Co-authored-by: Michael Vincerra <michael.vincerra@intel.com>
2020-06-02 09:53:22 -07:00
Kristal Dale 9917676b92 Update TM&B in Get Started section of docs (#1184)
- Add disclaimers for Intel trademarks

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-06-02 09:21:35 -07:00
michael vincerra 0866c4a17f Revises tutorial ratings flowchart for logical coherence. (#1176)
- "Will impact of errors cause system failure" had 2 "yes" outputs.
- Export flowchart as SVG for improved scalability in web/mobile
- Closes #1175

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-05-21 11:34:49 -07:00
Kevin Putnam 203882bc7e Update to Sphinx 2.2.0 to update jquery.js to 3.4.1 (#1179)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-05-21 10:38:52 -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 408f5965a7 Add 3 tutorials to tutorials index for discoverability. (#1173)
- Closes #1171

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-05-20 08:38:37 -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
michael vincerra 659052ef96 Revise tutorial index to Low, Moderate, Difficult per CL meeting. (#1170)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-05-15 16:53:45 -07:00
bktan8 75f5e6d3b7 Shorten WordPress, LAMP, HPC tutorial titles (#1168)
Closes #1167

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-15 16:25:23 -07:00
bktan8 3a28d5d548 Tutorial: Create a mirror of upstream update server (#1153)
Closes #1133

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-15 16:22:42 -07:00
Kevin Putnam aa214223a5 Add reDocs GUI support (#1117)
* Adding support for reDocs GUI to Clear Linux Docs repo.

1. Added .tox and MANIFEST to .gitignore
2. Added py rule to make.bat to enable building of bundles.html.txt in Windows
3. Added .tox to exclude_patterns in conf.py
4. Added tox.ini and setup.py support files to project.

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

* Updated setup.py with Clear Linux docs info.

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

* Small adjustment.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-05-12 17:45:00 -07:00
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
Kevin Putnam c42a0fe16c Add tri-weekly linkcheck (#1151)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-05-05 11:30:04 -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