Explicitly set language to 'en' to quell Sphinx warning:
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
Password hashes in the installer configuration yaml are written as-is to `/etc/shadow`. The backslashes preceding `$` are unnecessary and produce an invalid hash string that will prevent login.
* Update zfs.rst
Update guide for OpenZFS 2.0.0
* Update zfs.rst
Corrected a few typos and modified styling / organization.
* Update zfs.rst
Slight corrections after having tested this.
* guides: Add new Kubernetes migration guide
This guide provide direction in upgrade Kubernetes from the
1.17.x release up to the 1.19.x release due to Clear missing
the 1.18.x release.
Signed-off-by: Mark D Horn <mark.d.horn@intel.com>
* Corrects reST syntax for proper display of code-blocks, - For correct indentation levels when substeps appear - To correct "For each of the other notes..." to "nodes..." - To use list-table to show kubeadm component configs - To retitle ref label to "_kubernetes_migration", prev not unique - TBD: Waiting on actual hyperlinks, not prev included.
Signed-off-by: michael vincerra <michael.vincerra@intel.com>
* guides: Fix the links for k8s-migration
- Rename the new guide
- Fix references and links
- Fix formatting
Signed-off-by: Mark D Horn <mark.d.horn@intel.com>
* Corrects copyright value in conf.py.
Signed-off-by: michael vincerra <michael.vincerra@intel.com>
Co-authored-by: michael vincerra <michael.vincerra@intel.com>
The create_stack.sh script requires git to complete fully. Perhaps this should be added to the setup_system.sh script, but until it does, this change allows the steps to complete without error.
* 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>
William Douglas