* Adds targets for include in source doc.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Adds include directive pointing to new targets in kernel-modules-dkms
- Keep documentation DRY and modular.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Initial conversion of markdown guide
* More formatting
* Update zfs.rst
* Acknowlege @zaffle and @rincebrain's work in the clear repo
* Update zfs tutorial to reflect a DKMS build
* Clean up zfs tutorial
* For clarity
* Start working on ZFS on Root outline
* Update zfs.rst
* Sentence casing
* Update zfs.rst
* Add ZFS to the tutorials list
* Fix derp
* Formatting and simplification of language
* Remove ZFS on root for now
* Update zfs.rst
* Update zfs.rst
* More formatting
* Merge
* Move links to end note format
* More formatting and wording
* Link to article on ZFS mount generator
* Typo - Update source/tutorials/zfs.rst
Co-authored-by: Brett T. Warden <4c0e8e88@tm.wgz.org>
* Typo - Update source/tutorials/zfs.rst
Co-authored-by: Brett T. Warden <4c0e8e88@tm.wgz.org>
* Capitalize LTS - Update source/tutorials/zfs.rst
Co-authored-by: Brett T. Warden <4c0e8e88@tm.wgz.org>
* Capitalize LTS - Update source/tutorials/zfs.rst
Co-authored-by: Brett T. Warden <4c0e8e88@tm.wgz.org>
* Remove sudo from systemd 01-zfs.conf creation -- Update source/tutorials/zfs.rst
Co-authored-by: Brett T. Warden <4c0e8e88@tm.wgz.org>
* Add caution to Background section per PR feedback.
* Remove -dev bundle installation -- not necessary
* Symlink services into /etc/systemd. Add note about other services.
* Remove sig_unenforce since DKMS does this for us
* Add troubleshooting info to Caution section
* Address more PR feedback -- Link ZFS on Linux repo
* Revise wording for legal compliance and correct syntax.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Respond to reviewer feedback on wording; add sudo to commands as applicable.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Incorporate reviewer feedback on wording, organization, commands.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Clarify OpenZFS kernel modules must be loaded before mnounting OpenZFS.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
Co-authored-by: Brett T. Warden <4c0e8e88@tm.wgz.org>
Co-authored-by: Michael Vincerra <michael.vincerra@intel.com>
* 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>
- Improve discoverability of install-configfile; add link in intro
- Closes#1083
- Adds related topics.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Align bare-metal-install-* docs with clr-installer verify-iso-integrity
- New clr-installer feature, uses checksum to verify ISO image
- See also: https://github.com/clearlinux/clr-installer/pull/737
- Closes#1185
- Adds new section, Choose boot menu option.
- Figure 01 revised in bare-metal-desktop and -server
- Changes hierarchical levels of headers for consistency.
- Removes Software(optional) section from bare-metal-install-desktop
- Latter section is not relevant to installation process; no value
- Respond to reviewer feedback on wording.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Wording revisions per reviewer feedback.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
- 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>
* 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>
* 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>
- "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>
* 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>
- 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>
* 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>
* 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>
* 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>
- 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>
* 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
- 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>
KJM