Commit Graph

34 Commits

Author SHA1 Message Date
Michael Vincerra 8cce36d61f Fixes format for contents: directive
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-12 10:41:51 -07:00
Michael Vincerra bdfa11846e Adds :contents: directive to Clear Linux collaboration guide.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-11 17:09:18 -07:00
mvincerx e65963e72d Merge pull request #181 from puneetse/edit/ps-image-types-reference
Update document describing image types
2018-06-29 14:12:54 -07:00
Michael Vincerra 5379715cf9 Corrects Sphinx syntax, spelling, and document formatting.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-29 13:40:53 -07:00
puneetse 053d57c682 Move image types document from guide to reference 2018-06-28 12:35:44 -07:00
mvincerx 3bcb776ef1 Merge pull request #170 from mvincerx/mv-edits-compatible-kernels
Applies grammatical and trademark edits:
Removes broken hyperlink.
2018-06-27 13:47:48 -07:00
Michael Vincerra 23364b05a3 Removes external hyperlink from Intel Clear Containers:
- Reason: Previous page to which it was linked was removed.

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-27 13:40:57 -07:00
Michael Vincerra 54cfae7152 Corrects Sphinx syntax, URL; and prepends commands with sudo.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-21 13:55:49 -07:00
Michael Vincerra 1e3cab5c97 Applies grammatical and trademark edits:
- Linux kernels are updated per clr/bundles active status
- Fulfills JIRA CLEAR 3107
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-20 11:26:40 -07:00
Sethi, Puneet 795080b740 Add bundle search and help command
-Add command to search for bundles and reference to online bundle-list

- Add swupd help as additional information

- Reformat commands with switches but no parameters as commands instead of code-blocks
2018-06-18 15:15:23 -07:00
Michael Vincerra b363a1ec23 Updates to remove status column and verfiy current bundles.
- Remove status column in bundles.html table, omitting active, wip
- Use `swupd bundles-list --all` to validate all current bundles, pundles

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-08 15:51:01 -07:00
Michael Vincerra be614f0326 Rebuilds bundle.html manually combining two scripts:
- http://kojiclear.jf.intel.com/cgit/projects/bundle-tools¸ ./gendocs.sh
- script provided by matthew johnson, https://github.com/clearlinux/clear-linux-documentation/issues/126

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-07 17:58:49 -07:00
Michael Vincerra aa46fc70af Adds <thead>, <tbody> tags to table, missing from gen-docs.sh
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-03 17:29:11 -07:00
Michael Vincerra d9dd767f85 Updates available bundles and includes pundles.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-03 16:33:59 -07:00
MCamp859 78d4e0720a Incorporated review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-26 14:53:19 -04:00
MCamp859 22b3d76759 Created how-to-clear-overview as a summary of the How to Clear training.
Updated Reference file and added training overview.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-25 13:40:43 -04:00
Ecouzens 24ab40b3b4 copy edit and language update
Signed-off-by: Ecouzens <evan.couzens@intel.com>
2018-02-27 09:35:26 -08:00
Hayden d7862de653 Removed unnecessary brackets.
Removed unnecessary brackets from date.
2018-01-07 00:22:16 -05:00
Rodrigo Caballero f5f825b47f Add collaboration.rst to the Reference content toctree.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-12 16:47:44 -06:00
William Douglas d20ae56f2f Update cpu instruction set requirements
Set requirements to reflect those instructions that gcc will use when
building for the westmere target architecture as that is how Clear
Linux is currently being built.
2017-12-12 22:22:18 +00:00
Rodrigo Caballero c840c721d2 Merge pull request #40 from clearlinux/doc-guide
Add documentation contribution guidelines.
2017-12-11 12:06:13 -06:00
Rodrigo Caballero 9a876dd542 Fixed line length, typos, and minor markup issues.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-11 10:14:17 -06:00
Rodrigo Caballero b874bafdbb Fixed typos and removed unneeded content.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-11-30 15:56:57 -06:00
Rodrigo Caballero 76109e7d1a Improved the Basic contribution, Images, and Cross-reference sections.
Added explicit instructions on how to contribute via GitHub, naming conventions
for all files, and explicit markup instructions for figures, links, and headings.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-11-30 15:28:30 -06:00
Marko Cubela 5e34e0b9d1 fix hyperv link 2017-10-14 11:05:56 +02:00
Rodrigo Caballero aee95cd862 Merge pull request #35 from 01org/usb-minimum-reqs
Makes get started content modularized. Updates HW requirements.
2017-09-21 14:33:08 -05:00
bktan8 86f8cc9c6e Update system-requirements.rst 2017-09-20 14:35:52 -07:00
Rodrigo Caballero 1d7f1c2d14 Add documentation contribution guidelines.
This section contains all the guidelines, rules, examples, and templates needed
to contribute content to the Clear Linux project. The mechanics on how to use
Git to contribute the content will be added in the future.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-13 10:58:30 -05:00
Rodrigo Caballero 3c5048cc77 Add the kvm-host bundle reference information.
This information is needed until the KVM issues it addresses are fixed.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-11 08:51:50 -05:00
Rodrigo Caballero d73441d6b6 Update available bundles table.
This update to the table of available bundles makes the HTML table a
separate file to make updating easier. This is necessary to automate the
update process in the future.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-08 14:25:35 -05:00
Ianeta Hutchinson b70580ed60 Title change: Recommended minimum system requirements 2017-09-06 13:34:58 -07:00
ihutchin c44d12a6d9 Makes get started content modularized. Updates HW requirements.
Creates new bootable-usb options for macOS and windows. Changes
live image and bare metal installs to include modularized options.
Removes hard-coded numbering in bare metal install. Updates toc
trees where appropriate.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-09-05 19:59:20 -07:00
ihutchin 7cb9cb0720 Updated file titles and descriptions to improve readability.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-08-29 18:39:53 -07:00
ihutchin 622b8c0a3e Restructures Clear Linux documentation to have five main sections
Content files are moved, renamed, and relabeled to fit into get started,
concepts, guides, tutorials, and reference sections. Toc-trees were
changed where apropriate and section descriptions were provided.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-08-29 13:18:21 -07:00