29 Commits

Author SHA1 Message Date
michael vincerra
830f35e59c Remove UEFI requirement per clr-installer release. (#1208)
* Remove UEFI requirement per clr-installer release.
- https://github.com/clearlinux/clr-installer/pull/666
- Closes #1207

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

* Add hyperlink ref to clr-boot-manager readme for expl and options.

Signed-off-by: michael vincerra <michael.vincerra@intel.com>
2020-10-06 11:25:00 -07:00
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
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
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
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
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
2327247a29 Add min. required disk space for bare-metal-install-desktop and bare-metal-install-server (#1004)
* Adds min. required disk space for live-server and -desktop install.

Closes #1001

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

* Removes cruft.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-01-27 09:10:27 -08:00
Kevin Putnam
10d167b543 Fixes link that was hardcoded to point to clearlinux.org/documentation ... (#986)
Now uses :ref: to same page.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-01-10 12:25:18 -08:00
R Primus
9095e06aad https://github.com/clearlinux/clear-linux-documentation/issues/857: F… (#885)
* https://github.com/clearlinux/clear-linux-documentation/issues/857: Fix assorted typos

* Update for changes made since initial cloning of repository

* Fix case of word
2019-10-28 16:32:46 -07:00
Kristal Dale
0fcb703eeb Remove AES requirement from Sys Req doc (#859)
Remove AES requirement from the recommended minimum system requirements.
AES has been removed as a hard requirement for installation.

Closes #840

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-15 15:37:29 -07:00
Mary Camp
c811324028 Upleveled Contribution guidelines, edited text. (#848)
* Upleveled Contribution guidelines, edited text.

Signed-off-by: MCamp859 <maryx.camp@intel.com>

* Simplify doc title and sub-bullets under Contrib. guidelines per standup, 10/10/19.
Closed GH-828.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-10 18:16:23 -07:00
Kevin Putnam
29d9bd2233 Fixed broken link to dev mailing list. (#843)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-04 15:03:45 -07:00
michael vincerra
22e1af3d7e Corrects SIMD extensions from 4.1 to 4.2. (#813)
- Closes #809

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-20 15:10:21 -07:00
michael vincerra
d2396a6b4f Bundle lister update (#725)
* Revises to simplify and refine code:
- Removes regex PATTERN4 and 5
- Revises PATTERN3 to exclude comments on custom additions
- Removes pundler() because no longer a clr-bundles directory

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

Removes cruft code.

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

Edit for rebase.

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

* Removes decode() for string in extractor().

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

* Applies .bundledesc css to <p> tag on includes().

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

* Modifies html tags in template and styles.css.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-08-14 10:17:20 -07:00
Kristal Dale
a8aa87ec9d Remove redundant content + associated clean up
- Remove concepts (content migrated to Clear guides)
- Remove reference for bundle commands (quick ref in swupd guide)
- Moved bundle about page to Clear guide
- Updated links to concepts page, to instead link to the associated guide

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-07 16:54:15 -07:00
Kevin Putnam
ef133322bd Merge branch 'rtd-theme' into development
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-01 16:57:12 -07:00
Kevin Putnam
e16ffe2f9b Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-01 15:59:06 -07:00
Kevin Putnam
d9f3ac31ad Changed reference and tutorial landing pages to index to improve URLs.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-31 14:26:17 -07:00
Kevin Putnam
ef4c06cd61 Changed landing pages names from dir name to index to improve URLs.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-31 13:57:58 -07:00
Kevin Putnam
ac7d52e512 Create about page and move Clear Linux specific content to guides/clear.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-29 12:51:04 -07:00
Kevin Putnam
69378a5408 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-22 11:53:11 -07:00
Kristal Dale
a5ca3d3744 Update tooling landing page to include reference to and summary of
the how-to-clear training. Remove how-to-clear overview in preference
of the overview on tooling page.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-07-17 17:23:40 -07:00
Kevin Putnam
3e1e8291bd copmleted move of old stuff
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-17 11:12:24 -07:00
Kevin Putnam
5744070a85 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-17 10:15:27 -07:00
Kevin Putnam
24e812f707 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-07-11 12:34:00 -07:00
Kevin Putnam
88c7dc1264 Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-02 10:38:18 -07:00
Kevin Putnam
7caea349e3 Additional proposed fixes to organization for RTD site.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-07 08:47:45 -07:00
Kevin Putnam
8a07199ef0 Removed superfluous layer from documentation hiearchy and renamed master doc from clear-linux.rst to index.rst to generate a cleaner url.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-06 12:26:58 -07:00