Compare commits

..

1505 Commits

Author SHA1 Message Date
Beth Dean d35522aee4 Update telemetry-about.rst
updated telempostd description, kept at high level, will provide more detail in other documentation.  Also changed |CL| to |CL-ATTR| for first instance.
2018-09-27 13:02:42 -07:00
Beth Dean 95618807d3 updates to relect telemetry client refactoring, changes telemd to telempostd & telemprobd 2018-09-26 14:38:35 -07:00
michael vincerra 0b961155d5 Merge pull request #244 from balcsida/patch-1
Fix typo
Merged. Good catch.
2018-09-26 09:08:33 -07:00
Dávid Balatoni d3880ce8d8 Fix typo 2018-09-25 10:34:59 +02:00
michael vincerra f575df49a6 Merge pull request #240 from mvincerx/mv-edits-source-index
Omits toctree ref to clear-containers; resets maxdepth to 1.
2018-09-20 16:09:39 -07:00
Michael Vincerra f316932ef2 Omits toctree ref to clear-containers; resets maxdepth to 1.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-20 11:46:06 -07:00
michael vincerra acfcd7a121 Merge pull request #239 from mvincerx/mv-edits-swupd-search1
Applies edits for clarity; applies attributions and trademarks.
2018-09-20 08:59:01 -07:00
Michael Vincerra 14fd18edc9 Adds more underline to address sphinx build failure.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-19 16:25:57 -07:00
Mike Tullis 5e191ae3d4 Merge pull request #238 from mvincerx/mv-edits-available-bundles5
Revise child, available-bundles, to bundles so it appears in navigation menus.
2018-09-19 12:17:01 -06:00
Michael Vincerra a7fa43ddcd Applies trademark edit to Kata.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-19 10:43:29 -07:00
Michael Vincerra 6912afdcd4 Simplifies bullets under Related Topics.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-19 10:30:39 -07:00
Michael Vincerra 8a8b31f2b6 Revises wording for clarity; applies branding attributions.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-19 09:58:32 -07:00
Michael Vincerra b889f8fa22 Updates instances of Clear Linux using proper substitutions.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-18 16:43:49 -07:00
Michael Vincerra 90b728d13a Revises hyperlink target to omit problematic special characters.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-18 14:05:42 -07:00
Michael Vincerra 4e24f2e89d Changes line break for Sublime to recognize hyperlink.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-18 13:56:49 -07:00
Michael Vincerra 8c44749f72 Adds empty space before <target> reference.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-18 13:37:11 -07:00
Michael Vincerra 76a40083e3 Revises hyperlink ref to available bundles to make it unique.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-18 13:30:23 -07:00
Michael Vincerra acd86c2149 Adds missing hyperlink for Intel® Virtualization Technology.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-18 09:28:40 -07:00
Michael Vincerra c4d3a7d598 Fixes underline length in header.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-18 09:19:09 -07:00
Michael Vincerra d57c051e89 Updates to |CL-ATTR| where necessary.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 16:16:25 -07:00
Michael Vincerra 10f9fb9daf Updates in-text reference to <bundles>; omits URL method.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 16:12:15 -07:00
Michael Vincerra a0ac2fd124 Updates reference to new doc title bundles and |CL-ATTR|.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 16:03:49 -07:00
Michael Vincerra 6ed3f93b87 Updates reference to new doc title bundles and |CL-ATTR|
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 15:59:37 -07:00
Michael Vincerra 5258f1abe3 Updates reference to new doc title bundles and |CLR-ATTR|.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 15:49:04 -07:00
Michael Vincerra 4e9dbf8505 Updates reference to new doc title <bundles> page.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 15:44:41 -07:00
Michael Vincerra 92093be98c Changes file name reference to :ref:bundles
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 14:50:12 -07:00
Michael Vincerra 243e0703ff Changes internal file name at top to ..bundles:
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 14:45:57 -07:00
Michael Vincerra ef893406be Renamed available-bundles.rst to bundles.rst
- Purpose: So bundles.rst shows up under bundles folder.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-17 14:16:04 -07:00
michael vincerra 67bbcd60cd Merge pull request #236 from krisdale/kd-validate-signatures-edit
Correct commands in validate signatures instructions
2018-09-14 16:56:12 -07:00
michael vincerra 6255b69307 Merge pull request #235 from mvincerx/mv-edits-available-bundles4
Adds correct date when bundles were updated.
2018-09-14 15:36:46 -07:00
Kristal Dale c1878b35d4 Corrected minor typo.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-09-14 15:06:41 -07:00
Kristal Dale 38e37a0e45 Update validation steps to reflect updated process:
- remove leading './' for step 4 of Image content validation
- remove important note for step 4 of Image content validation
- correct file name for step 1 of Update content validation from Manifest.sig to Manifest.MoM.sig.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-09-14 14:56:11 -07:00
michael vincerra ed6eab4fd2 Merge pull request #234 from mvincerx/mv-update_flatpak_tutorial_gif
Applies Sphinx syntax and branding edits:
2018-09-14 14:49:35 -07:00
Michael Vincerra fca6168266 Adds |CL-ATTR| to title for maintainability.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-14 14:47:44 -07:00
Michael Vincerra 551e34e7f4 Adds correct date when bundles were updated.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-14 10:33:36 -07:00
Michael Vincerra 71ebc35287 Adds |CL-ATTR| on first use in body text to reflect branding change.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-14 10:16:11 -07:00
Michael Vincerra 12e17d7883 Applies Sphinx syntax and branding edits:
- Revises headers to follow convention per collab guidelines
- Revises CL in accordance with new branding
- Removes `$` for CLI prompts and corrects code-blocks to bash
- Adds sentence in para 2, `download it here`, a previously unused link

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-13 18:19:48 -07:00
michael vincerra afea723c4b Merge pull request #232 from mrkz/update_flatpak_tutorial_gif
Update flatpak tutorial
2018-09-13 17:59:16 -07:00
michael vincerra 2ee73cec40 Merge pull request #213 from puneetse/add/ps-security-concept
Add document highlighting security in Clear Linux
2018-09-12 11:38:20 -07:00
puneetse 2a448cc415 Implement fixes raised by @mvincerx 2018-09-12 11:35:03 -07:00
michael vincerra e33b854a90 Merge pull request #230 from alexjch/typo-errors
Fix for document inconsistencies
2018-09-12 09:49:13 -07:00
michael vincerra f9d170afe3 Merge pull request #217 from mvincerx/mv-edits-virtualbox01
Update VirtualBox get-started to reflect changes to CL kernel LTS 4.14:
2018-09-12 09:44:52 -07:00
Michael Vincerra 4e0adfa689 Removes note re LGA and reverts content per request.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-12 09:43:00 -07:00
michael vincerra 3e31b00b91 Merge pull request #229 from mvincerx/mv-edits-available-bundles3
Add pundle descriptions and update bundles manually.
2018-09-12 09:35:50 -07:00
Mike Tullis fc87dbb0d2 Merge pull request #231 from krisdale/kd-update-name-subs
Update official Clear Linux name
2018-09-12 10:22:44 -06:00
Michael Vincerra 0f40fefb61 Adds intro paragraph under Install Guest Additions.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-11 17:10:13 -07:00
Michael Vincerra 80fe620b3c Adds back content starting at Line 150 per bwarden.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-11 17:04:46 -07:00
puneetse a79bb5b7a3 Fix indents 2018-09-11 16:59:43 -07:00
Michael Vincerra 91ce6c3590 Updates all bundles' includes; final phase of review.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-11 16:14:05 -07:00
puneetse 28f0b5eacf Implement changes brought up by @mvincerx 2018-09-11 15:16:58 -07:00
Simental Magana, Marcos 4f80aecda3 clear-linux/tutorials/flatpak/figures: cleanup
this commit removes the *png files that are no longer used
for the flatpak tutorial.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2018-09-11 14:51:32 -05:00
Simental Magana, Marcos 00cd5de43d clear-linux/turorials/flatpak: update tutorial
This commit updates the Flatpak tutorial to make use
of the gnome-software application and keep the command
line setup as well.

LibreOffice flatpak repository changed to Flathub.
This commit  updates the instructions to install it
as documented in https://www.libreoffice.org/download/flatpak/

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2018-09-11 14:51:32 -05:00
Michael Vincerra 170f68c977 Revises bundle includes through service-os-dev.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-10 16:47:27 -07:00
puneetse d67da866d1 Implement some changes requested by @mvincerx 2018-09-10 16:13:33 -07:00
Kristal Dale 37811ae11f Update the official Clear Linux product name:
- Substitutions
- Python config file
- Replace hard coded product name in page heading with sub on CL doc landing page
- Replace hard coded product name with sub in system-requirements

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-09-10 15:57:22 -07:00
Michael Vincerra caed282b6d Revises and updates bundles from ImageMagick to cloud-control.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-10 10:56:45 -07:00
Alex Jaramillo 941501f262 Fix for document inconsistencies
* Changed directory name for mixer workspace where the workspace is given
a path and further in the document the workspace path different, this
leads to an error when using correct procedure specified in document.
This change uses the same directory path.

* Fix for a typo where the correct default value for a configuration
file name is incorrect and when copying value from document will lead to
errors when following proper procedure specified in document.

Signed-off-by: Alex Jaramillo <alex.v.jaramillo@intel.com>
2018-09-10 09:33:47 -07:00
michael vincerra 4fa71378eb Merge pull request #225 from krisdale/kd-clear-linux-edits
Revise text to clean up transition between the title/description for …
2018-09-09 11:37:57 -07:00
Michael Vincerra abe6932a64 Adds more pundle descriptions:
- from systemd-cryptsetup to zsh

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-09 11:08:34 -07:00
Michael Vincerra 5d4447281e Adds more descriptions of pundles up to "suricata".
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-08 22:32:23 -07:00
Michael Vincerra 84bb9e9857 Adds descriptions for pundles per CLEAR-3685. Phase 1.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-07 18:01:42 -07:00
michael vincerra c417d87125 Merge pull request #228 from mvincerx/mv-edits-swupd-search
Omit internal doc TOC; only two subheads, unnecessary.
2018-09-07 16:56:11 -07:00
Michael Vincerra 0fcde11cce Omit internal doc TOC; only two subheads, unnecessary.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-09-07 15:45:42 -07:00
michael vincerra 27aba465b5 Merge pull request #216 from krisdale/kd-swupd-about-edits
Revised intro on Software update concepts page
2018-09-07 14:01:09 -07:00
Kevin Putnam 260f5e4969 fixed wording of PAM cracklib bullet 2018-09-06 14:27:13 -07:00
Kevin Putnam ea713be3fb Merge pull request #221 from puneetse/add/ps-deploy-at-scale-guide
Add guide for deploying at scale
2018-09-06 14:11:03 -07:00
Kevin Putnam 468d7b6ced Merge pull request #223 from puneetse/edit/ps-vmware-docs
Revise VMware ESXi document introductions
2018-09-06 14:10:24 -07:00
Kevin Putnam dae467c115 slight modifications to vmware-esxi-installs 2018-09-06 14:07:56 -07:00
Kevin Putnam fd209affcd fixed 3rd reference to WEB-SERVER-SCALE and dangling and 2018-09-06 13:47:38 -07:00
Kristal Dale 648276de82 Updated Clear Linux official name in documentation substitutions.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-09-06 13:41:00 -07:00
Kristal Dale 9081f8e97d Revise text to clean up transition between the title/description for each documentation section. Hide TOC so there
is not a duplicate toc in page.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-09-04 14:43:49 -07:00
Kevin Putnam 878af25d9e Corrected some typos and made some wording adjustments. 2018-08-30 14:27:09 -07:00
puneetse 20cb86a11d Add abbr to CVE and RST syntax fixes 2018-08-30 14:10:36 -07:00
puneetse febbb7af87 Add link to ister and cloud-init guide 2018-08-29 16:56:40 -07:00
puneetse c92b616aee Rephrase flexibility of manua install 2018-08-29 16:48:41 -07:00
puneetse 7cd79e72e7 Merge branch 'master' into add/ps-deploy-at-scale-guide 2018-08-29 13:24:23 -07:00
puneetse 58ca30f1bb Add doc to guides TOC 2018-08-29 13:21:57 -07:00
puneetse f1c2a0bfd9 Make introductions to VMware docs consistent 2018-08-29 13:20:10 -07:00
puneetse 826dd7faf2 Clarify difference between vmware docs 2018-08-29 10:14:52 -07:00
puneetse 23a47af45d Change to dynamic TOC 2018-08-29 10:12:57 -07:00
puneetse 6aecafbb22 Revise latest Linux section 2018-08-28 16:19:15 -07:00
puneetse e3ea11ab08 Expand and escape first CL mentions 2018-08-28 15:51:11 -07:00
puneetse 0e422f4733 Implement some changes requested by @intelkevinputnam 2018-08-28 15:47:36 -07:00
puneetse 700f2d754b Implement some changes requested by @intelkevinputnam 2018-08-28 15:40:06 -07:00
puneetse 1258c5d4f4 Implement some changes requested by @intelkevinputnam 2018-08-28 15:36:14 -07:00
puneetse e78e3eff1b Fix some RST syntax 2018-08-28 15:28:35 -07:00
puneetse 4143c261bc Merge branch 'master' into add/ps-security-concept 2018-08-28 14:05:22 -07:00
puneetse a6a24fc132 Add security doc to to concept toctree 2018-08-28 14:00:09 -07:00
puneetse a208cc8d84 Merge pull request #3 from clearlinux/master
update from upstream master
2018-08-27 16:11:13 -07:00
puneetse c47f74cac5 Fix grammatical error 2018-08-27 13:36:32 -07:00
Kevin Putnam 1c1f2b3fa6 Merge pull request #222 from intelkevinputnam/kp-fix-fmv
asm code-block is not recognized by sphinx 1.2.2
2018-08-24 10:33:56 -07:00
Kevin Putnam 90418a9195 asm code-block is not recognized by sphinx 1.2.2 - changed to :: 2018-08-24 10:23:46 -07:00
Kristal Dale 155d3f1bc9 - corrected term grammar
- updated page to use CL substitution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-08-23 14:31:47 -07:00
puneetse 15a81d1347 Fix a couple minor typos 2018-08-23 08:01:32 -07:00
puneetse d4a07f4470 Add OSV abbreviation 2018-08-22 16:09:50 -07:00
puneetse 0a83102459 Fix more typos 2018-08-22 16:00:59 -07:00
puneetse f252dce315 Fix a few typos noticed by @tpleavitt 2018-08-22 15:46:36 -07:00
Kristal Dale 9c93967789 - Corrected reST syntax
- Removed quotes on terms, italicized first use of new term
- Removed multiple, redundant reference to full CLOSIA text, in favor of shorter, more readable 'Clear Linux'
- Minor edits to Bundles section, to make non-user type specific
- Added heading to mixer tool paragraph, link to concept page (so sections mirror order of intro paragraph, clarify topic as separate from Update speed section)
- Remove commands to enable/disable (we don't focus on this level of detail anywhere else in this page - it is about the concepts and links to details where needed)

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-08-22 15:40:54 -07:00
puneetse ca3e88d7cc Implement some feedback from @nesiusra 2018-08-21 12:22:38 -07:00
puneetse 406aa79b6c Revise minimized attack surface section 2018-08-21 10:51:54 -07:00
Kevin Putnam 5f8fe10c88 Fixed TOC tree syntax error
Depth option was missing ':' and ':local:' was on the same line as the contents directive.
2018-08-17 14:32:49 -07:00
michael vincerra 700707f438 Merge pull request #215 from mvincerx/dev-workstation
Add dev workstation to cater to developers' needs to find and add minimum bundles.
2018-08-17 11:12:18 -07:00
Michael Vincerra 2ad5774038 Revised wording in intro.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-17 11:11:10 -07:00
Michael Vincerra 3a110c77a7 Adds note regarding adding multiple bundles.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-17 11:09:46 -07:00
Michael Vincerra 13c6cfd571 Refines swupd search options, -b; revises wording in dev-workstation.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-17 11:03:26 -07:00
michael vincerra 0af368dfa6 Merge pull request #214 from mvincerx/guides-vs-tutorials
Define guides vs tutorials
2018-08-16 17:47:39 -07:00
Michael Vincerra d0d95ce789 Removes repetitive "Find" from bulleted list.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-16 17:45:09 -07:00
Michael Vincerra 04c3a56b45 Revises bullet 3 to clarify justification of guides' usage.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-16 17:40:49 -07:00
Michael Vincerra b93737553e Revises documents:
- Adds notes to swupd-search to clarify scope of functionality
- Revised develoepr-workstation table and copyedits for clarity.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-16 17:29:44 -07:00
Mike Tullis 2bb84715b9 Merge pull request #220 from intelkevinputnam/kp-compat-hw
Fixed TM and brand references
2018-08-16 13:28:45 -06:00
Kevin Putnam 33d77d9b89 removed extra processor mentions and shifted other TM * to better match standard usage 2018-08-16 12:19:39 -07:00
Kevin Putnam ed264ca10d Restored original TOC Tree order in reference.rst
Did not fix
2018-08-15 17:59:29 -07:00
Kevin Putnam 973ec261a1 Fix compatible hardware link problem
switched location in TOC tree
2018-08-15 17:45:48 -07:00
Kevin Putnam 6a996309a3 Merge pull request #219 from clearlinux/compatible-hw
Lists hardware compatible with Clear Linux
2018-08-15 17:37:37 -07:00
ihutchin 97948d6903 Fixing copyright markings
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2018-08-15 17:33:46 -07:00
ihutchin adaf3159ae Adding trademark \*'s to platforms
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2018-08-15 17:26:33 -07:00
ihutchin 29e0f275fa Including trademarks
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2018-08-15 17:12:11 -07:00
Michael Vincerra 1bea0ec609 Reduces wordiness of descriptions.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-15 16:52:34 -07:00
Michael Vincerra acfa8fcd91 Simplifies problem statement of Example section more.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-15 16:39:11 -07:00
Michael Vincerra 849db054ee Reduceslength of preface in Example section.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-15 16:36:15 -07:00
Michael Vincerra 49ae1ad3dc Removes note re -dev versions of bundles; copyedits for legibility.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-15 16:27:58 -07:00
ihutchin 94a7cb4010 Add not all inclusive clause
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2018-08-15 16:18:36 -07:00
Michael Vincerra a244881bac Replaces Python with new Kata guide in swupd-search; revises dev workstation.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-15 15:27:06 -07:00
ihutchin 0f64b8deb7 List of hardware compatible with Clear Linux
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2018-08-15 13:59:20 -07:00
puneetse ddadce7857 RST syntax fixes and minor intro edit 2018-08-14 16:31:37 -07:00
puneetse 6c3e1964f2 Add document for deploying Clear at scale
Inital add for deploying Clear Linux at scale.
2018-08-14 16:24:40 -07:00
Michael Vincerra 1f95d68954 Revisions made for logical flow and toc:
- Reorder inclusion of swupd-search in developer-workstation
- Add swupd-search to toctree of maintenance.rst
- Revise FAQs in swupd-search

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-14 15:46:09 -07:00
Michael Vincerra 8a0c7387b4 Update documentation to reflect changes to CL kernel LTS 4.14:
- Replace "Install VirtualBox" with Prerequisites
- Add new hyperlink to troubleshoot enabling VT on IA (previous unhelpful)
- Replace section  "Linux Guest Additions" with note on LTS integration.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-14 12:07:03 -07:00
Michael Vincerra 5a33a42730 Revises files to clarify purpose and to add references to swupd-guide.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-13 12:12:19 -07:00
Kristal Dale 9689ac0eeb Draft edits
- Updated intro, emphasis on introducing CL update compared to traditional update
- Removed the (repeated) definition of the traditional wya, already used elsewhere
- Removed intro paragraph heading to be more consistent with layout of other concept pages
- Added link to bundles page from bundles section
- Moved 'using swupd' link to Updating section (from bottom of page where it came after mixer discussion)

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-08-10 15:24:58 -07:00
puneetse 224f1c3c24 Minor edits 2018-08-10 12:56:21 -07:00
Michael Vincerra fd33bb2f79 Adds swupd-search to illustrate how to search and add bundle.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-09 18:38:31 -07:00
Michael Vincerra ae8f303b35 Adds developer-workstation to cater to developers' needs.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-09 18:37:48 -07:00
Michael Vincerra c84c7af336 Adds developer-workstation to parent TOC
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-09 18:37:05 -07:00
Michael Vincerra 769c922fbc Revises wording of tutorials for simplicity.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-09 16:51:38 -07:00
Michael Vincerra 51ceff5817 Redefines guides and tutorials by:
- Revising clear-linux top-level TOC
- Adding a clear definition of what a guide is
- Adding a clear definition of what a tutorial is

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-09 14:57:15 -07:00
puneetse dd823416ce Remove ambigious note and formatting fixes. 2018-08-09 14:23:13 -07:00
puneetse bdf97e4c7e Initial commit of security.rst
A document describing design choices that highlight security in Clear Linux
2018-08-08 15:27:54 -07:00
michael vincerra 34487d2d46 Merge pull request #211 from mvincerx/mv-edits-documentation
Revises parent toctree depth from 2 to 3; show embedded toctree, rest…
2018-08-07 09:24:29 -07:00
Michael Vincerra d2ffc5f8ae Revises parent toctree depth from 2 to 3; show embedded toctree, rest.rst.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-06 10:16:32 -07:00
michael vincerra 543b255b6e Merge pull request #204 from mvincerx/bare-metal-installation
Replaces outdated screenshots for CL installation
2018-08-03 10:40:29 -07:00
michael vincerra bc5115df97 Merge pull request #209 from mvincerx/mv-edit-cross01
Inserts missing spaces after code-block.
2018-08-03 10:40:05 -07:00
Michael Vincerra a39a091926 Inserts missing spaces after code-block.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-03 10:38:10 -07:00
michael vincerra 11f5669991 Merge pull request #208 from mvincerx/mv-edit-cross
Mv edit cross
2018-08-02 16:50:12 -07:00
Michael Vincerra 8a264676da Tweaks bare-metal-install-8.png
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 16:44:56 -07:00
Michael Vincerra cddc32b1ca Resizes bare-metal-install-8.png
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 16:36:16 -07:00
Michael Vincerra 60b404a900 Crop and resize all to 1920x1080px
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 15:50:53 -07:00
Michael Vincerra b727b5f1e5 Resize same as previous.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 15:00:03 -07:00
Michael Vincerra a8b0555407 Resize cgdisk...-11.png
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 14:55:46 -07:00
Michael Vincerra f420164490 Resizes cgdisk-manual-install-11.png
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 14:48:46 -07:00
Michael Vincerra f0a130bbca Merge branch 'master' of https://github.com/clearlinux/clear-linux-documentation into bare-metal-installation 2018-08-02 14:32:55 -07:00
Michael Vincerra 93577dcec3 Revises and crops bare-metal-install-8 and cgdisk-manual-install-11
- Update screenshots to reflect current screens in installer

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 14:29:37 -07:00
Michael Vincerra 48095298ff Resizes and crops bare-metal-manual-install-9.png
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 14:06:13 -07:00
Michael Vincerra 121e6f1658 Resizes same image to 1920x1080px.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 11:50:28 -07:00
Michael Vincerra 1f84339237 Adds bare-metal-manual-install-9.png to test aspect ratio.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 11:40:51 -07:00
Michael Vincerra 5b39163851 Removes mod attempt from previous push.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 10:38:51 -07:00
Michael Vincerra 4cf7a21bc4 Adds URL for 'Sphinx documentation' close to its use.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-02 10:36:10 -07:00
Michael Vincerra ace4f38a59 Mod attempt to resolve reference to rest.rst, line 6 2018-08-02 09:26:04 -07:00
Michael Vincerra 7331b6d354 Confirms URI correct at bottom of page.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 17:34:29 -07:00
Michael Vincerra e6ea26dd82 Corrects URI, previously dead, and redirects to actual markup section.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 17:20:47 -07:00
Michael Vincerra af11db092a Fixes legacy error, extra line break, which broke URL.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 17:14:22 -07:00
Michael Vincerra 32d465787a Adds missing tick mark at end of include directive.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 17:08:57 -07:00
Michael Vincerra ab77c0c7a6 Add missing value for code-block in example.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 17:05:47 -07:00
Michael Vincerra e13738c0f5 Adds comparison of target and anchor, trad HTML usage.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 16:54:59 -07:00
Michael Vincerra 04055beee1 Describes actual use of include directive with use of targets.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 16:47:00 -07:00
mvincerx 50e9cbeb19 Merge pull request #207 from mvincerx/autospec06
Fixes typo in the `include` directive.
2018-08-01 11:19:45 -07:00
Michael Vincerra 30c9a19184 Corrects missing punctuation and corrects header on Overivew
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-08-01 10:03:05 -07:00
mvincerx a5e0dcc6e0 Merge pull request #205 from intelkevinputnam/kp-rm-warnings
Fixed last of the warnings in the Sphinx Build
2018-08-01 09:49:43 -07:00
Kevin Putnam ea4ce1a9e0 changed link and text 2018-08-01 09:29:58 -07:00
Kevin Putnam 288a3edd59 major edits to inline.rst including use of parsed-literal for rendered examples 2018-07-31 15:49:07 -07:00
Michael Vincerra bc4b4b673d Fixes typo in the include directive.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-31 12:07:02 -07:00
mvincerx db0ba5cce0 Merge pull request #206 from MCamp859/telem-fig-fix
Moved figure up a level to correct reference.
2018-07-31 10:41:47 -07:00
Kevin Putnam 10aece4ee2 fixed overall formatting of inline.rst 2018-07-31 08:22:28 -07:00
MCamp859 7074d43144 Moved figure up a level to correct reference.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-31 11:22:01 -04:00
Kevin Putnam 09fdf7747e fixed some line breaks 2018-07-30 16:28:45 -07:00
Kevin Putnam ae25316714 added line break 2018-07-30 14:45:10 -07:00
puneetse 4c85ddc01b Merge pull request #2 from clearlinux/master
Update from upstream master
2018-07-30 14:37:37 -07:00
Kevin Putnam ab15d98ddc Fixed the last of the warnings - not at zero 2018-07-30 14:25:56 -07:00
mvincerx 1b52463239 Merge pull request #198 from MCamp859/telemetry-edits
Add telemetry concept to CL docs.
2018-07-27 15:27:10 -07:00
MCamp859 27e2ab30a6 Corrected references and ref label spelling.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-27 13:41:08 -04:00
Michael Vincerra f429d58d6e Adds parentheses for 'automatic'
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-26 17:24:35 -07:00
Michael Vincerra 7d8c5dde9f Replaces outdated screenshots for CL installation
- Retitles bare metal 'manual' for parallelism
- Retitles bare metal 'automatic' for parallelism

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-26 17:19:57 -07:00
MCamp859 51cf60b2d2 Incorporated review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-26 16:32:37 -04:00
mvincerx cb51dfddbf Merge pull request #203 from MCamp859/kata-docs-update
Updated kata and kata_migration tutorials.
2018-07-26 11:58:21 -07:00
mvincerx bd281c65c2 Merge pull request #202 from mvincerx/autospec05
Appends ':' to the end of the target-label
2018-07-26 10:43:02 -07:00
MCamp859 e8f6a074b9 Updated kata and kata_migration tutorials.
Updated info for selecting runtime and edits for text flow and clarity.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-25 21:55:58 -04:00
mvincerx 09d392ac95 Merge pull request #200 from intelkevinputnam/kp-jira-3406
Kp jira 3406
2018-07-25 17:05:01 -07:00
Michael Vincerra a4875df4fb Appends ':' to the end of the target-label
- where it appears in autospec-about
- where it is used in the "include"

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-25 16:57:31 -07:00
Kevin Putnam 5eab2ea6bf updated includes to new code standard 2018-07-25 16:37:57 -07:00
mvincerx addd0961ba Merge pull request #201 from mvincerx/autospec04
Adds target-anchors to cross reference with new method.
2018-07-24 15:44:09 -07:00
Michael Vincerra 9b0e141aa1 Adds target-anchors to cross reference with new method. 2018-07-24 12:54:54 -07:00
Kevin Putnam cbea9d3f4d up to 27 fixes and down to 68 warnings 2018-07-23 16:52:02 -07:00
mvincerx 217ac48b47 Update issue templates 2018-07-23 16:34:00 -07:00
mvincerx 8ecd89265a Update issue templates 2018-07-23 16:32:34 -07:00
mvincerx 00b6ca1c4f Update issue templates 2018-07-23 16:29:06 -07:00
mvincerx e06981e4cf Update issue templates 2018-07-23 16:26:42 -07:00
Kevin Putnam 0b08cf0cb0 first 23 fixes to remove warnings from build - down to 75 warnings 2018-07-23 16:25:15 -07:00
mvincerx a1b765bedd Add issue workflow to categorize new guides into 3 categories
- Basics; Developer; and Administrator. 
- Result of Gap Analysis
- Github user: mvincerx
2018-07-23 16:18:16 -07:00
mvincerx 1384891b3e Create guides_feedback
Submitted to organize new requests into 3 categories as result of recommended changes from Gap Analysis for Clear Linux Documentation 'Guides'.
2018-07-23 16:02:15 -07:00
MCamp859 1b55b0d487 Add telemetry concept to CL docs.
Update related telemetry rst files to add links.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-07-19 15:31:14 -04:00
mvincerx cbb38e1544 Merge pull request #197 from mvincerx/mv-edits-kata02
Replaces hash w/ asterisk under 'More information about Docker in |CLOSIA|'
2018-07-17 17:45:23 -07:00
Michael Vincerra 32d44093f7 Replaces hash with asterisk below 'More information about Docker in |CLOSIA|'
- If hash is used, there are two 'titles' rendered in webpage left menu

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-17 17:40:35 -07:00
mvincerx 8aa642f68f Merge pull request #196 from intelkevinputnam/kp-azure
Kp azure
2018-07-17 13:32:42 -07:00
mvincerx 9cec9dcf3c Merge pull request #195 from mvincerx/autospec03
Adds two missing values to code-blocks; revises intro paragraph.
2018-07-17 12:48:36 -07:00
Kevin Putnam e056361c6e fixed figure links 2018-07-17 12:15:34 -07:00
Kevin Putnam 3e8a8889a7 fix to make sure ms azure changes are visible in final rendered site 2018-07-17 12:11:18 -07:00
mvincerx a1b37ab895 Merge pull request #193 from puneetse/edit/ps-docker-tutorial
Update Docker tutorial to remove Clear Containers reference
2018-07-16 17:00:33 -07:00
mvincerx 34ba21d28c Merge branch 'master' into edit/ps-docker-tutorial 2018-07-16 16:00:26 -07:00
Michael Vincerra b7a99447df Corrects grammatical errors. Corrects Sphinx syntax for URLs.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-16 15:52:00 -07:00
Michael Vincerra 85dd899c83 Adds two missing values to code-blocks; revises intro paragraph.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-16 15:10:37 -07:00
mvincerx 6f5e1aa84c Merge pull request #194 from mvincerx/autospec02
Autospec02
2018-07-16 14:18:49 -07:00
Michael Vincerra ff01559f28 Grammatical change foil to isolate sphinx build errors
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-16 14:16:44 -07:00
Michael Vincerra 9b68607094 Removes unnecessary hidden comment.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-13 10:43:47 -07:00
mvincerx 01b518495e Merge pull request #190 from mvincerx/add-contents-directive
Adds `contents::` directive to Clear Linux collaboration guide.
2018-07-12 15:12:00 -07:00
Michael Vincerra 4c818be239 Fixes typo.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-12 15:09:34 -07:00
mvincerx 1ee47c4767 Merge pull request #184 from mvincerx/add-nginx-web-server
Adds nginx web-server to show how to host mixer updates.
2018-07-12 15:06:22 -07:00
mvincerx 5ed6448e93 Merge pull request #165 from mvincerx/autospec01
Create autospec guide and autospec-about to fulfill JIRAs:
2018-07-12 15:04:37 -07:00
puneetse 18ca599fe1 Remove Clear Containers reference. Add Kata
Clear Containers runtime integration was removed. Updating documentation to reflect that.
2018-07-12 12:20:26 -07:00
Michael Vincerra a16acb9084 Corrects formatting.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-12 10:49:17 -07:00
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
mvincerx 9dfe5aa567 Merge pull request #192 from mvincerx/mv-edits-kata
Removes instances of s/cc-runtime for kata per @devimc
2018-07-12 10:19:05 -07:00
Michael Vincerra e23dcbbe9c Removes instances of s/cc-runtime for kata per @devimc
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-12 10:06:35 -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 dada6c0a4f Merge pull request #189 from intelkevinputnam/kp-kata-tutorial
added link to clear container migration
Closes PR 188.
2018-07-11 14:50:39 -07:00
Kevin Putnam 0eaa2542c7 added link to clear container migration 2018-07-11 14:40:42 -07:00
mvincerx 85ce42bfe6 Merge pull request #186 from intelkevinputnam/kata-tutorial
Updates to Kata Containers tutorial
2018-07-11 14:13:29 -07:00
Kevin Putnam bf70fb60fd corrected runtime references 2018-07-11 14:09:53 -07:00
Michael Vincerra 9b3013b2d7 Adds new URL for helloclear https://github.com/clearlinux/helloclear/archive/
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-11 13:56:22 -07:00
Michael Vincerra 276db46105 Applies line edits to clarify nginx default configuration.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-07-11 13:20:07 -07:00
mvincerx b620349700 Merge pull request #187 from intelkevinputnam/kp-swupd-about
fixed issue 162
2018-07-11 10:52:03 -07:00
Kevin Putnam 7cb3cf7bcc fixed issue 162 2018-07-10 17:14:56 -07:00
Kevin Putnam 0299157e2b Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into kata-tutorial 2018-07-10 17:01:02 -07:00
mvincerx 6c2012f21d Merge pull request #185 from intelkevinputnam/swupd-guide
removed version number reference from autoupdate portion of swupd guide
2018-07-10 16:38:19 -07:00
Kevin Putnam dd716f19bb added note for proxy config for docker, improved wording throughout, and removed asterisks where they weren't needed. 2018-07-10 16:20:01 -07:00
Kevin Putnam cc080b83bc removed version number reference 2018-07-10 12:14:00 -07:00
mvincerx 13a515d8aa Merge pull request #157 from MCamp859/kata-migration-edits
Edits to kata-migration for branding and format.
2018-07-09 13:26:49 -07:00
mvincerx 29c96a21fa Merge branch 'master' into kata-migration-edits 2018-07-09 13:26:27 -07:00
mvincerx 47a803d0dc Merge pull request #155 from joselamego/master
kata-containers: add tutorial
2018-07-09 13:20:34 -07:00
mvincerx 79b63b440e Merge pull request #182 from intelkevinputnam/swupd-guide
Swupd guide
2018-07-03 18:09:51 -07:00
Kevin Putnam 963039ec22 added autoupdate version to swupd-guide.rst 2018-07-03 16:59:34 -07:00
Michael Vincerra 9b0ff80def Adds nginx web-server to show how to host mixer updates.
- Simplifies and combines two mix workflows at start
- Fixes Sphinx syntax
- Replaces incorrect link to web server in section CONTENTURL, VERSIONURL

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-07-03 16:11:56 -07:00
mvincerx 123cc7313a Merge pull request #183 from mltullis/mltullis-test
Simplified sentence (test PR)
2018-07-03 11:35:57 -07:00
Mike Tullis 9242b467b8 Simplified sentence (test PR) 2018-07-03 11:29:34 -07:00
Kevin Putnam 2e4c037ac6 merged out of sync swupd-guide.rst 2018-07-03 10:31:42 -07:00
Kevin Putnam 2135cccc98 removed update.rst as material is duplicate of swupd-guide.rst, updated swupd-guide, and updated maintenance.rst to reflect removal update.rst 2018-07-03 10:28:10 -07:00
Kevin Putnam 979abaa9f6 removed reference to successful manual update 2018-07-02 14:45:43 -07:00
Kevin Putnam 70d8c38987 fixed some wording and typos 2018-07-02 14:12:44 -07:00
Kevin Putnam 93a1f5621d added the changes swupd guide file 2018-07-02 12:33:39 -07:00
Kevin Putnam b9dbe66076 corrected some linking problems and renamed the swupd guide file 2018-07-02 12:33:07 -07:00
Kevin Putnam 598d4fda9a added swupd-guide to toc 2018-07-02 12:22:55 -07:00
Kevin Putnam 7386f26245 added more material 2018-07-02 12:21:18 -07:00
Jose Lamego dea47748b5 Update kata.rst 2018-07-02 11:08:03 -05: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
mvincerx 98b2c0715f Merge pull request #179 from mvincerx/mv-edits-edit/ps-increase-virtual-disk-size
Mv edits edit/ps increase virtual disk size
Replaces PR 174.
2018-06-28 17:14:26 -07:00
Kevin Putnam daa1a45997 first commit of swupd-guide.rst 2018-06-28 13:28:43 -07:00
puneetse 053d57c682 Move image types document from guide to reference 2018-06-28 12:35:44 -07:00
puneetse 27273f7aea Split table into 2
This helps understand the difference between images by catagorizingthem and highlights what users are most likely looking for.
2018-06-28 12:32:24 -07:00
puneetse 353f967c3d More descriptive description and file readability
Add some consistency to dscriptions, references to images with optimized kernels.
2018-06-28 12:20:33 -07:00
puneetse 85e87d3b16 Add preference to use IMG over ISO 2018-06-28 11:24:29 -07:00
puneetse 1e9b5ce107 Remove hyperv-mini image
hyperv-mini  image is being deprecated
2018-06-28 10:51:48 -07:00
mvincerx d8e52793d8 Merge pull request #178 from intelkevinputnam/iss163
Fix for issue #163 - lack of uniformity for validating image integrity
2018-06-27 15:42:45 -07:00
Kevin Putnam 48fda09850 trimmed header underline to match header 2018-06-27 15:26:23 -07:00
Kevin Putnam aa9baaad2a fixed title to align with project standards 2018-06-27 15:17:16 -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
mvincerx d92a71908e Merge pull request #177 from puneetse/edit/ps-vmware-image-convert-vmdk
Update VMware ESXi preconfigured image install document
2018-06-26 17:36:11 -07:00
Michael Vincerra d1542099f3 Corrects syntax for:
- Figures and labels
- Internal TOC
- External references to URLs
- Relative paths to files

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-26 17:25:33 -07:00
Michael Vincerra 5b6c781c69 Fixes syntax on figures and code blocks for proper rendering.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-26 16:26:00 -07:00
puneetse a19a19e48d Fix lsblk output 2018-06-26 15:43:23 -07:00
mvincerx b6baaa0317 Merge pull request #176 from clearlinux/bug/ps-docker-tutorial
Fix minor syntax error blocking substitution
2018-06-26 15:27:57 -07:00
Kevin Putnam b16660a9f0 added a reference to validate-signatures.rst to download-verify-uncompress-linux.rst for uniformity (issue 163). made a couple wording changes to validate-signatures.rst and added a label to help with navigation 2018-06-26 12:21:29 -07:00
puneetse 5d30581692 Add vCLI option to connect
vMA is being deprecated
2018-06-26 11:47:00 -07:00
puneetse 79511445b0 Fix minor syntax error blocking substitution
No space after period was causing |CL| substitution not to expand
2018-06-25 20:00:14 -07:00
puneetse fcc3d3095c Fix broken link reference 2018-06-25 14:08:51 -07:00
puneetse 371b823e2e Recommend using vMA and add VMware doc references
vMA is the official recommendation from VMware for running vmkfstools.
2018-06-25 14:06:52 -07:00
puneetse f014bc5c01 Change to ToC directive with page anchors 2018-06-25 11:47:22 -07:00
puneetse be55e1bcf5 Add reference back to VMware player install. 2018-06-25 11:32:44 -07:00
puneetse c5e462ade0 Merge pull request #1 from clearlinux/master
Update from upstream master
2018-06-25 11:10:44 -07:00
puneetse 63a862b615 Minor formatting and clarifications. 2018-06-25 10:33:42 -07:00
puneetse b8af0eb051 Split figure into two and minor clarifications 2018-06-22 10:36:26 -07:00
mvincerx 2797953be3 Merge pull request #173 from mvincerx/mv-edits-add/bundle-search-commands
Mv edits add/bundle search commands
2018-06-21 15:00:13 -07:00
mvincerx 074f83f707 Merge pull request #172 from mvincerx/mv-edits-add/ps-docker-tutorial
Mv edits add/ps docker tutorial
2018-06-21 14:45:23 -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
puneetse 746bef2d0d Add second level headers 2018-06-21 13:53:20 -07:00
Michael Vincerra 53ad59e18d Corrects syntax, adds internal TOC, and adds link to tutorials.rst
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-21 13:22:13 -07:00
puneetse 078ee76f1d Reorder methods to find partition size
The lsblk approach is more likely to be used on an already deployed system, while the config.json is more of a reference point.
2018-06-21 13:12:53 -07:00
puneetse 14c47506fc Update ToC 2018-06-20 16:06:41 -07:00
puneetse be1fb1a2b5 Add section on Docker swarm 2018-06-20 16:04:47 -07:00
puneetse 88472e1771 minor clarification of nginx Docker image 2018-06-20 15:43:55 -07:00
puneetse ee85257df2 minor syntax bugs 2018-06-20 15:36:50 -07:00
puneetse f9b7daac80 Rename Kata reference to Clear Containers 2018-06-20 15:31:00 -07:00
puneetse 2ea34e21da minor language edits 2018-06-20 14:33:34 -07:00
puneetse 5d61a12854 more RST formatting and syntax 2018-06-20 14:17:08 -07:00
puneetse 11d1b948cc Refactor and formatting
Moved kata containers section above the other optional sections to improve reader flow.
2018-06-20 13:57:42 -07:00
puneetse 0475eb046f Add content for running an example image 2018-06-20 13:30:16 -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
puneetse 6ad227259c Initial add of docker tutorial 2018-06-20 10:24:01 -07:00
mvincerx 170e57f168 Merge pull request #169 from mvincerx/mv-update-rufus-3.0-1
Corrects Sphinx syntax for accurate rendering.
2018-06-19 17:39:08 -07:00
Michael Vincerra a05e77266d Corrects Sphinx syntax for accurate rendering.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-19 17:35:13 -07:00
mvincerx 9edd01e45b Merge pull request #167 from puneetse/update-rufus-3.0
Update bootable USB for Windows with Rufus 3.0
2018-06-19 17:22:24 -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
mvincerx b24b843c7f Merge pull request #164 from intelkevinputnam/concepts-syntax
Concepts syntax
2018-06-18 12:47:19 -07:00
Michael Vincerra 848cd6b56c Applies feedback from phmccarty re terminology and fixes typo.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-18 12:40:54 -07:00
Sethi, Puneet 874ba35b07 Update bootable USB for Windows for Rufus 3.0
Rufus 3.0 has a new GUI and has defaults which simplify the documentation a bit.
2018-06-18 09:47:34 -07:00
Michael Vincerra 3352304b89 Create autospec guide and autospec-about to fulfill JIRAs:
- CLEAR 3076: Autospec concept draft
- CLEAR 3077: Autospec guide

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-15 19:46:15 -07:00
Kevin Putnam 2eade889b6 removed some trailing carriage returns from mixer-about.rst 2018-06-15 19:57:51 +00:00
Kevin Putnam cccbf3f825 fixed mixer-about.rst typos 2018-06-15 12:46:35 -07:00
mvincerx 048ad74817 Merge pull request #158 from intelkevinputnam/mixer-about
Mixer about
2018-06-14 17:27:55 -07:00
Kevin Putnam 36bb6e8640 final revision to mixer-about 2018-06-14 16:35:01 -07:00
mvincerx 994faace1f Merge pull request #160 from matthewrsj/swupd-autoupdate
swupd: fix autoupdate documentation
2018-06-14 13:44:54 -07:00
mvincerx adf4fb2d8d Merge pull request #161 from matthewrsj/swupd-deltas
swupd: they really are called binary-deltas
2018-06-14 12:48:20 -07:00
Kevin Putnam e1ff924c5b added mixer-about.rst to the concepts TOC 2018-06-14 12:31:40 -07:00
Kevin Putnam 2a10118cd7 improved wording of first paragraph for clarity 2018-06-14 10:49:27 -07:00
Matthew Johnson db0250a59b swupd: they really are called binary-deltas
Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
2018-06-14 09:00:25 -07:00
Matthew Johnson 5d66e6b749 swupd: fix autoupdate documentation
The autoupdate subcommand has been around for a very long time now and
should be used instead of the systemctl masking commands.

Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
2018-06-14 08:56:26 -07:00
mvincerx 52135c0de0 Merge pull request #159 from mvincerx/mv-edits-mixin
Adds punctuation for clarity and fixes sphinx syntax.
2018-06-13 15:31:14 -07:00
Michael Vincerra 5f1968ff83 Adds punctuation for clarity and fixes sphinx syntax.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-13 15:25:12 -07:00
Kevin Putnam 266c4938fe corrected error in list syntax 2018-06-13 13:34:46 -07:00
Kevin Putnam 98a160e429 added mixer concept page 2018-06-13 13:23:29 -07:00
mvincerx f8b14becc0 Merge pull request #156 from matthewrsj/mixin-bundle-flag
mixin: add --bundle flag information
2018-06-13 12:00:43 -07:00
MCamp859 1d570b8622 Edits for branding and format.
Removed $ prompts. Moved links to end of file.
Updated tutorial.rst.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-06-12 20:16:33 -04:00
Jose Lamego d167321df1 Update kata.rst 2018-06-11 13:48:00 -05:00
Matthew Johnson efd58c5f25 mixin: add --bundle flag information
Add information for latest functionality of the mixin package
subcommand. The --bundle flag allows users to specify the name of the
bundle they add their package to.

Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
2018-06-10 19:51:13 -07:00
Jose Lamego c021c2ead2 kata-containers: add tutorial
This tutorial describes how to install, configure and run Kata Containers on
Clear Linux.

Signed-off-by: Jose Lamego <jose.a.lamego@intel.com>
2018-06-08 13:47:25 -05:00
mvincerx 1488fbf926 Merge pull request #153 from mvincerx/mv-edits-web-server-install2
Assigns asterisks for third party use and adds CLOSIA.
2018-06-06 17:13:02 -07:00
Michael Vincerra c70398f401 Assigns asterisks for third party use and adds CLOSIA.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-06 17:09:51 -07:00
mvincerx 6879c905cf Merge pull request #152 from mvincerx/mv-edits-web-server-install
Fixes headers, formatting, and indentation.
2018-06-05 14:14:27 -07:00
Michael Vincerra 5b05cfec6b Fixes headers, formatting, and indentation.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-05 14:11:22 -07:00
mvincerx 27e4ca028d Merge pull request #133 from deb-intel/webserverinstall-edits
Webserverinstall edits
2018-06-05 13:32:10 -07:00
mltullis 27bfcaa26c Merge pull request #151 from matthewrsj/local-rpms
mixin: fix local-rpm documentation
2018-06-05 12:18:55 -07:00
Matthew Johnson b4d18e506e mixin: fix local-rpm documentation
The /usr/share/mix/rpms directory is no longer used by mixer/mixin.
Instead use the appropriate default /usr/share/mix/local-rpms directory
because this is where mixer looks for local RPMs when initializing the
local repository.

Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
2018-06-05 12:01:53 -07:00
deb-intel 17dec2889a Heading and line edit; webserverinstall.rst
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-06-04 20:27:42 -04:00
deb-intel 8624dd641c Merge branch 'master' of https://github.com/clearlinux/clear-linux-documentation into webserverinstall-edits 2018-06-04 20:23:20 -04:00
mvincerx 4fb08dd06d Merge pull request #149 from mvincerx/mv-edits-bootable-usb-mac
Revises to specify image file types used for bootable usb drive on Mac.
2018-06-04 11:26:58 -07:00
mvincerx bf53105833 Merge pull request #150 from mvincerx/mv-edits-bootable-windows
Revises to specify image file types used for bootable usb drive on Wi…
2018-06-04 09:07:59 -07:00
deb-intel 75e5346af6 Bash correction; numbered steps - webserverinstall
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-06-03 20:13:18 -04:00
deb-intel baf6286af8 Merge branch 'master' of https://github.com/clearlinux/clear-linux-documentation into webserverinstall-edits 2018-06-03 20:11:10 -04:00
Michael Vincerra 3c09a81b29 Fixes typo.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-01 18:13:51 -07:00
Michael Vincerra 83b319cb7a Revises to specify image file types used for bootable usb drive on Windows.
- Revises include statement to exclude table
- Removes unused 'releases' link

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-01 12:55:53 -07:00
Michael Vincerra 1e97469b0f Revises to specify image file types used for bootable usb drive on Mac.
- Revises include statement to exclude table
- Removes unused 'releases' link

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-06-01 12:41:51 -07:00
mvincerx 5a23b1d30e Merge pull request #145 from mvincerx/mv-edits-bootable-usb-linux2
Revises to specify image file types used for bootable usb drive.
2018-06-01 10:36:03 -07:00
deb-intel c0be615bbf Formatting edits in web-server-install.rst
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-06-01 12:39:31 -04:00
deb-intel 51ab8b0d0a Merge branch 'master' of https://github.com/clearlinux/clear-linux-documentation into webserverinstall-edits 2018-06-01 12:33:13 -04:00
Michael Vincerra e33e17c584 Modifies include to cover naming convention, not table of image types.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-29 14:33:35 -07:00
mltullis 32d6afc357 Merge pull request #148 from matthewrsj/swupdaddpkg-mixin
Deprecate swupd-add-pkg for mixin
2018-05-25 12:40:31 -07:00
Matthew Johnson c546acf667 Reword package-add command description
Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
2018-05-25 11:02:44 -07:00
Matthew Johnson 88f4af6616 Deprecate swupd-add-pkg for mixin
Reword and rewrite the swupdaddpkg.rst documentation for the new mixin
tool and outline new features. The mixin tool is meant to replace
swupd-add-pkg and provide a new capability of adding remote RPM
repositories to the local mix.

Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
2018-05-24 15:46:13 -07:00
mltullis 511e529e67 Merge pull request #147 from abecastillo/vbox-lts-version
Change the lts version of kernel for virtual box
2018-05-24 14:14:54 -07:00
Abraham Castillo ca96adc757 v2. Updating virtual box installation document to reflect latest LTS
Updating virtual box installation document to reflect latest LTS
kernel version (4.14) released on Nov 2017. New kernel version info
updated in two places. fixed minor numbering typo and syntax.
2018-05-23 16:02:18 -05:00
deb-intel 128ea2c982 Final edits to improve user navigation
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-23 07:11:56 -04:00
mltullis 27fcdeb874 Merge pull request #146 from deb-intel/wpinstall-edits2
Edits to wp-install.rst
2018-05-22 17:55:42 -07:00
deb-intel 6bbfade67d Minor edits; formatting
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-22 20:26:59 -04:00
deb-intel dc695cb69b Edits from mvincerx review
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-22 06:55:26 -04:00
Abraham Castillo 46fa324bd8 Change the lts version of kernel for virtual box
Updating virtual box installation document to reflect latest LTS
kernel version (4.14) released on Nov 2017.
2018-05-21 11:07:55 -05:00
deb-intel 8bb164ba82 Edits to wp-install.rst
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-21 09:41:30 -04:00
deb-intel 4b64400cba Incorporated mvincerx edits; one image
web-server-install.rst

Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-20 15:45:32 -04:00
deb-intel 1e085f678b Merge branch 'master' of https://github.com/clearlinux/clear-linux-documentation into webserverinstall-edits 2018-05-20 11:22:07 -04:00
Michael Vincerra 319b3f3f99 Revises to specify image file types used for bootable usb drive.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-16 13:54:01 -07:00
mltullis 0f1981d83b Merge pull request #142 from mvincerx/ovs-dpdk-remove
Removes ovs-dpdk per Rob Nesius; removes reference in parent toctree.
2018-05-15 13:22:12 -07:00
Michael Vincerra 4832cc6434 Removes ovs-dpdk per Rob Nesius; removes reference in parent toctree.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-15 11:48:15 -07:00
mltullis 1f8a538962 Merge pull request #134 from MCamp859/edits-multi-boot
Copy edit of multi-boot for branding, grammar, and format.
2018-05-10 10:33:27 -07:00
mltullis 2521ca7a41 Merge pull request #136 from MCamp859/edits-multi-boot-rhel
Copy edit of multi-boot-rhel for branding, grammar, and format.
2018-05-10 10:33:02 -07:00
mltullis c06dbd66d4 Merge pull request #137 from MCamp859/edits-multi-boot-sles
Copy edit of multi-boot-sles for branding, grammar, and format.
2018-05-10 10:32:42 -07:00
mltullis 1cfaf8bbc1 Merge pull request #138 from MCamp859/edits-multi-boot-ubuntu
Copy edit of multi-boot-ubuntu for branding, grammar, and format.
2018-05-10 10:32:12 -07:00
mltullis 518fbb2631 Merge pull request #139 from MCamp859/edits-multi-boot-mint
Copy edit of multi-boot-mint for branding, grammar, and format.
2018-05-10 10:31:50 -07:00
mltullis 23362aafd8 Merge pull request #140 from MCamp859/edits-mb-restore-bl
Copy edit of multi-boot-restore-bl for branding, grammar, and format.
2018-05-10 10:31:20 -07:00
MCamp859 0d68512d50 Removed sudo -s per review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 13:14:41 -04:00
MCamp859 0ba295030d Fixed underscores.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 13:11:04 -04:00
MCamp859 1f42c8f112 Changed "modify" to "configure" in opening paragraph.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 12:51:32 -04:00
MCamp859 65923ebcef Completed review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 11:17:19 -04:00
MCamp859 ec24e4107c Completed review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 11:08:40 -04:00
MCamp859 da6544ff03 Completed review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 11:05:35 -04:00
MCamp859 dfb52b4aa6 Completed review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 11:03:33 -04:00
MCamp859 5ffd3c34cc Completed review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 10:58:45 -04:00
MCamp859 15a029921c Completed review feedback. Deferred figure N vs. Figure N.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-10 10:51:22 -04:00
deb-intel dde4cfe56d Merge branch 'master' of https://github.com/clearlinux/clear-linux-documentation into webserverinstall-edits 2018-05-09 06:42:13 -04:00
deb-intel bbe3677d71 Incorporated mvincerx's suggested edit
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-09 06:22:28 -04:00
mltullis 3869c357c1 Merge pull request #135 from MCamp859/edits-multi-boot-win
Copy edit of multi-boot-win for branding, grammar, and format.
2018-05-08 16:16:10 -07:00
mltullis 2f75df4bd4 Merge pull request #132 from mvincerx/mv-edits-available-bundles2
Rebuilds bundle.html manually combining two scripts:
2018-05-08 16:14:58 -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
MCamp859 ae7a29ebe6 Copy edit of multi-boot-restore-bl for branding, grammar, and format.
No deferred feedback from PR 108.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-08 11:30:59 -04:00
MCamp859 229de087cb Copy edit of multi-boot-mint for branding, grammar, and format.
Completed feedback deferred from PR 108.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-08 11:17:45 -04:00
MCamp859 4cf099a202 Copy edit of multi-boot-ubuntu for branding, grammar, and format.
Completed feedback deferred from PR 108.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-08 11:15:05 -04:00
MCamp859 16b74af76a Copy edit of multi-boot-sles for branding, grammar, and format.
Completed feedback deferred from PR 108.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-08 11:12:09 -04:00
MCamp859 edca3ea8c0 Copy edit of multi-boot-rhel for branding, grammar, and format.
Completed feedback deferred from PR 108.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-08 11:09:29 -04:00
MCamp859 d1d6b29267 Copy edit of multi-boot-win for branding, grammar, and format.
No deferred feedback from PR 108.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-08 11:05:53 -04:00
MCamp859 164c96893e Copy edit of multi-boot for branding, grammar, and format.
Completed feedback deferred from PR 108.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-05-08 10:56:53 -04:00
deb-intel c671bf0789 Removed extra space in "drop-in"
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-08 08:55:45 -04:00
deb-intel a4593d369d Edited web-server-install for gramm consistency
Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-08 08:23:51 -04: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
mltullis aa4af3e489 Merge pull request #131 from mvincerx/mv-edits-live-image
Fixes broken URI for Intel Virtualization Directed I/O
2018-05-04 16:48:47 -07:00
mltullis 7d06d9397a Merge pull request #130 from mvincerx/mv-edits-virtualbox
Adds missing references and associated URIs at bottom
2018-05-04 16:43:48 -07:00
Michael Vincerra d0732ba818 Fixes broken URI for Intel Virtualization Directed I/O
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-04 16:42:49 -07:00
Michael Vincerra 1e68608029 Adds missing references associated URIs at bottom
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-04 16:35:07 -07:00
mltullis c1ff16eef0 Merge pull request #129 from mvincerx/mv-edits-bootable-usb-linux
Omits prefixes to commands and changes input commands to 'bash'.
2018-05-04 15:43:44 -07:00
Michael Vincerra a0e6a499cb Omits prefixes to commands and changes input commands to 'bash'.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-04 15:39:32 -07:00
mltullis e02db2c907 Merge pull request #125 from mvincerx/installationrevisions
Edits installation instructions for accuracy and corrects grammatical…
2018-05-04 12:06:01 -07:00
mltullis 01b3a4f449 Merge pull request #128 from mvincerx/mv-edits-enable-user-space
Revises commands, corrects formatting, and simplifies.
2018-05-04 12:03:25 -07:00
mltullis 603ae6f001 Merge pull request #127 from mvincerx/mv-edits-available-bundles
Updates available bundles and includes pundles.
2018-05-04 12:02:56 -07:00
Michael Vincerra f224763f49 Revises commands, corrects formatting, and simplifies.
- Changes all input commands to use 'bash'
- Simplifies verbiage on swupd bundle-add os-clr-on-clr
- Corrects word-wrap to 78
- Corrects formatting on Note, lines 91-96
- Omits unused URI, as result of PR 124

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-04 11:23:27 -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
mltullis c472a0b7c8 Merge pull request #124 from gkmahon/enable-new-user-space-edits
Copy edits for enable a new user space
2018-05-03 11:26:16 -07:00
Mahoney d0de27112f Signed-off-by: Mahoney <genessa.k.mahoney@intel.com> 2018-05-03 11:16:42 -07:00
Mahoney d8cf6db3d8 Completed review feedback and incoporated changes.
Signed-off-by: Mahoney <genessa.k.mahoney@intel.com>
2018-05-03 08:47:57 -07:00
Michael Vincerra 9e6833d1e0 Edits installation instructions for accuracy; corrects grammatical errors.
- Corrects grammatical errors and simplifies instruction for various installation methods.
- Revises bare-metal-manual-install to correct errors and for readability.
- Revises cgdisk-manual-install; omits fig. 16, then directs user to bare-metal-manual-install.
- Revise virtualbox.rst, first two paragraphs for conciseness; omits prefixes to commands
- Revises instruction in Bundle Selector. Fixes Figure 15.
- Corrects erroneous link in first para to bare-metal-manual-install.

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-05-02 15:20:58 -07:00
mltullis 7e09fc02e6 Merge pull request #123 from deb-intel/telemetry-edits
Grammar checks in telemetry-enable file
2018-05-01 11:23:25 -07:00
Mahoney 786d7f3c25 Copy edits for enable a new user space
Signed-off-by: Mahoney <genessa.k.mahoney@intel.com>
2018-05-01 09:36:47 -07:00
deb-intel f89889e504 Grammar checks in telemetry-enable file
Changed console to bash

Signed-off-by: deb-intel <38864784+deb-intel@users.noreply.github.com>
2018-05-01 09:20:56 -04:00
mltullis 64c4bd9908 Merge pull request #108 from MCamp859/multiboot-edits
Split multi-boot doc into small files, updated fig refs.
2018-04-30 09:32:22 -07:00
mltullis de18d0d24f Merge pull request #122 from MCamp859/image-files-edit
Copy edit of 4 interlinked files in Maint Guide.
2018-04-26 14:58:21 -07:00
mltullis 2250fd2005 Merge pull request #120 from MCamp859/incr-virt-disk-edits
Edited increase-virtual-disk-size guide for grammar, formatting, and …
2018-04-26 14:56:43 -07:00
mltullis 96b1efb417 Merge pull request #121 from MCamp859/howto-training
Created how-to-clear-overview as a summary of the How to Clear training.
2018-04-26 13:04:08 -07:00
MCamp859 78d4e0720a Incorporated review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-26 14:53:19 -04:00
MCamp859 65bdc30ad1 Copy edit of 4 interlinked files in Maint Guide.
Files: image types; download verify uncompress for Linux, macOS, and Windows
Edits for branding and format. Removed $ prompts.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-26 14:31:07 -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
MCamp859 12131cab1e Edited increase-virtual-disk-size guide for grammar, formatting, and text flow.
Removed # prompt and replaced with sudo in 4 instances.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-24 15:28:39 -04:00
MCamp859 35082e2787 Implemented structural feedback in multi-boot.rst. Text edits deferred to next phase of updates.
Reordered text and included CL details in multi-boot.rst.
Renamed “reset-bl” file references to “restore-bl” for clarity.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-23 14:13:59 -04:00
Rodrigo Caballero a237a045e7 Merge pull request #109 from MCamp859/time-edits
Edited time guide for grammar, formatting, and text flow.
2018-04-20 11:52:23 -05:00
MCamp859 c2f67addd1 Completed review feedback in time doc.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-19 18:43:33 -04:00
MCamp859 463847b251 Incorporated review feedback in time guide.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-19 14:41:45 -04:00
Rodrigo Caballero 60504f4334 Merge pull request #118 from Michael-Vincerra/addcurl-vmw-wsplayer
Adds curl command option to download latest VMware image. Fixes sever…
2018-04-19 12:18:15 -05:00
Michael Vincerra 0d95de5bfb Corrects input instance from console to bash.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-19 09:51:09 -07:00
mltullis 9e8467126c Merge pull request #117 from Michael-Vincerra/addcurl-vmw-esxi-install
Adds curl command option to download the latest VMware image.
2018-04-18 18:07:50 -07:00
mltullis 39cc11c0bf Merge pull request #116 from Michael-Vincerra/addcurl-virtualbox-install
Adds curl command option to download the latest live image.
2018-04-18 18:04:11 -07:00
Michael Vincerra 38e1e2a3e5 Corrects WMware file extension in curl command. Fixes layout errors.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-18 16:55:58 -07:00
Michael Vincerra 7b6101c28b Adds curl command option to download latest VMware image. Fixes several layout errors.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-18 16:34:09 -07:00
Michael Vincerra c03e3cfef7 Adds curl command option to download the latest VMware image.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-18 15:36:36 -07:00
Michael Vincerra cc3f0e2016 Adds curl command option to download the latest live image.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-18 15:05:12 -07:00
mltullis c3d2d9942d Merge pull request #115 from Michael-Vincerra/addcurl-kvm-install
Adds curl command option to download the latest kvm image
2018-04-18 14:53:38 -07:00
Michael Vincerra cce029917d Adds curl command option to download the latest kvm image
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-18 14:45:41 -07:00
mltullis f70348cece Merge pull request #114 from Michael-Vincerra/addcurl-bare-metal-install
Adds curl command option to download latest CL image.
2018-04-18 14:10:11 -07:00
Michael Vincerra 199d60d77c Adds curl command option to download latest CL image.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-18 13:32:37 -07:00
Rodrigo Caballero a467d3ab4a Merge pull request #113 from clearlinux/tpleavitt-telem
update privacy policy reference link
2018-04-18 11:29:43 -05:00
Tom Leavitt 219b2c126a update privacy policy reference link
The intel privacy link was still not rendering correctly since the label had a "'s" in it.  I renamed it to "Intel privacy policies"
2018-04-18 09:26:48 -07:00
mltullis bbd64f7d22 Merge pull request #110 from MCamp859/concept-restart-add
Added reference to restart in parent concepts. Fixed restart label.
2018-04-17 10:45:28 -07:00
mltullis 6c0b9091f4 Merge pull request #112 from clearlinux/telem-enable-link
Update telemetry enable link
2018-04-17 09:58:01 -07:00
Tom Leavitt f8c99f3751 Update telemetry enable link
Update the link to intel's privacy policy
2018-04-17 09:44:52 -07:00
mltullis 91f3725ef5 Merge pull request #111 from clearlinux/telemetry-link
Fixed link in telemetry tutorial
2018-04-17 09:39:35 -07:00
Tom Leavitt 48f0d5aabd Fixed link in telemetry tutorial
Updated the link for intel's privacy policy to https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html
2018-04-17 09:35:00 -07:00
MCamp859 08ab82106a Added reference to restart in parent concepts. Fixed restart label.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-16 16:06:25 -04:00
MCamp859 563b806f72 Edited time guide for grammar, formatting, and text flow.
Changed code-block to bash and made minor text changes.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-11 15:20:04 -04:00
MCamp859 df4ebae60e Split multi-boot doc into small files, updated fig refs.
Added links to Detailed Procedures in main doc.
Renamed image files and figure numbers in text.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-10 16:32:37 -04:00
Rodrigo Caballero caf39ae177 Merge pull request #87 from eadamsintel/smb
Add SMB file sharing tutorial.
2018-04-09 10:51:58 -05:00
Rodrigo Caballero bd9630ea4c Merge branch 'master' into smb 2018-04-09 10:50:40 -05:00
mltullis 471a66e1a5 Merge pull request #105 from Michael-Vincerra/swupdaddpkg1
Creates new guide on using swupd-add-pkg method for customization of …
2018-04-06 20:47:25 -07:00
Michael Vincerra 18ce81a7f4 Applies minor formatting edits. Performs force push because other contributor accidentally pushed directly to branch swupdaddpkg1.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-06 17:09:51 -07:00
Michael Vincerra 123a6ac335 Merge branch 'master' of https://github.com/clearlinux/clear-linux-documentation into swupdaddpkg1 2018-04-06 16:41:50 -07:00
Michael Vincerra fabbf2b634 Revises guide to incorporate suggested revisions from tmarcu, tpleavitt, and MCamp859 on PR 105.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-06 16:38:30 -07:00
Michael Vincerra 6f6342f57f Revises guide to prefix each command with sudo and corrects some commands per tmarcu. Incorporates feedback from MCamp on grammar,
formatting, and text flow. Incorporates feedback from tpleavitt.

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-06 16:23:38 -07:00
Rodrigo Caballero ad584b4b3d Merge pull request #103 from rcaballeromx/restart
Add concept regarding restarting services.
2018-04-05 13:53:52 -05:00
mltullis 1acd1513ae Merge pull request #106 from user135711/patch-1
Added note to increase size of VM partition
2018-04-05 09:46:12 -07:00
user135711 d7f8576b27 Update enable-user-space.rst 2018-04-05 08:09:38 -07:00
user135711 ff6990efa5 Corrected syntax 2018-04-05 08:02:41 -07:00
MCamp859 ece2cbab30 Incorporated review feedback in restart concept.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-04-04 17:56:13 -04:00
user135711 850ac305c7 Added note to increase size of VM partition
I added a note that might confuse new users when following the getting started sequence download, import vmware VM->enable user space. The linux error will not indicate that the hard drive isn't big enough. The link did not render in the preview for some reason so edit it to conform with your relative links convention and build before pulling.
2018-04-02 19:21:13 -07:00
Michael Vincerra 97f9d90863 Creates new guide on using swupd-add-pkg method for customization of CL. Applies line edits. Adds reference for new guide in
parent toctree maintenance.rst. Adds note to paragraph one.  Applies further line edits.

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-04-02 10:42:00 -07:00
MCamp859 6525cfe218 Edited text to align with other tutorials.
Added Prerequisites section.
Added sudo -s as first command and deleted sudo from other commands.
Edited text for active voice and consistency between steps.
Removed gerunds in headings.
Changed figure captions to remove gerunds and differentiate.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-29 11:48:39 -04:00
mltullis 9dd7564334 Merge pull request #104 from Michael-Vincerra/vncstructurefix3
Changes instances from '%HOME' to '$HOME'; omits openssh-server bundl…
2018-03-28 11:36:27 -07:00
Michael Vincerra f2e73b0004 Changes instances from '%HOME' to '$HOME'; omits openssh-server bundle installation; omits cruft.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-03-28 08:12:26 -07:00
mltullis 0c5062dcbf Merge pull request #102 from Michael-Vincerra/vncstructurefix2
Flattens nested content in several sections to simplify use cases; fi…
2018-03-27 13:13:25 -07:00
Rodrigo Caballero dd60ab0102 Merge pull request #93 from MCamp859/custom-container-edits
Copy edit for grammar, formatting, and text flow.
2018-03-27 12:58:23 -06:00
Michael Vincerra 41fc6c24f7 Further flattens nested items overall. Omits use cases on mac using the built-in screen sharing. In Connect
to your VNC session, includes steps 1-2 for each use case. Makes configuration of RealVNC optional
section--instead of note.

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-03-26 16:37:12 -07:00
Rodrigo Caballero 54dcdb5c75 Merge pull request #96 from MCamp859/netwk-bond-edits
Edited for grammar, formatting, and text flow.
2018-03-26 10:09:11 -06:00
Michael Vincerra 5e8976bfa1 Flattens nested content in several sections to simplify use cases; fixes grammatical and stylistic errors.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-03-23 14:55:14 -07:00
MCamp859 74d0af843b Added sudo -s as first command and deleted sudo from other commands.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-22 14:23:54 -04:00
MCamp859 a3ef3a5231 Confirmed sudo -s is first command and deleted sudo from other commands.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-22 11:12:14 -04:00
mltullis 9216912f68 Merge pull request #101 from Michael-Vincerra/vncstructurefix
Fixes structure issues in Install a VNC Viewer App.
2018-03-21 12:39:50 -07:00
Michael Vincerra 4919274824 Fixes structure issues in Install a VNC Viewer App.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-03-21 12:29:05 -07:00
mltullis 288eed6f46 Merge pull request #100 from Michael-Vincerra/vnclinks
Fixes structure in network.rst index file.
2018-03-21 11:17:02 -07:00
Michael Vincerra dbda6cbe29 Fixes structure in network.rst index file.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-03-21 11:11:07 -07:00
mltullis b392d59792 Merge pull request #82 from bktan8/vnc2
Completed VNC document.
2018-03-20 18:23:19 -07:00
Michael Vincerra b949223fcc Minor grammatical edits made to vnc2 branch.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
2018-03-20 16:35:23 -07:00
MCamp859 2e8a607a34 More edits to restart concept.
Deleted gerunds from section heads.
Added period to figure caption.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-19 17:27:16 -04:00
mltullis 74f4649e25 Merge pull request #98 from clearlinux/telem-backend-fix
Fix telemetry-backend rendering issue
2018-03-19 10:58:09 -07:00
Tom Leavitt 206ba54c33 Fix telemetry-backend rendering issue
The bulleted list for the flask apps is not rendering correctly, add a line to correct this
2018-03-19 10:54:40 -07:00
bktan8 fbfdb313ca Update vnc.rst 2018-03-15 14:38:51 -07:00
Rodrigo Caballero b12c33bee2 Merge pull request #95 from MCamp859/ipxe-install-edits
Edited for grammar, formatting, and text flow.
2018-03-15 15:16:35 -06:00
bktan8 800ef9130e Update vnc.rst 2018-03-15 13:53:45 -07:00
bktan8 86e3c85187 Update vnc.rst 2018-03-15 13:50:48 -07:00
Rodrigo Caballero 7803558d92 Merge pull request #86 from joselamego/spark
spark.rst: Add standalone-Spark use case tutorial
2018-03-15 13:41:26 -06:00
MCamp859 c89cfe05ee Removed branding * in custom-clear-container doc title.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-15 15:35:39 -04:00
MCamp859 1c48597bd4 Added period to 2 figure captions in ipxe-install doc.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-15 15:19:47 -04:00
MCamp859 ef04ca612a Updated network-bonding doc per review feedback.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-15 15:01:51 -04:00
MCamp859 61975f7ced Edited for grammar, formatting, and text flow.
Modified topic title. Replaced # with sudo.
Removed ini role, added bash role to user entry code blocks.
Removed duplicated external link.
Edited text for active voice and consistency between steps.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-14 11:07:15 -04:00
MCamp859 bb5aa9d49a Edited for grammar, formatting, and text flow.
Modified topic title, heading text, and heading levels.
Deleted prompt character. Replaced # with sudo.
Corrected links to external webpages.
Edited text for active voice and consistency between steps.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-12 16:53:55 -07:00
MCamp859 4a1a81875b Edited for grammar, formatting, and text flow.
Deleted prompt character. Replaced # with sudo.
Assigned bash role to code blocks with user entries.
Edited text for active voice and consistency between steps.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-12 18:06:53 -04:00
MCamp859 e64e400141 Edited for grammar, formatting, and text flow.
Deleted prompt character. Replaced # with sudo.
Assigned bash role to code blocks with user entries.
Edited text for active voice and consistency between steps.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-08 15:06:30 -05:00
Rodrigo Caballero 31900f3c34 Merge pull request #80 from kevincwells/mixer-doc-update
Update Mixer documentation
2018-03-07 16:13:35 -06:00
Kevin C. Wells 5f9bed0e27 Fix missing word and minor formatting issue 2018-03-07 13:22:36 -08:00
Rodrigo Caballero fdbd1dafc5 Fix technical inaccuracies introduced by rewording.
Additionally, all the unnecessary sudo commands have been removed.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-03-07 10:45:07 -06:00
Ecouzens eb26ba09c6 copy edit and language update
Signed-off-by: Ecouzens <evan.couzens@intel.com>
2018-03-06 13:47:17 -08:00
Ecouzens c2902ec1a5 copy edit and language cleanup
Signed-off-by: Ecouzens <evan.couzens@intel.com>
2018-03-06 13:33:21 -08:00
Ecouzens 888cf2ff27 Merge branch 'mixer-doc-update' of https://github.com/kevincwells/clear-linux-documentation into kevincwells-mixer-doc-update 2018-03-06 09:31:26 -08:00
Rodrigo Caballero 73f21faff8 Rewrite guide to improve clarity, flow, markup, and consistency.
The rewrite includes:
Explicit commands for important options.
Use of lists to improve the clarity of the configuration variables content.
Removal of command prompts to enable DBT.
Consistent use of terminology.
Use of concrete examples to improve the clarity of the commands.
Improved content flow and navigation with linked workflow overviews.
Added cross-references.
Removed ambiguous relative pronouns and punctuation.
Removed passive voice whenever possible.
Changed verbs to present tense for consistency and style guide compliance.
Optimized headings for search engines.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-03-06 11:21:14 -06:00
MCamp859 510b40fc3d Completed requested edits.
Added |CLOSIA|, removed incorrect option roles, added envvar role,
removed XML language in code blocks, and minor text edits.

Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-05 14:30:09 -05:00
Ecouzens fe5ec7b7de Merge branch 'mixer-doc-update' of https://github.com/kevincwells/clear-linux-documentation into kevincwells-mixer-doc-update 2018-03-05 11:29:00 -08:00
Kevin C. Wells 19995d3c2c Update mixer documentation for new commands
This patch updates the documentation to comply with all of the new changes
Mixer 4.0 introduces:

- Many changes to the bundle lifecycle. It introduces
the concept of "local" and "upstream" bundles, and several new commands
to work with them.

- The new, native implementations of swupd-server
and the bundle-chroot-builder tool, both still in experimental
mode behind optional flags.

- New default values for mixer init

Signed-off-by: Kevin C. Wells <kevin.c.wells@intel.com>
2018-03-02 16:31:23 -08:00
MCamp859 15417d6999 Deleted prompt in examples.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-01 15:47:19 -05:00
MCamp859 62265b552c Removed prompt character.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-03-01 15:33:11 -05:00
Eric Adams 314ac4215a Update smb.rst
I added "already" to make that sentence a bit more clear.
2018-02-28 11:33:25 -08:00
Kristi Rifenbark 78ef0ebabc smb.rst: Suggested grammar and rewording edits
Scrubbed file for grammar and clarity.

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
2018-02-28 10:29:28 -08:00
MCamp859 f817a58066 Edited for grammar, format, and text flow.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-02-28 11:38:19 -05:00
Rodrigo Caballero 7c2269ac7c Merge pull request #92 from ECouzens/collab-guide-update
copy edit and language update
2018-02-27 14:22:20 -06:00
Rodrigo Caballero 0572dc2c66 Merge pull request #88 from gvancuts/simply-checksum-checking
Simplify the image checksum validation instructions
2018-02-27 14:19:13 -06:00
Ecouzens 24ab40b3b4 copy edit and language update
Signed-off-by: Ecouzens <evan.couzens@intel.com>
2018-02-27 09:35:26 -08:00
Rodrigo Caballero 59f983eab6 Merge pull request #91 from bwarden/remove-extraneous-ssh-user-param
aws-web: remove mention of -l parameter from text
2018-02-27 08:50:05 -06:00
Brett T. Warden d824d9e446 aws-web: remove mention of -l parameter from text
Changing explanatory text to match the given example command.

Signed-off-by: Brett T. Warden <brett.t.warden@intel.com>
2018-02-26 16:56:16 -08:00
Rodrigo Caballero cd064c730d Merge pull request #90 from clearlinux/usernamefixaws
Fix ssh username passing comment.
2018-02-26 15:51:18 -06:00
Auke Kok 6ff9bf4db1 Fix ssh username passing comment.
Using `root@` and then `-l clear` is ambiguous.
2018-02-26 13:48:49 -08:00
Rodrigo Caballero 7603ee3e9f Change all caps to bold for emphasis. 2018-02-26 12:34:28 -06:00
Rodrigo Caballero a73905e6d3 Merge pull request #61 from clearlinux/vmware-player-improved2
Vmware player improved2
2018-02-26 12:30:50 -06:00
bktan8 ccdc438bc8 Update vmw-player-preconf.rst 2018-02-26 10:26:45 -08:00
bktan8 507c89ec4c Update vmw-player-preconf.rst 2018-02-26 10:16:49 -08:00
bktan8 79365ec3f5 Update vmw-player.rst 2018-02-26 10:16:14 -08:00
bktan8 9264fca554 Update vmw-player-preconf.rst 2018-02-26 10:12:15 -08:00
MCamp859 4d6bf8f2a6 Edited text for grammar, flow, and conciseness.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-02-26 11:59:01 -05:00
Bun K Tan 590da0c54d * Added 2 steps and screenshot on how to power on VM for both "player" and "preconf" docs.
* In the "preconf" doc -> Create and configure -> step 10, I changed "When you attach the pre-configured |CL| VMware image, VMWare removes the default virtual disk making this setting irrelevant" to "The disk settings do not matter at this stage because you will remove the default virtual disk and attach a pre-configured Clear Linux VMware image at a later step" because the former implies that VMware will do it automatically, but in fact, the user will manually remove the default virtual disk.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-02-23 14:02:02 -08:00
Rodrigo Caballero 21bd1a484e Move figures to corresponding folders according to file conventions.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-23 11:48:06 -06:00
Rodrigo Caballero 96c194dfc6 Update virtual-machine-install.rst with the files' new names.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-23 11:29:01 -06:00
Rodrigo Caballero 51ced0c9f8 Fix file names for brevity and convention compliance.
The new file names are half as long but identify the contents just as well.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-23 11:23:45 -06:00
Rodrigo Caballero f3a2ecc6d7 Edit the pre-configured image installation instructions.
Minimal fixes were also implemented on the general instructions too.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-23 10:57:41 -06:00
MCamp859 2ec956e5a7 Edited for grammar, formatting, and text flow.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
2018-02-22 14:01:13 -05:00
Geoffroy Van Cutsem 3d0c2b398f Simplify the image checksum validation instructions
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-02-22 12:25:43 +01:00
Rodrigo Caballero e9d0d05445 Add service restart concept.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-21 09:12:18 -06:00
Adams c7487bba4a Add SMB file sharing tutorial.
Signed-off-by: Adams <eric.adams@intel.com>
2018-02-20 13:59:14 -08:00
Rodrigo Caballero 26f525f7dc Merge pull request #73 from tpleavitt/azure20
Update the MS Azure Tutorial
2018-02-20 11:45:47 -06:00
Rodrigo Caballero 6cb51ae261 Edit vmware-player-install-cl.rst language and content flow.
Drastically simplified the language used and fixed grammar, spelling,
and style issues.
Fixed the content flow. Particularly how the screenshots are handled.
By fixing how the screens were introduced, the steps could be simplified to
a single level. This change provides a much better experience for readers.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-20 11:35:33 -06:00
bktan8 4c31ddfa55 Update vmware-player-install-cl.rst 2018-02-20 10:01:23 -06:00
Bun K Tan 79e98aa24f - Split the previous VMware Player doc into 2 separate docs, 1 per method.
- Changed the names of the images to follow naming convention.
- Re-used content from the "download-verify-uncompress" docs.
- General language fixes.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-02-20 10:01:23 -06:00
Bun K Tan 8f09184172 Merged with the latest main branch
Signed-off-by: Bun K Tan <bktan1@bktan1-mac08.jf.intel.com>

This latest version of the VMware player improved document was merged with the latest main branch and will be in a different branch than the last pull request, which I will remove.

Updated with feedbacks from Ianeta.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>

Update

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>

Updates...

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>

1) Changed the title to "Run Clear Linux as a VMware Workstation Player guest OS".  I think "Use VMware Player" is too generic.

These are changes based on Tom's feedback:

2) Added minimum disk size info.

3) Added minimum memory info and a screenshot.

4) Added file type info for .vmx file in Windows.

5) Added blurb on how to verify checksum for Windows.

-----

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>

Corrected screenshot for figure #19.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>

>>> 2017-11-17
- Converted figures substitution to inline.

>>> 2017-11-21
1) Added brief intro to what VMware Workstation player is.

-----
2018-02-20 10:01:23 -06:00
Rodrigo Caballero 5d945394cf Fix minor markup and language issues.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-16 13:17:36 -06:00
Jose Lamego e4a917545d spark.rst: Add standalone-Spark use case tutorial
Signed-off-by: Jose Lamego <jose.a.lamego@intel.com>
2018-02-14 19:58:35 +00:00
Mary Camp acc99589d2 Fixed spelling, grammar, and text flow.
Markup review not completed.
2018-02-13 13:27:00 -05:00
Rodrigo Caballero 329407cb29 Fixed language and markup for clarity and consistency.
Simplified language for clarity. Changed passive voice to active voice.
Modified code blocks' markup to future-proof content for Document Based
Testing.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-02-13 10:59:22 -06:00
Rodrigo Caballero 09ce2d4647 Merge pull request #81 from jairglez/web-tutorial
Update web tutorial
2018-02-13 09:44:46 -06:00
Rodrigo Caballero 4503f1df5b Fixed minor language issues and markup.
Fixed some clarity and grammar issues.
Fixed the headings' markup to comply with the collaboration guideline.
2018-02-13 09:43:11 -06:00
Ecouzens 5b4690f9d3 Formatting and copy edit of mixer maintenance guide
Signed-off-by: Ecouzens <evan.couzens@intel.com>
2018-02-06 16:30:39 -08:00
Ecouzens 0f2d87cf42 Merge for review
Merge branch 'mixer-doc-update' of https://github.com/kevincwells/clear-linux-documentation into mixer-doc-update
2018-02-05 13:34:54 -08:00
Evan Couzens 9df6997d61 Merge pull request #83 from bktan8/fix-parted-code-block
Fixed formatting issues in the "Increase-virtual-disk-size" document.
2018-02-05 09:48:28 -08:00
Rodrigo Caballero b44ee0cc7a Merge pull request #84 from clearlinux/hwcheck
Reformat output to conform with latest version's output.
2018-01-30 10:54:25 -06:00
Bun K Tan 6283319128 Fixed formatting issues:
- Made the "parted" tool warning code-block look awkward.
- Fixed the "parted" tool note.
- Fixed the "Figure 1" statement under "parted tool" section.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-29 16:08:12 -08:00
Bun K Tan facee27946 Completed VNC document.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-29 15:41:13 -08:00
Auke Kok 3f86b0c65f Reformat output to conform with latest version's output. 2018-01-29 15:19:45 -08:00
Jair Gonzalez 30869c1fa3 Correct the default data directory references
The default data directory for Apache is /var/www/html
in the latest version (tested on VERSION_ID=20490), instead
of /usr/share/httpd/htdocs as specified in the web-server-install
tutorial. This causes several inconsistencies in the "Change the
Default Configuration and Data Directory" section.

This commit updates the steps to configure a different data
directory for demostrative purposes (/var/www/tutorial) as the
proposed one (/var/www/html) is currently the default value.
As the rest of the document and the WordPress server tutorial
refers to /var/www/html, it's also necesary to add aditional steps
to return the configuration back to the original values to leave
it ready for the user to be able to follow the next steps in this
and the WordPress tutorials.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
2018-01-29 12:28:36 -06:00
Jair Gonzalez 0d4b27e4ff Change curly quotes for straight quotes
In the "Change the Default Configuration and Data
Directory" section, the curly quotation marks in the
httpd.conf example cause service start errors when
the text is copied and pasted over directly to the new
httpd.conf file, as part of following the section's
steps.

This commit replaces the curly double quotes with straight
double quotes to correct the wrong behavior.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
2018-01-29 12:28:36 -06:00
Jair Gonzalez 89a38c7d62 Correct typo on default path for httpd.conf
The correct default path for httpd.conf is /usr/share/defaults/httpd
instead of /etc/share/defaults/httpd, as specified on the
web server install tutorial.

This commit corrects it in the document.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
2018-01-29 12:28:36 -06:00
Jair Gonzalez 1cb211448f Update web server install tutorial screenshots
The first two screenshots in the web server install tutorial
don't correspond to the default configuration in the latest
version of the Apache and PHP servers (as tested on
VERSION_ID=20490).

This commit updates both screenshots and the text that refers
to them in the document.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
2018-01-29 12:28:29 -06:00
Evan Couzens 2a4ec0d2ef Merge pull request #79 from bktan8/increase-virtual-disk-size
This is the increase virtual disk size documentation
2018-01-26 13:57:53 -08:00
Kevin C. Wells 310f01deeb Update Mixer documentation
Updating the documentation for mixer to account for recent changes,
and to better clarify some concepts. This is to coincide with an
upcoming release of mixer, in which several important changes will
be introduced.

1) The mixer CLI has been rewritten, supporting POSIX-style flags
and a modern command layout. This is a breaking change, as commands
and flags have been renamed.

2) The initialization steps for mixer have been further automated,
so the documentation has been updated to account for the new,
simpler approach.

3) Documentation has been added for the recent command for
automating the addition of bundles to a mix.

4) The tool now handles caching upstream CLR bundle definitions
in a more automated way, and so the 'mixer get-bundles' command
(and its corresponding documentation section) has been removed.

Signed-off-by: Kevin C. Wells <kevin.c.wells@intel.com>
2018-01-26 12:19:37 -08:00
Evan Couzens c919aaae6a Copy edit for style guide compliance
Signed-off-by: Evan Couzens <evan.couzens@intel.com>
2018-01-26 11:40:37 -08:00
Rodrigo Caballero 905b7202ae Merge pull request #62 from clearlinux/vmware-esxi-improved2
This is the improved VMware ESXi documentation.
2018-01-26 11:42:34 -06:00
bktan8 78571ea4dc Update vmware-esxi-preconfigured-cl-image.rst 2018-01-25 16:13:44 -08:00
bktan8 5374d87c3d Update vmware-esxi-install-cl.rst 2018-01-25 15:57:06 -08:00
Tom Leavitt 4177fef6df Rework the azure.rst document
Incorporate changes requested by Bun and Rodrigo with major changes to
some content

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2018-01-25 13:28:39 -08:00
Evan Couzens 7f52cf29ef Editing for style guide compliance
Signed-off-by: Evan Couzens <evan.couzens@intel.com>
2018-01-25 12:35:58 -08:00
bktan8 9fc3d460b4 Update vmware-esxi-preconfigured-cl-image.rst 2018-01-25 11:23:00 -08:00
bktan8 22a3606782 Update vmware-esxi-install-cl.rst 2018-01-25 11:19:49 -08:00
Bun K Tan 946a7a254e - Renamed all of the images to follow proper naming convention.
- Reworded the "minimum memory" setting when using the installer ISO for the "install" doc.
- Added a phrase on enabling UEFI support in the "preconfigured" doc at the beginning section of "Create and configure a new VM".

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-23 15:48:13 -08:00
Bun K Tan 95c7e1ec98 Merge branch 'increase-virtual-disk-size' of https://github.com/bktan8/clear-linux-documentation into increase-virtual-disk-size 2018-01-23 13:11:12 -08:00
Bun K Tan 62d1a2c318 Refined the instruction.
Merge remote-tracking branch 'upstream/master' into increase-virtual-disk-size

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-23 11:23:47 -08:00
Rodrigo Caballero 6357befa22 Remove cross-references to upcoming documents.
Took out all cross-references to documents not yet merged. Cleaned up the
include directives and changed the image types include to a simple
cross-refernce. Lastly, I rebased the entire branch to remove conflicts.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-01-23 10:24:41 -06:00
Bun K Tan d289a59133 1) Idented all of the "Figure"s text to the same level at the :figure: directives.
2) Restart numbering of the figures for the vmware-esxi-preconfigured-cl-image.rst.
3) Reused "Types of Clear Linux images", "Verify the integrity of the Clear Linux image", and "Uncompress the Clear Linux image" content.
4) Removed labels and references to them.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-23 09:33:10 -06:00
Bun K Tan 7a58605507 Split the VMware ESXi doc into 2 separate docs, 1 per method.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-23 09:33:10 -06:00
Bun K Tan cb1efed189 1) Added minimum disk size (with screenshot) info for Method 1.
2) Added minimum memory size (with screenshot) info for Method 2.

>>> 2017-11-17
Converted figure substitutions to inlines.

>>> 2017-11-21
1) Added brief intro of what ESXi is.
2) Updated the "Download the latest Clear Linux image" section to tell which image to download based on the "Method" type.
3) Added a "Note" to the beginning of "Verify" and "Uncompress" sections to say that the command-line examples reference an "installer ISO" and to substitute as needed.
4) Added reference to the "Workstation" version of VMware in the intro.
5) tagged the "Download", "Verify", and "Uncompressed" sections so they can be re-used in the VMware Workstation doc.

>>> 2017-12-05
1) Moved the "Download", "Verify", and "Uncompress" sections under "Method 1".
2) Re-using the "Types of images", "Verify", "Uncompress" modules from Guides/Maintaince/download-image.rst.

>>> 2017-12-07
1) Made changes based on feedback.
2) Reused content from Guides/Maintenance/download-image.rst.
3) Created labels for each section and ref'ed them at the beginning of each "Method".
4) Updated Figure 26.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-23 09:30:34 -06:00
Bun K Tan 6580bfa845 This is the improved VMware ESXi documentation.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-23 09:27:26 -06:00
Evan Couzens e75734d839 Merge branch 'master' into increase-virtual-disk-size 2018-01-22 10:43:35 -08:00
bktan8 55d3a2c6df Merge branch 'master' into increase-virtual-disk-size 2018-01-22 10:14:20 -08:00
Bun K Tan 9660f4a317 This doc shows how to increase the size of a Clear virtual disk image.
This doc can be referenced by all of the VIRTUAL docs (kvm, hyper-v, vmware, etc.).

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-19 17:00:02 -08:00
Rodrigo Caballero dff34afe72 Merge pull request #78 from JosePerezCarranza/JosePerezCarranza-patch-apps-extras
update bundle name to add VNC viewer
2018-01-15 12:00:21 -06:00
Jose Perez Carranza 02bd94d658 update bundle to add VNC viewer
Add "desktop-apps-extras" instead of "desktop-apps" to install VNC viewer on Clear Linux environment
2018-01-15 11:40:15 -06:00
Rodrigo Caballero c9867f3121 Merge pull request #77 from clearlinux/rcaballeromx-usb
Restructure and reuse of USB instructions
2018-01-12 12:20:39 -06:00
Tom Leavitt 5fb205a1ad Minor updates from Bun's review
Minor changes requested by Bun for updates

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2018-01-12 10:14:08 -08:00
Bun K Tan f35df7dc89 Restored these changes that I made prior to the Xmas holiday:
1) Fixed language per feedback.
2) Renamed Rufus-figure-1.png, Rufus-figure-2.png, Rufus-figure-3.png, 7zipwin.png to approved figure naming convention.
3) Fixed minor markup issues.

Sgne-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-11 15:47:09 -08:00
Rodrigo Caballero 66e34fc059 Fix heading uderline and typo.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-01-11 12:26:24 -06:00
Rodrigo Caballero 80b834cca5 Merge pull request #76 from sirredbeard/patch-1
Removed unnecessary brackets.
2018-01-11 12:18:12 -06:00
Rodrigo Caballero c02b52da15 Fix include directives and replace some of them with simple links.
Several include directives were unnecessary since a simple cross-reference
was more appropriate in terms of content architecture.
Simplified the includes employed to enhance maintainability.
Created duplicate figure file to enable reuse.
Fixed headings for consistency.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2018-01-11 11:40:53 -06:00
Bun K Tan 0f12f4cc1f Rewrite and modularization of image types, how to verify, how to uncompress..
On 2017-11-30:
--------------
1) Created the download-image.rst file in the Guides/Maintaince.  This is a hidden file and not visible under the Maintenance tree.  This talks about types of Clear Linux images, how to verify checksum, and how to uncompress for Linux, macOS, and Windows.  This is the base for other docs such as the bare-metal, live, bootable USBs (Linux, macOS, Windows), VMware docs...
2) Reworked the bootable-usb-linux.rst to re-use content from download-image.rst.
3) Reworked the bootable-usb-mac.rst to re-use content from download-image.rst.
4) Reworked the bootable-usb-windows.rst to re-use content from download-image.rst.
5) Reworked the live-image.rst to re-use content from bootable-usb-linux.rst and download-image.rst.
6) Reworked the bare-metal doc to re-use content from bootable-usb-linux.rst and download-image.rst.

On 2017-12-01:
--------------
1) Updated the types of images list and created a table.
2) Remove references to the old "releases" repo.  Users should only use the "image" folder - per engineering.

On 2017-12-05:
--------------
1) Recaptured the 7zip screenshot and made it look better.
2) Added "download-image.rst" to the Guides/Maintenance/maintenance.rst" tree to make it visible.
3) Moved the "Download the latest Clear Linux image" out of the "download-image.rst" and put it into
   the "bootable-usb-linux.rst" and tagged it so it could be used by "bootable-usb-mac.rst" and
   "bootable-usb-windows.rst".

On 2017-12-07:
--------------
1) Changed the "Types of images" list Guides/Maintenance/download-image.rst to a table format.

On 2017-12-13:
--------------
1) Changed all instances of <> to [] to indicate substitution.
2) Added |CAUTION-BACKUP-USB| in substitution.rst.  This is used in create-usb-linux.rst, create-usb-mac.rst, create-usb-windows.rst.
3) Deleted download-image.rst and created 3 new docs, one for each OS: download-verify-uncompress-linux.rst, download-verify-uncompress-mac.rst, download-verify-uncompress-windows.rst.
4) General fixes based on feedback.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2018-01-11 09:53:19 -06:00
Hayden d7862de653 Removed unnecessary brackets.
Removed unnecessary brackets from date.
2018-01-07 00:22:16 -05:00
Tom Leavitt c96aab3b47 Update the MS Azure Tutorial
Update the MS Azure tutorial to use Azure CLI 2.0

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-12-18 14:06:03 -08:00
Rodrigo Caballero 8fab20a747 Merge pull request #72 from rcaballeromx/azure
Remove unwanted link to WordPress tutorial.
2017-12-18 13:08:00 -06:00
Rodrigo Caballero 8f946d06bb Remove unwanted link to WordPress tutorial.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-18 13:00:08 -06:00
Rodrigo Caballero 267546e617 Merge pull request #69 from bktan8/fix-apt-get-install-command
Fix 2 apt-get commands missing "install" option.
2017-12-15 15:39:25 -06:00
Bun K Tan a5df65b2f4 On 2017-Dec-15:
---------------
Fixed a couple of a apt-get commands that were missing the "install" option.

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2017-12-15 13:03:18 -08:00
Rodrigo Caballero 0e05c524b5 Merge pull request #68 from rcaballeromx/figure-fix
Fix figures on Multi-boot tutorial.
2017-12-15 14:39:06 -06:00
Rodrigo Caballero afe412b317 Fix figures on Multi-boot tutorial.
This document added screenshots without using the figure directive.
Thus, the captions did not have the correct CSS class.
I applied the figure directive and removed the substitutions.
The captions now have the appropriate CSS class in HTML.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-15 14:33:39 -06:00
Rodrigo Caballero 666dbf0e73 Fix capitalized extensions of image filenames.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-13 14:05:01 -06: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
Rodrigo Caballero cae3f21c0d Merge pull request #67 from bryteise/cpu-requirements-update
Update cpu instruction set requirements
2017-12-12 16:38:50 -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 1d583b2fb1 Fix repo link on clone command of README.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-12 16:18:44 -06:00
Rodrigo Caballero 6bc15cd809 Merge pull request #66 from rcaballeromx/navi
Expand toctree of Concepts and Get started to 2 levels for consistency.
2017-12-12 14:03:13 -06:00
Rodrigo Caballero 50a9e5d300 Merge pull request #63 from clearlinux/aws-web
Initial checkin of AWS web tutorial
2017-12-12 12:51:24 -06:00
Rodrigo Caballero 192f101cf0 Merge branch 'master' into aws-web 2017-12-12 12:50:16 -06:00
Tom Leavitt c71d61a1f3 finalize the figure 11 reference
finalize the figure 11 reference
2017-12-12 10:49:11 -08:00
Tom Leavitt 5fb10cb6f3 Correct figure reference link
added the tick marks in the :ref: label
2017-12-12 09:56:38 -08:00
Tom Leavitt 8c086bcf00 Add figure 11 reference to aws-web.rst
Add the reference label for figure 11
2017-12-12 09:54:30 -08: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 7669f13713 Expand toctree of Concepts and Get started to 2 levels for consistency.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-11 10:30:17 -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
Tom Leavitt ab1cc8cfd7 Updates to aws-web.rst per Rodrigo comments
Updates to the aws-web.rst file to address comments from Rodrigo
2017-11-27 15:25:25 -08:00
Rodrigo Caballero 35ea5f2e1b Fix filename capitalization for telemetry-backend.rst
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-11-27 11:50:51 -06:00
Rodrigo Caballero fc94038df4 Merge pull request #58 from clearlinux/telem-backend
Add the telemetry backend server tutorial
2017-11-21 12:11:01 -06:00
Tom Leavitt 8d873f2bad Updates to aws-web.rst
Updates to the tutorial based on feedback from Ianeta

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-11-20 10:30:56 -08:00
Tom Leavitt 78846def94 Initial checkin of AWS web tutorial
This is the tutorial for creating and accessing a clear linux image on
Amazon Web Services

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-11-17 13:34:44 -08:00
Tom Leavitt c2cb0b5172 Additional updates
Updates based on @rcaballeromx comments and suggestions
2017-11-16 10:38:00 -08:00
Rodrigo Caballero 5e6ee8d164 Merge pull request #55 from clearlinux/time
Adds instructions to change the time using systemd-timesyncd.service.
2017-11-16 09:38:13 -06:00
ihutchin 1f44407461 Removed unneccesary and potentially incorrect information and fixed rst.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-11-15 16:53:06 -08:00
Tom Leavitt 2990bb7be2 Update Telemetry-backend.rst
Initial updates requested by @iphutch
2017-11-14 14:59:28 -08:00
Ianeta Hutchinson d6fe2db526 Merge pull request #60 from clearlinux/fix-windows-sha512-cmd
Fixed a Windows command error
2017-11-13 14:26:44 -08:00
Ianeta Hutchinson 6983d2ab83 Removing white spaces 2017-11-13 14:25:36 -08:00
Bun K Tan c5833cd8a5 Fixed a Windows command error
Signed-off-by: Bun K Tan <bktan1@bktan1-mac08.jf.intel.com>
2017-11-13 13:59:01 -08:00
Tom Leavitt b8655a12eb Add the telemetry backend server tutorial
Tutorial to create and use a telemetry backend server

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-11-09 15:02:41 -08:00
Rodrigo Caballero 277bf974b3 Merge pull request #56 from clearlinux/remove-visudo
Remove visudo command from enable-user-space
2017-11-07 15:58:22 -06:00
Tom Leavitt beb345e383 Remove visudo command from enable-user-space
Remove the text about editing the /etc/sudoers file and using vi and visudo
2017-11-07 13:43:07 -08:00
ihutchin df8ec09cae Adds instructions to change the time using systemd-timesyncd.service.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-11-06 13:14:02 -08:00
Ianeta Hutchinson e37d83bc2c Merge pull request #53 from clearlinux/bare-metal-install-fix
Update bare-metal-install.rst
2017-10-31 15:18:04 -07:00
Tom Leavitt d52d6c9fd2 Update bare-metal-install.rst
removed errant tick mark to fix a :guilabel: ref
2017-10-31 11:27:42 -07:00
Ianeta Hutchinson 1794e126f5 Merge pull request #50 from clearlinux/fmv
Add the FMV tutorial content.
2017-10-31 11:06:15 -07:00
Ianeta Hutchinson a9d613b776 Merge branch 'master' into fmv 2017-10-31 11:05:56 -07:00
Rodrigo Caballero 32644a4e4e Fix ambiguous language and merge conflict.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-31 11:46:07 -06:00
Ianeta Hutchinson 27b35b5cc6 Merge pull request #44 from clearlinux/hadoop
Add Hadoop use case tutorial.
2017-10-31 09:48:42 -07:00
Rodrigo Caballero 13fcc866c7 Fix typographic apostrophe causing link to privacy policies to break.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-30 16:25:45 -06:00
Rodrigo Caballero 89b82e5613 Rename Telemetry enablement guide to comply with naming conventions.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-30 14:33:51 -06:00
Rodrigo Caballero 4962a15dbf Fixed missing or incorrect markup and minor language issues.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-30 14:31:35 -06:00
Rodrigo Caballero 1817bd8cdb Edited for clarity, added missing articles and nouns.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-30 10:41:13 -06:00
Rodrigo Caballero 7ef76bb61f Merge branch 'bare-metal-options' of https://github.com/clearlinux/clear-linux-documentation 2017-10-25 17:01:46 -05:00
Tom Leavitt 3981d23c62 Remove the word "appears..."
update the bare-metal-manual-install to remove 2 instances of the word "appears"
2017-10-25 14:15:41 -07:00
Tom Leavitt 5d883d8154 Add clarity to the passwd command
Add additional wording describing the passwd prompts to enter and re-enter the new password.
2017-10-25 14:07:44 -07:00
Tom Leavitt c6188f1c51 Add reviewer changes for enable-user-space
Minor updates based on reviewer comments to the enable-user-space.rst file
2017-10-25 09:54:20 -07:00
Tom Leavitt b63daa17e9 Updates to the cgdisk tutorial for continuity
Requested updates for present tense, clarity continuity

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-10-24 15:40:47 -07:00
Tom Leavitt 5dd68cfb03 Updates to bare-metal-manual-install for content
Reviewed and addressed all comments for the bare-metal-manual-install.rst file for present tense, active voice and rewriting sections.
2017-10-24 13:05:36 -07:00
Rodrigo Caballero 1edc07bb66 Merge pull request #48 from clearlinux/telemetry-update
Telemetry enable/disable guide
2017-10-24 14:04:55 -05:00
Rodrigo Caballero 3f6b6ce010 Merge pull request #49 from Xeleron/master
fix hyperv link
2017-10-24 12:36:42 -05:00
Tom Leavitt be1df8a364 Update bare-metal-manual-install.rst
Updates to the intro to this document to make it more readable as recommended by Rodrigo
2017-10-23 15:05:59 -07:00
Tom Leavitt de5815fbe5 Update bare-metal-install.rst
punctuation fixes requested by Rodrigo
2017-10-23 14:58:43 -07:00
Rodrigo Caballero 2c6489e0d2 Merge pull request #52 from clearlinux/bye-ciao
Remove ciao content from clearlinux.org/documentation
2017-10-23 08:44:20 -05:00
Tom Leavitt 7469489d15 Change directive to lowercase
Changed Note to note
2017-10-20 13:47:40 -07:00
Tom Leavitt 3e20be0758 Update telemetry-enable to present tense
Update the voice to present tense and remove passive words

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-10-20 12:02:33 -07:00
Tom Leavitt fc3f4f2930 Merge branch 'bare-metal-options' of https://github.com/01org/clear-linux-documentation into bare-metal-options 2017-10-19 14:34:44 -07:00
Tom Leavitt 2adc76b40f Rename all .png files to spec
Rename all .png files to appropriate file-name-fig# and update the .rst
files to call correctly.  Also included minor updates to text

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-10-19 13:59:37 -07:00
Rodrigo Caballero be7d55bcb3 Remove ciao content from clearlinux.org/documentation
Ciao has created their own content in their repos. Therefore, this
content is redundant and causes confusion.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-19 09:58:20 -05:00
Rodrigo Caballero 032b7974fe Add the FMV tutorial content.
The Function Multi-versioning tutorial content was provided by Victor Rodriguez.
This version has been edited and the markup fixed to comply with the
documentation repo's guidelines.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-19 09:38:18 -05:00
Rodrigo Caballero 2d6c8e8764 Add SSH connectivity and wordcount example to Hadoop tutorial.
Beyond adding those two sections, some commands were updated and other minor
issues were fixed.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-10-18 15:08:16 -05:00
Tom Leavitt 8cb2f63a73 change reference to telemetry-enable
change reference of telemetry-enable to match filename and label
2017-10-18 11:45:52 -07:00
Tom Leavitt f94a44de0d Update and rename Telemetry-Enable-Disable.rst to Telemetry-Enable.rst
Change filename to telemetry-enable.rst and change label to match
2017-10-18 11:44:39 -07:00
Marko Cubela 5e34e0b9d1 fix hyperv link 2017-10-14 11:05:56 +02:00
ihutchin a781ddbef4 Inserts section for creating a new user and setting a password
Altered the enable-user-space to include the initial step of creating
a user. Also added "Create a new user" to the list of capabilities after
installation. I changed the heading of `enable user space` to reflect changes.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-10-13 15:42:28 -07:00
Tom Leavitt 0e736d16c9 Updated cross-references and fixed minor issues
Updated get-started.rst to add references to bare-metal-* files
Update cross-reference in bare-metal-manual and cgdisk-manual-install
files.  Fixed minor issues within content

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-10-11 15:47:16 -07:00
Tom Leavitt 96251bbc64 updates to the cgdisk instructions
Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-10-11 11:39:38 -07:00
Tom Leavitt 63f9565e30 Updates to the manual install guide
Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-10-10 15:31:34 -07:00
Tom Leavitt 4e8e380a18 Updates to bare-metal-install
Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
2017-10-10 14:11:10 -07:00
Tom Leavitt d052919209 cosmetic updates to the telemetry file
changes to the telemetry-enable-disable file based on review from Rodrigo
2017-10-09 13:52:29 -07:00
Tom Leavitt 8b9d754a2f changes up to installation type
Changes recorded up to the choose installation type.  The document needs more work and taking it offline
2017-10-09 13:31:00 -07:00
Tom Leavitt 874f7d23fe fix opt-out command
removed the wrong line in the previous change.
2017-10-05 14:23:16 -07:00
Tom Leavitt fe07e66c25 Add note to stop services after opt-in
This adds a note to enable telemetry but delay starting the service.
2017-10-05 14:06:10 -07:00
Tom Leavitt eaa041fc78 requested updates to telemetry enable/disable
several changes requested to clarify functionality and clean up document
2017-10-05 09:03:28 -07:00
Tom Leavitt 8f891366c0 typo fix
fix mispelling telemetry
2017-10-04 13:26:02 -07:00
Tom Leavitt 9f69cf69a6 typo fix
fix mispelling telemetry
2017-10-04 13:25:20 -07:00
Tom Leavitt 2c9d2ef91a Add telemetry-enable-disable
Add this entry to the toctree list
2017-10-04 13:21:13 -07:00
Tom Leavitt a801942c30 Add telemetry enable/disable guide
this guide walks through installing, enabling, disabling and removing the telemetrics feature
2017-10-04 13:19:32 -07:00
Rodrigo Caballero 230d4d187a Merge pull request #47 from 01org/custom-container-image
Adds a new network guide to create a custom container image.
2017-10-02 16:52:31 -05:00
ihutchin f59a698781 Makes optional step indentation consistent with other steps.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-10-02 14:16:59 -07:00
ihutchin 2af4eaaa2e Fixes language and structure issues.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-10-02 14:10:25 -07:00
ihutchin ce8f8668cc Adds a new network guide to create a custom container image.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-10-02 11:55:06 -07:00
Tom Leavitt 41070e9c48 Update bare-metal-install.rst
changes recommended by the engineering team to correct the repair description and removed final step to create a userid since that is duplicated in the enable-user-space section.
2017-10-02 10:34:53 -07:00
ihutchin 1e66b12e12 Fixes abbreviation directive
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-10-01 21:40:26 -07:00
ihutchin c32ed6a8f9 Fixes title capitalization and toctree indentation
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-10-01 21:35:09 -07:00
ihutchin 5e983578d6 Adds option to manual install to partition disk using cgdisk
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-10-01 21:18:22 -07:00
ihutchin 487391bdac Numbers steps, makes one full guide, moves re-usable section to guide.
Makes an end-to-end auto bare-metal doc with a branch to manual install.
Post installation tasks separated and moved to maintenance guide.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-09-28 21:20:40 -07:00
Rodrigo Caballero b57e08b19b Update Hadoop tutorial based on review feedback.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-26 14:30:08 -05:00
ihutchin f7b5b5087e Provides options for automatic or manual installs on bare metal.
Cleans up the bare metal install steps prior to the manual vs auto
decision with new screen captures. Then, forks to provide two ways
to install on bare-metal.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-09-22 12:29:26 -07:00
Rodrigo Caballero c1f7581692 Add Hadoop use case tutorial.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-21 16:26:08 -05: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
Rodrigo Caballero 7d2118006e Merge pull request #43 from 01org/cc-3
Update Clear Containers docs to release 3.0
2017-09-21 13:46:10 -05:00
Rodrigo Caballero 7e67b72c92 Update Clear Containers docs to release 3.0
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-21 13:44:17 -05:00
bktan8 86f8cc9c6e Update system-requirements.rst 2017-09-20 14:35:52 -07:00
bktan8 f30c824672 Update live-image.rst 2017-09-20 14:34:07 -07:00
bktan8 a4b436e6e4 Update compatibility-check.rst 2017-09-20 14:31:35 -07:00
bktan8 d5525c88ae Update bootable-usb.rst 2017-09-20 14:29:03 -07:00
bktan8 2f6baf2ec8 Update bootable-usb-windows.rst 2017-09-20 14:28:10 -07:00
bktan8 d0e41106df Update bootable-usb-mac.rst 2017-09-20 14:27:54 -07:00
bktan8 4b39cb6e39 Update bootable-usb-linux.rst 2017-09-20 14:27:33 -07:00
Ianeta Hutchinson ec71b24e8d Sentence caps 2017-09-15 15:02:50 -07:00
ihutchin df8f2275b7 Fix RST warnings
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-09-15 14:59:17 -07:00
Bun K Tan 137f347775 I updated the docs below and modularized.
Signed-off-by: Bun K Tan <bktan1@bktan1-mac08.jf.intel.com>
2017-09-14 11:23:58 -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
Bun K Tan b7e2ec9b81 This is a test...
Signed-off-by: Bun K Tan <bktan1@bktan1-mac08.jf.intel.com>
2017-09-11 16:24:21 -07:00
bktan8 a5dd6304ef Update live-image.rst 2017-09-11 16:19:14 -07:00
ihutchin e21d4aeefa Updating rst for improvements on compatability check file.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-09-11 15:54:29 -07:00
Ianeta Hutchinson df9e468316 Merge pull request #38 from 01org/kvm-ref
Add the kvm-host bundle reference information.
2017-09-11 10:30:02 -07:00
Rodrigo Caballero a01eadb020 Merge pull request #36 from 01org/bvm2
Re-writes kvm docs for greater technical accuracy
2017-09-11 12:15:13 -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
bktan8 9ce08c74be Update compatibility-check.rst 2017-09-08 16:01:11 -07:00
bktan8 fadfc88a35 Update compatibility-check.rst 2017-09-08 15:58:30 -07:00
bktan8 fd8ede0cef Update compatibility-check.rst 2017-09-08 15:50:33 -07:00
bktan8 367cf0e3e9 Update compatibility-check.rst 2017-09-08 15:32:48 -07:00
bktan8 b06bb3c828 Update compatibility-check.rst 2017-09-08 15:23:39 -07:00
bktan8 58f209e792 Update compatibility-check.rst 2017-09-08 14:54:48 -07:00
bktan8 f8eea61f85 Update compatibility-check.rst 2017-09-08 14:23:20 -07:00
bktan8 9183978164 Update compatibility-check.rst 2017-09-08 14:15:02 -07:00
Ianeta Hutchinson f68808fd42 Merge pull request #37 from 01org/bdl-upd
Update available bundles table.
2017-09-08 14:02:19 -07:00
Ianeta Hutchinson b2b016280a Merge pull request #33 from 01org/ipxe
Update the iPXE instructions.
2017-09-08 14:00:45 -07:00
Rodrigo Caballero a29c1339a5 Merge pull request #7 from mrkz/kvm-host
clear-linux: Add information about kvm-host bundle.
2017-09-08 14:41:39 -05:00
Rodrigo Caballero 013c941547 Remove unnecesary note and fix numbering of the steps.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-08 14:38:30 -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
ihutchin 7d02f0a925 Re-writes kvm docs for greater technical accuracy
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-09-08 11:59:07 -07:00
bktan8 4c48ea7d71 Update ipxe-install.rst 2017-09-08 11:24:08 -07:00
bktan8 108330f049 Update ipxe-install.rst 2017-09-08 11:09:07 -07:00
Ianeta Hutchinson b70580ed60 Title change: Recommended minimum system requirements 2017-09-06 13:34:58 -07:00
Ianeta Hutchinson 2e0f058316 Changes heading level for consistency in USB files 2017-09-06 12:23:23 -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
bktan8 66ad40ba70 Update ipxe-install.rst 2017-09-05 11:31:21 -07:00
Rodrigo Caballero 01835f7dc4 Update the iPXE instructions.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-09-01 08:30:40 -05:00
Rodrigo Caballero 2adb780198 Merge pull request #32 from 01org/cl-restructure
Restructures Clear Linux documentation to have five main sections
2017-08-31 16:24:25 -05:00
Ianeta Hutchinson 8058630a52 Applies substitution and clarifies sentence 2017-08-31 09:30:25 -07:00
Ianeta Hutchinson 26912ddda1 Improves sentence clarity 2017-08-30 13:30:57 -07:00
Ianeta Hutchinson 8b1b1a5965 reverting unneccesary changes 2017-08-30 12:11:52 -07:00
ihutchin 9de655405f Fixes two language issues
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-08-30 09:06:31 -07:00
Ianeta Hutchinson 55cbf61297 fix typos in clear linux documentation home 2017-08-29 18:54:01 -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
Rodrigo Caballero 88849819fd Merge pull request #23 from 01org/testing
Change to CLOSIA substitution and change italics to monospace for application names.
2017-08-28 16:03:45 -05:00
Rodrigo Caballero cb1676c8cb Merge pull request #28 from 01org/multi-boot
Add multi-boot tutorial for multiple operating systems
2017-08-25 15:08:31 -05:00
Rodrigo Caballero 942a4e5040 Fix issues in multi-boot tutorial.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-08-25 15:05:36 -05:00
Rodrigo Caballero 87af8defad Apply feedback to multi-boot tutorial
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-08-25 14:09:10 -05:00
bktan8 28fa2af4de Update multi-boot.rst 2017-08-25 11:13:16 -07:00
bktan8 e48ff134f2 Update multi-boot.rst 2017-08-25 11:08:45 -07:00
Rodrigo Caballero a33aa84e82 Merge pull request #29 from 01org/hyper-v-update
Update hyper-v links and content
2017-08-22 16:52:59 -05:00
Tom Leavitt 0e9bc7cf59 Update hyper-v links and content
Updating the external links to Microsoft documentation to point to appropriate content and adding the section "Create a virtual network"
2017-08-22 14:14:44 -07:00
Rodrigo Caballero 8956a98d7b Add multi-boot tutorial for multiple operating systems
This tutorial guides users through the process of installing other operating
systems alongside Clear Linux.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-08-22 11:36:00 -05:00
Rodrigo Caballero c26d49d804 Merge pull request #25 from 01org/cl-install-update
fix broken link to swupd
2017-08-17 11:33:35 -05:00
Tom Leavitt 58d6fe8387 fix broken link to swupd
Fixes the broken link to more information about software update
2017-08-16 14:12:57 -07:00
Rodrigo Caballero 40843b600d Merge pull request #14 from 01org/ml
Add machine learning tutorial.
2017-08-15 16:13:55 -05:00
Rodrigo Caballero 4dcfde73ee Update the path of the code example.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-08-15 12:57:42 -05:00
Rodrigo Caballero 0d6017e1cd Merge pull request #24 from 01org/update-cc-versions
Update the Docker release version.
2017-08-15 11:05:12 -05:00
Rodrigo Caballero 183d1f025e Update the Docker release version.
Updated the release version of Docker compatible with the runtime. Removed the
release number of the Clear Containers to avoid having to update it every week.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-08-15 10:43:59 -05:00
ihutchin 1e98bd0c8d Change quotations to literal text with backticks
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-08-14 13:31:05 -07:00
ihutchin 810030171c Change to CLOSIA substitution
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2017-08-14 12:27:35 -07:00
Tom Leavitt bb59955c87 Merge pull request #22 from 01org/clear-lamp-server-mods
I've made the additional changes for the Clear lamp server tutorial mods
2017-08-14 10:13:44 -07:00
Tom Leavitt 0810aa55bf Merge branch 'clear-lamp-server-mods'
of https://github.com/01org/clear-linux-documentation into clear-lamp-server-mods

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>
2017-08-14 10:00:25 -07:00
Tom Leavitt f1d2af20d1 Update the tutorial Creating a WordPress Server for stateless
Replace all occurrences of /usr/share/httpd/htdocs with /var/www/html as defined in the Creating a LAMP Server tutorial stateless modifications
2017-08-14 09:58:49 -07:00
Tom Leavitt a64e18c056 Additional updates to clean up text
Additional changes to add appropriate labels to file tags
2017-08-14 09:43:40 -07:00
Tom Leavitt bd9d05a73e Update the tutorial Creating a WordPress Server for stateless
Replace all occurrences of /usr/share/httpd/htdocs with /var/www/html as defined in the Creating a LAMP Server tutorial stateless modifications
2017-08-10 11:36:11 -07:00
Tom Leavitt c08e8dc5d2 Update the Creating a LAMP Server document for stateless requirements
Add additional steps to change the default Apache DocumentRoot to /etc/www/html by adding additional .conf files in /etc/httpd/conf.d and changing all references to this new DocumentRoot directory.
2017-08-10 11:25:54 -07:00
Rodrigo Caballero 65b6970ff0 Merge pull request #21 from cmarcelo/fix-openssh
Fix instructions for openssh-server bundle doc
2017-08-04 16:29:04 -05:00
Caio Marcelo de Oliveira Filho a4e557f862 Fix instructions for openssh-server bundle doc
Use "mkdir -p" to avoid failure when some part in the middle of the
path doesn't exist (this is currently the case with a freshly
installed Clear 16820).

Add instruction to reload the systemd configuration, otherwise the
OPTIONS line won't be used and the subsystem won't work.

Signed-off-by: Caio Marcelo de Oliveira Filho <caio.oliveira@intel.com>
2017-08-04 13:13:12 -07:00
Rodrigo Caballero 9290ee1808 Merge pull request #19 from cmarcelo/fix-ister-url
Fix ister link
2017-08-04 09:03:46 -05:00
Rodrigo Caballero 6de99c9207 Merge pull request #18 from miguelinux/ignore-build
gitignore: fix build directory
2017-08-04 09:03:14 -05:00
Caio Marcelo de Oliveira Filho a75b82c0b7 Fix ister link
Moved from clearlinux/ister to bryteise/ister (at least for now).

Signed-off-by: Caio Marcelo de Oliveira Filho <caio.oliveira@intel.com>
2017-08-01 16:27:53 -07:00
Miguel Bernal Marin 6b0f4af4a0 gitignore: fix build directory
Fix the build directory path in the gitignore file.

Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
2017-08-01 15:24:49 -05:00
Rodrigo Caballero 679de52726 Merge pull request #17 from 01org/test
Change notice from important to note on the Wordpress tutorial.
2017-07-26 15:02:52 -05:00
Rodrigo Caballero b24cfb4c37 Change notice from important to note on the Wordpress tutorial.
The website does not support important notices, therfore the notice had to
change to a note.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-07-25 13:40:36 -05:00
Rodrigo Caballero a5851eaf28 Merge pull request #15 from 01org/gs-content-move
Separates install options in gs guide.
2017-07-24 14:06:13 -05:00
ihutchin cc336f2bd7 Remove unnecessary verbage and hard-coded links. 2017-07-24 11:56:34 -07:00
ihutchin 267fa18384 Improves readability and flow within gs guide.
Includes kernel in gs contents page introduction and adds
compatibility check to doc-tree.
Improves introduction to compatible kernels and bundles.
Updates links to avoid hard coding.
2017-07-20 16:08:32 -07:00
ihutchin 1dd5881251 Separates install options in gs guide.
Moves bare metal install from tutorial to getting started guide.
Removes repeated and/or out of date information about VM and BM
installations and hardware compatibility check. Adds reference
tags for future documentation.
2017-07-17 17:12:59 -07:00
Rodrigo Caballero 7eb1fc790d Add machine learning tutorial.
The machine learning tutorial showcases how to install, configure, and run a
Jupyter notebook on Clear Linux with the MNIST example.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-07-17 11:09:23 -05:00
Rodrigo Caballero 7f45ae29c2 Merge pull request #13 from gtkramer/master
Correct update content validation commands
2017-07-14 09:01:16 -05:00
George T Kramer a57a80687d Correct update content validation commands
To verify the Manifest.MoM, the signature of the Manifest.MoM should be compared with the Swupd certificate, not the Clear Linux certificate.  Also, adding a section for manually validating the Swupd certificate so that it matches the section for manually validating the Clear Linux certificate.  Making the distinction between the Clear Linux certificate and the Swupd certificate more clear.
2017-06-29 15:29:19 -07:00
Rodrigo Caballero 47837bf7c0 Merge pull request #11 from 01org/restructureGS
Restructures Getting Started guide.
2017-06-23 11:02:40 -05:00
Ianeta Hutchinson 0ef78a2210 Update installation-options.rst
Removing cross-reference to deleted file.
2017-06-23 10:36:55 -05:00
Ianeta Hutchinson 0ef30fc1eb Update getting-started.rst 2017-06-23 09:37:46 -05:00
Ianeta Hutchinson d8f515448b Update getting-started.rst 2017-06-23 09:34:52 -05:00
ihutchin 0eea7ed061 Restructures Getting Started guide.
Removes outdated files and re-arrages doc-tree to clearly
display 3 means of installation: VM, BM, and Live image.
2017-06-22 20:21:31 -05:00
Rodrigo Caballero fccbdfd06c Merge pull request #10 from mrkz/enable_man_command_swupd_manpage
clear-linux: ensure user have 'man' command prior running man swupd.
2017-06-16 15:07:22 -05:00
Simental Magana, Marcos eb329436c6 clear-linux: ensure user have 'man' command prior running man swupd.
Documentation recommends the user to access swupd the man page for
further details, however user may not have /usr/bin/man command
installed, so document that he/she needs to install 'sysadmin-basic'
bundle prior to actually accessing the man-page.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2017-06-16 15:04:00 -05:00
Rodrigo Caballero f46b6349c3 Fix broken MMU link on CC architecture overview.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-06-15 16:32:51 -05:00
Rodrigo Caballero a010093d69 Merge pull request #1 from miguelinux/improve-infra
Improve infra
2017-06-15 16:29:12 -05:00
Rodrigo Caballero 4feca7e56e Merge pull request #8 from 01org/run
Update the instructions to run swupd to account for auto-update.
2017-06-14 09:51:21 -05:00
Rodrigo Caballero 4c417f9f00 Fix minor wording issues for consistency and clarity.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-06-14 09:27:04 -05:00
Rodrigo Caballero 9d5e13a7fb Apply feedback on updated swupd content.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-06-13 14:15:12 -05:00
Rodrigo Caballero 17e4d52145 Merge pull request #9 from mrkz/dont_use_xzcat_v
clear-linux: update bare-metal-install xzcat command option
2017-06-13 10:20:41 -05:00
Simental Magana, Marcos c98e8fec60 clear-linux: update bare-metal-install xzcat command option
Removing the '-v' option from the xzcat command line due
to verbose output getting piped into the dd command causing
corruption on image creation.
Based on previous PR[1].

[1]-https://github.com/01org/clear-linux-documentation/pull/6

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2017-06-13 10:16:54 -05:00
Rodrigo Caballero 04fed04b72 Update the instructions to run swupd to account for auto-update.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-06-13 09:16:04 -05:00
Tullis, Michael L b5fc4e31d9 Fixed bullet list rendering error in bare-metal-install.rst 2017-06-09 13:54:51 -07:00
Tullis, Michael L 001dde91f1 bare-metal-install.rst: Latest changes from Tom and incorporating review from Bun. 2017-06-09 13:47:33 -07:00
Tullis, Michael L a2b4eb7d4c Correcting figure in bare-metal-install.rst 2017-06-09 10:39:00 -07:00
Tullis, Michael L fcdece9cf6 Tom's changes to bare-metal-install.rst. Also adding a figure. 2017-06-09 10:29:04 -07:00
Tullis, Michael L 83e4e3b65e Tom Leavitt's changes to flatpak tutorial 2017-06-09 09:20:57 -07:00
Tullis, Michael L 650be6bdf8 Docs: Removed optional steps and one image from virtualbox.rst per direction from Tom Leavitt. 2017-06-07 15:13:39 -07:00
Simental Magana, Marcos 600aa3fa73 clear-linux: Add information about kvm-host bundle.
This commit adds general information about the kvm-host
bundle content and how to enable/start some services
that may be required when this bundle is installed.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2017-06-07 09:09:07 -05:00
mltullis 7909c089d3 Merge pull request #6 from bryteise/xzcat-command-update
clear-linux: Update bootable-usb xzcat command option
2017-06-06 11:35:24 -07:00
William Douglas a8087efc5d clear-linux: Update bootable-usb xzcat command option
Do not use -v with xzcat based on experience with it causing issues
since the verbose output sometimes gets piped to the dd command.
2017-06-06 18:15:56 +00:00
mltullis b3a7de4ca1 Merge pull request #5 from dbkinder/network-bonding
network: techwriter pass on network bonding guide
2017-06-05 13:16:01 -07:00
David B. Kinder 0e212e9e86 network: techwriter pass on network bonding guide
Adjusted guide to use numbered process steps, removed invalid :caption:
parameter on code-block sections, plus some clarification edits and
80-character line length formatting

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-06-05 13:02:14 -07:00
mltullis 4ac7aa7761 Merge pull request #4 from bwarden/add-bonding-instructions
network: Add guide for network bonding
2017-06-05 09:43:54 -07:00
Brett T. Warden 8159aa5ca4 network: Add guide for network bonding
Add a guide for network bonding, including systemd network
configuration.

Signed-off-by: Brett T. Warden <brett.t.warden@intel.com>
2017-06-05 08:56:10 -07:00
Rodrigo Caballero 0e4b784505 Merge pull request #3 from miguelinux/fix-cc-architecture-overview
fix bad link on cc-architecture-overview
2017-06-02 14:23:23 -05:00
Miguel Bernal Marin f72905c6c3 fix bad link on cc-architecture-overview
The page was using bad ReST reference stricture producing broken links.
This commit uses ReST cross reference by labels.

Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
2017-06-02 14:15:33 -05:00
Miguel Bernal Marin 45678abde7 Makefile: rebuild root Makefile
Makefile is rebuild with simple targets to point to source directory.
Now the users can use "make" or "make html" at root repo path and the
html documentation is built.
2017-05-30 11:40:25 -05:00
Miguel Bernal Marin b5f8fc33fd conf.py: fix warning on html_static_path
A warning is showed when compiling the documentation:

WARNING: html_static_path entry '/home/git/clear-linux-documentation/source/_static' does not exist

After documentation restructure, the _static directory is no more needed.
This commit comment out html_static_path in config.py, and the warning
is not showed.
2017-05-30 11:23:51 -05:00
Miguel Bernal Marin cc14739d3b conf.py: fix html_add_permalinks
When compiling documentation a warning message is showed:

WARNING: The config value `html_add_permalinks' has type `bool', defaults to `str'.

The documentation from http://www.sphinx-doc.org/es/stable/config.html
said to set it to None or the empty string to disable permalinks.

Now it is set to empty string and the warning disappear.
2017-05-30 11:14:52 -05:00
Rodrigo Caballero 366dc83e69 Merge branch 'micro-links' into 'master'
Links to Microsoft's documents

See merge request !166
2017-05-16 07:10:03 -07:00
Rodrigo Caballero 45a50907ef Add links to the Microsoft partner documents.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-05-16 09:14:24 -05:00
Rodrigo Caballero 13c4b36637 Merge branch 'typofix' into 'master'
Typofix

See merge request !165
2017-05-02 08:23:37 -07:00
Tim Pepper 9840e9feb4 typo fix: .xom -> .com
Docker doc link is broken.  Is this a test escape?

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2017-04-28 15:21:25 -07:00
Rodrigo Caballero c2e3f6915e Merge branch 'openssh-update' into 'master'
Openssh update

Updates the content based on the introduction provided by @ahkok.
Edits the text for clarity, grammar, and consistency.

See merge request !163
2017-04-28 10:32:03 -07:00
Rodrigo Caballero a1be4d37f1 Merge branch 'os-core-update' into 'master'
Os core update

Updates the content with a new introduction provided by @ahkok.
Edits the text for clarity, grammar, and consistency.

See merge request !164
2017-04-28 10:30:10 -07:00
Rodrigo Caballero 6cabfa5bef Update the os-core document.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-28 12:27:20 -05:00
Rodrigo Caballero eb5f2b52a3 Update the openssh-server documentation.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-28 11:54:47 -05:00
Rodrigo Caballero 81160e6aec Merge branch 'total-restructure' into 'master'
Total restructure

This is a major overhaul of the entire documentation.
It introduces:
* One section per Clear technology.
* A new simplified navigation.
* Standard use of labels.
* Decentralized figures.
* A filename convention.
* Minimal content cleanup.

See merge request !162
2017-04-27 11:15:36 -07:00
Rodrigo Caballero f2cf589da4 Remove redundant headings from master file.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-27 13:17:40 -05:00
Rodrigo Caballero c713ad16f7 Remove empty indeces and search pages, master file cleanup.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-27 11:52:06 -05:00
Rodrigo Caballero d517b0fd91 Fix files not included warnings.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-27 10:55:56 -05:00
Rodrigo Caballero 5a2b933e54 Fix substitutions warning.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-27 09:34:35 -05:00
Rodrigo Caballero 94c9e0ad76 Fix unknown option warning.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-27 09:34:35 -05:00
Rodrigo Caballero 940c1c304b Merge branch 'total-restructure' into 'master'
Total restructure

This is a major overhaul of the entire documentation.
It introduces:
* One section per Clear technology.
* A new simplified navigation.
* Standard use of labels.
* Decentralized figures.
* A filename convention.
* Minimal content cleanup.

See merge request !162
2017-04-26 17:57:22 -07:00
Rodrigo Caballero 34a0b6050f Restructure all technical content.
This restructure organizes the content into three sections, one per
technology. The content was left as untouched as possible, however
several directives needed to be standardized in order to implement the
new structure. All filenames follow use dashes-as-spaces and are written
using lower-case. Standard labels for files were implemented using the
filename as the label, thus, content can be cross-referenced without
having to open the file to see the label. Figures were moved to
decentralized folders to enable modularity. The scope of the restructure
as well as the dependencies between the changes required me to do it in
a single commit. Lastly, some cleanup had to be done for the
standardized structure to function properly.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-26 16:55:42 -05:00
Rodrigo Caballero a616b26072 Merge branch 'vmware-fix' into 'master'
Vmware fix

Fix VMWare documentation

See merge request !156
2017-04-25 10:16:57 -07:00
Miguel Bernal Marin 7bae6fc45d add one more step 2017-04-25 10:59:55 -05:00
Miguel Bernal Marin 24cdc80220 fix description 2017-04-25 10:55:35 -05:00
Rodrigo Caballero 9a02428183 Merge branch 'fix-ccv' into 'master'
Fix ccv

Fix the release version of Clear Containers.

See merge request !160
2017-04-24 10:09:15 -07:00
Rodrigo Caballero da13452b80 Merge branch 'bdlu' into 'master'
Bdlu

Updates the bundle table and the bundle commands.

See merge request !161
2017-04-24 10:03:28 -07:00
Rodrigo Caballero 3cc367bb59 Remove the optional bundles listing.
The optional bundles listing is redundant since we already included a
command for all bundles.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-24 12:01:36 -05:00
Rodrigo Caballero 79f63cfb97 Fix outdated Clear Containers release number.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-24 11:52:26 -05:00
Rodrigo Caballero dd3813cbab Update the bundles' commands and the bundles' table.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-24 09:44:13 -05:00
Rodrigo Caballero f3eb56f6cf Edit the language and markup for clarity and consistency.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-10 16:36:57 -05:00
Rodrigo Caballero a0b9ba2dc5 Merge branch 'fix-kt' into 'master'
Fix kt

As pointed out in a email:

I think this just got merged ... but, I would not write:
    "`Intel® Clear Containers`_ project on |CL|."

As Clear Containers, and it's use of this CL, is not bound to CL - it also runs on a number of other distros.
I'd probably just drop the CL reference:
   "`Intel® Clear Containers`_ project."

 Graham

See merge request !159
2017-04-10 13:55:25 -07:00
Miguel Bernal Marin 7b9677fa07 drop CL reference
As Clear Containers, and it's use of this CL, is not bound to CL - it
also runs on a number of other distros.
I'd probably just drop the CL reference:
   "`Intel® Clear Containers`_ project."

 Graham

Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
2017-04-10 15:50:16 -05:00
Rodrigo Caballero 23700f4dce Fix figure number in text.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-10 14:46:19 -05:00
Rodrigo Caballero 6400db0b7d Merge branch 'fix-CLEAR-2246' into 'master'
Fix clear 2246

Fixes the stream-server URL

See merge request !157
2017-04-10 08:23:58 -07:00
Rodrigo Caballero 3d84071e9d Merge branch 'bulk-provision' into 'master'
Bulk provision

Rebased with master and performed a force push per our discussion so we get a clean merge

See merge request !154
2017-04-10 08:18:41 -07:00
George T Kramer 3898d9fd9d Minor cleanup
Fixed some punctuation.  Only bolding ICIS or ISTER when referring to the standalone programs as proper nouns.  When used as adjectives to describe the kind of file being worked with, they are not bolded.
2017-04-07 16:57:43 -07:00
Miguel Bernal Marin b24c20902a fix VMWare 2017-04-07 18:05:44 -05:00
Miguel Bernal Marin 0ecec53d8b add reference in vbox section 2017-04-07 18:05:44 -05:00
Miguel Bernal Marin a2d80b384a fix stream-server URL 2017-04-07 18:04:57 -05:00
Rodrigo Caballero c04ae61adc Merge branch 'flatpak' into 'master'
Flatpak

Publish Flatpak basic tutorial

See merge request !158
2017-04-07 12:31:03 -07:00
Rodrigo Caballero 1bed20647a Renamed figure files to follow lower case convention.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-07 14:19:31 -05:00
Rodrigo Caballero 786c4d6315 Add flatpak tutorial to the tutorials index file.
Also fixes a minor typo causing a link not to render properly.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-07 14:13:50 -05:00
Rodrigo Caballero 0de490901e Add flatpak tutorial to the documentation.
The tutorial explains how to add applications to Clear Linux using
flatpak.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-07 14:08:19 -05:00
Rodrigo Caballero af23d02245 Merge branch 'kernel-types' into 'master'
Kernel types

Please do not merge until feed back from all the CLR is done.

See merge request !152
2017-04-07 11:37:17 -07:00
Rodrigo Caballero 95cdb03ff2 Edit language and markup for clarity and consistency.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-07 11:15:33 -05:00
Rodrigo Caballero 8d8581da08 Merge branch 'pxe-v2' into 'master'
Pxe v2

Iterating on documentation updates for network booting as ICIS code changes

See merge request !153
2017-04-06 15:08:45 -07:00
Rodrigo Caballero 4eaba1af30 Merge branch 'valid-sigs' into 'master'
Validating Signatures

Updating to make the section for image content validation more clear.  Updating to reflect changes in swupd signature validation.

See merge request !155
2017-04-06 10:19:05 -07:00
Rodrigo Caballero 6708de460d Replace a note with an important notice.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-06 12:24:47 -05:00
Rodrigo Caballero 8c19466502 Edit language for clarity and fix other minor issues.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-06 11:34:47 -05:00
Rodrigo Caballero ef7cafca9e Change emphasis for bundles name to avoid CSS problems.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-06 11:18:15 -05:00
Rodrigo Caballero f644c9b962 Fixed missing articles and in-line link.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-06 11:14:51 -05:00
George T Kramer b96a823d51 Minor phrasing changes for clarity 2017-04-04 11:03:08 -07:00
Miguel Bernal Marin baaaae3f60 add kernel containers description 2017-04-03 16:04:18 -05:00
Rodrigo Caballero 52c84f7a22 Edit the grammar, spelling, and markup of validation signatures.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-31 14:05:55 -06:00
George T Kramer 3fb86f772c Clarifying kernel parameter addition to iPXE boot script 2017-03-31 10:37:23 -07:00
George T Kramer 22668669dd Clarifying steps for creating cloud-init files 2017-03-31 10:28:55 -07:00
George T Kramer 688035926d Removing trailing whitespace 2017-03-31 10:28:55 -07:00
George T Kramer 05946bd785 Adding port numbers to URLs that need verification 2017-03-31 10:28:55 -07:00
George T Kramer 2407b2e173 Adding forgotten critical step 2017-03-31 10:28:55 -07:00
George T Kramer 2d3d79d70e Outline the steps to get started with ICIS in detail 2017-03-31 10:28:55 -07:00
George T Kramer 14c59c8a11 First pass at cleanup 2017-03-31 10:28:55 -07:00
George T Kramer 883dd75e91 Making documentation consistent 2017-03-31 10:28:55 -07:00
George T Kramer 77cab7fdfb Using the same numbering scheme as other documents 2017-03-31 10:28:55 -07:00
George T Kramer b2b8a8a9ff Updating figure and documentation to be more step-wise 2017-03-31 10:28:55 -07:00
George T Kramer f10c3e6fe4 Clarifying note for nginx configuration 2017-03-31 10:09:40 -07:00
George T Kramer 2100955eab Removing trailing whitespace 2017-03-31 10:09:40 -07:00
George T Kramer 1fda173353 Updating documentation to latest revision of ICIS code 2017-03-31 10:09:40 -07:00
George T Kramer 4232a17a03 Moving figures to be consistent with those in bulk provisioning 2017-03-31 10:09:40 -07:00
Rodrigo Caballero e51c49640b Fix machine learning offering description.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-29 16:34:47 -06:00
Rodrigo Caballero fcdf7d7c5a Edit grammar, spelling, sentence structure, tone, style, and trademarks.
Performed an edit ensuring parallel content structures, a consistent
tone and style, good grammar and spelling, and trademark
references only on the first instance. Added the name of the bundle at
the begining of each paragraph in the exact form users need to put in
the commands, thus providing a better user experience. Lastly, I fixed
capitalization issues with the links. Although the GitHub repos are
named in lower case, that does not mean the links' text  should be in
lower case too.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-23 17:17:48 -06:00
Miguel Bernal Marin b386a59d64 fix KVM explanation and Hyper-V 2017-03-23 15:33:28 -06:00
Miguel Bernal Marin 5de438e389 CLR kernels: add supported HW to VMs 2017-03-23 15:15:27 -06:00
Rodrigo Caballero 81c538b9f0 Merge branch 'ciao' into 'master'
Ciao

See merge request !149
2017-03-23 13:59:34 -07:00
Rodrigo Caballero e0b7e5384a Merge branch 'gwhaley-cc-bdl-minimum' into 'master'
Simplify the container-bundle page

The bundle description page had too much specific tech details, and needs to be more of an overview and jumping off point. Simplify and improve.

See merge request !148
2017-03-23 13:27:01 -07:00
Rodrigo Caballero be478316a6 Fix capitalization of GitHub.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-23 14:32:50 -06:00
Rodrigo Caballero b7b732e6e9 Introduce a proxy section to reference the instructions.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-23 14:27:59 -06:00
George T Kramer a86fc32f22 Showing users precicely how swupd validates signatures 2017-03-22 17:49:43 -07:00
George T Kramer 3e0dc35cac Revising to be more clear 2017-03-22 17:03:19 -07:00
Miguel Bernal Marin d10af2b7cc add clr kernels to index 2017-03-21 13:30:24 -06:00
Miguel Bernal Marin 345ba4a58c adding clear linux kernel types description 2017-03-21 13:29:40 -06:00
Alberto Murillo Silva 95a1433f77 ciao-deploy: Install python-keystoneclient
python-keystoneclient package used to live in the now deprecated
openstack-python-clients bundle and needs to be installed with pip

Signed-off-by: Alberto Murillo Silva <alberto.murillo.silva@intel.com>
2017-03-17 18:17:58 -06:00
Rodrigo Caballero d31c34ef0e Edit grammar, style, and markup.
Removed the overly familiar style, fixed some minor grammar issues, and
added the appropriate markup where needed.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-16 16:41:29 -06:00
Alberto Murillo Silva ba197de900 ciao: Deprecate the use of ciao-deploy container
Signed-off-by: Alberto Murillo Silva <alberto.murillo.silva@intel.com>
2017-03-16 15:33:31 -06:00
Rodrigo Caballero 567d5e1a27 Merge branch 'more_ciao_cli_fixing' into 'master'
More ciao cli fixing

See merge request !150
2017-03-16 14:21:03 -07:00
Rodrigo Caballero b478e3aea1 Edit for grammar, clarity, and markup.
Additionally, a note was added with a reference to the Docker proxy
documentation to keep that content available.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-15 15:34:43 -06:00
Tim Pepper 743d5a3d3e ciao: yet another many months out of date command line invocation
I would swear I searched for and fixed these all before, but clearly
this delete command is broken and should have been fixed in the past.
Any invocation that is, eg:

ciao-cli -something

is a sign of a broken command, as all commands now start with, eg:

ciao-cli something

Later option arguments may include a dash, but none of the top level
commands/subcommands do.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2017-03-15 11:18:01 -07:00
Rodrigo Caballero 617a38cd5d Merge branch 'pxe' into 'master'
Network Boot

Updating network boot documentation to include tested and verified configurations on the latest version of Clear.

See merge request !147
2017-03-14 13:14:54 -07:00
Rodrigo Caballero adc976db81 Edit language and markup.
Edited the language to increase readability and clarity.
Implemented the available substitutions and added markup for files and
abbreviations.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-03-14 10:02:43 -06:00
George T Kramer 065c8b0f3d Making documentation consistent 2017-03-13 11:25:59 -07:00
George T Kramer d8f3676ec5 Using the same numbering scheme as other documents 2017-03-10 17:28:51 -08:00
George T Kramer 8bff266264 Adding information flow diagram for PXE booting 2017-03-10 17:01:13 -08:00
George T Kramer 11c30ce07e Updating figures and links 2017-03-10 15:56:46 -08:00
George T Kramer 52fcf25dca Point users to the correct configuration script 2017-03-09 11:41:44 -08:00
George T Kramer f897ee2a5f Continuing network boot documentation updates
Removing untested network boot configurations.  Breaking down large steps to be more granular.  Ensuring greater language consistency.
2017-03-09 11:20:37 -08:00
George T Kramer a43d72d802 Focusing network booting article on NAT
Some of the instructions provided code that was not clear or did not work on the latest version of Clear Linux.  The documentation is being updated to close these gaps.
2017-03-08 15:02:26 -08:00
Tullis, Michael L 2f8a967ea9 Minor corrections to merge #146. 2017-03-01 12:01:03 -08:00
Tullis, Michael L 170e514be8 Merge branch 'vbox-more-images' into 'master'
Several fixes in vbox and others

* Add one more image to VirtualBox documentation
* Fix images indentation
* Use CL and CLOSIA
* Add a sentence to al VM files to enable VT-x and VT-d.

See merge request !146
2017-03-01 11:43:24 -08:00
Tullis, Michael L 8521d27cfc Fixed layout and minor language issues in mixer.rst 2017-03-01 11:39:48 -08:00
Tullis, Michael L 2daf1e714f Merge branch 'mixer' into 'master'
Mixer

See merge request !145
2017-03-01 09:34:02 -08:00
Miguel Bernal Marin 9d5c275fda fix UEFI firmware word 2017-03-01 11:15:25 -06:00
Miguel Bernal Marin 348c991426 all vm files: Add VT-x sentence 2017-03-01 11:01:03 -06:00
Miguel Bernal Marin e3a06bbae9 virtualbox: switch to abbrev version 2017-03-01 10:37:50 -06:00
Miguel Bernal Marin eed2c1928a virtualbox: add images and fix images indentation
Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
2017-03-01 10:29:33 -06:00
Graham Whaley afdc0162a7 bundles/cc: Simplify the Clear Container bundle page
The CC bundle page had far too much technical detail, and not enough
overview. Simplify the page by removing the tech info and adding some
overview.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2017-02-28 11:53:23 +00:00
Tullis, Michael L 587e6f2eab Fixed markup to remove spurious hyperlink 2017-02-27 15:07:48 -08:00
Tullis, Michael L ab3fda595b Minor punctuation and grammar changes to clear_linux_os_on_azure.rst 2017-02-27 10:41:08 -08:00
Tullis, Michael L 4d4c7daa7c Merge branch 'azure-doc-update' into 'master'
Azure doc update

Update the Azure Docs with some examples related to Azure Command Line Interface.

See merge request !144
2017-02-27 10:28:20 -08:00
Tullis, Michael L b4ef34cea5 Minor punctuation correction in ac-dpdk.rst after latest commit 2017-02-27 10:22:55 -08:00
Tullis, Michael L 5b71c21854 Merge branch 'dpdk-l3' into 'master'
Dpdk l3

See merge request !143
2017-02-27 10:13:07 -08:00
Tullis, Michael L bd4612d6a3 Merge branch 'fix-virtualbox' into 'master'
Fix virtualbox

Add some pictures and update documentation.

See merge request !142
2017-02-27 09:28:14 -08:00
Tullis, Michael L 2ed9d99e3a Various language and formatting fixes in vm-virtualbox.rst 2017-02-27 09:24:52 -08:00
Robert Nesius 4b4223522d Azure docs updated with examples 2017-02-25 04:50:02 +00:00
Mario Alfredo Carrillo Arevalo 0ee4db96a1 Update doc about l3-dpdk use case
Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.com>
2017-02-24 18:07:57 -06:00
Rodrigo Caballero 38fcc5b3ba Minor corrections and removal of unused links.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-02-24 16:15:22 -06:00
Rodrigo Caballero 02c0eb6d7b Merge branch 'vm-hyper-v' into 'master'
Vm hyper v

Old outdated instructions replaced with much easier to follow instructions.

See merge request !141
2017-02-24 13:22:47 -08:00
Rodrigo Caballero a0cef16c2b Edit and improve markup and language.
Improved the markup to ensure the steps were properly numbered and the
content rendered as intended.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-02-24 15:04:47 -06:00
Rodrigo Caballero 895bf69621 Merge branch 'vm-hyper-v' of clrgitlab.intel.com:clr-documentation/project-docs into vm-hyper-v 2017-02-24 13:48:29 -06:00
Miguel Bernal Marin 5b81c6571a vm-virtualbox: Add images to documentation
Add some images to document and update some instructions

Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
2017-02-24 13:29:38 -06:00
Rodrigo Caballero 9dede39a6a Merge branch 'swupd' into 'master'
Swupd

See merge request !139
2017-02-22 12:07:46 -08:00
Tudor Marcu 2d8ce53b0a Update swupd-about
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2017-02-22 11:20:48 -08:00
Rodrigo Caballero d047612b8e Merge branch 'updater' into 'master'
Updater

See merge request !140
2017-02-22 07:23:01 -08:00
Rodrigo Caballero c6084245c9 Merge branch 'dpdk' into 'master'
Update info about virtual bridges tools

See merge request !134
2017-02-22 07:18:44 -08:00
Robert Nesius 4602a4e03c Updated HyperV docs 2017-02-21 18:43:54 -08:00
Tudor Marcu 05c611ee19 Update mixer docs for new tool 2017-02-21 18:41:31 -08:00
Tudor Marcu cd8c549646 Update updater docs
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2017-02-21 14:12:29 -08:00
Mario Alfredo Carrillo Arevalo 0bcd6d8afe Update and improve steps about virtual bridges
This update includes some info about the bundles have
been deprecated, info about tools for virtual bridges
and replace new steps in use cases.

Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.com>
2017-02-21 16:05:36 -06:00
Rodrigo Caballero 0be50671fb Merge branch 'sorttable-js' into 'master'
Sorttable js

remove console log and addClass

See merge request !138
2017-02-16 09:05:41 -08:00
Eli JacobX Ramirez Cervantes 58145324a8 sorttable-js solved sorttable issue 2017-02-16 11:01:14 -06:00
Rodrigo Caballero 35b55d494c Merge branch 'sorttable-js' into 'master'
Sorttable js

remove console log and addClass

See merge request !138
2017-02-15 15:59:20 -08:00
Eli JacobX Ramirez Cervantes a86b860f1c sortable class was added to the tables 2017-02-15 17:51:26 -06:00
Rodrigo Caballero 7e92c41278 Merge branch 'sorttable-js' into 'master'
Sorttable js

remove console log and addClass

See merge request !138
2017-02-15 15:26:19 -08:00
Eli JacobX Ramirez Cervantes 15c1992a18 remove addClass and console log 2017-02-15 17:17:09 -06:00
Rodrigo Caballero f93db6e235 Merge branch 'b-table' into 'master'
B table

Update bundles' overview table.

See merge request !137
2017-02-15 12:07:05 -08:00
Rodrigo Caballero 54a8c59f1e Update bundles' overview table. 15/Feb/17
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-02-15 14:07:25 -06:00
Rodrigo Caballero 288520f305 Merge branch 'sorttable' into 'master'
Sorttable

add sorttable js

See merge request !133
2017-02-15 06:39:02 -08:00
Eli JacobX Ramirez Cervantes 7d694618bb add sorttable js 2017-02-14 17:09:29 -06:00
Rodrigo Caballero 9dcb6ea477 Merge branch 'thead' into 'master'
Thead

Adds the thead and tbody HTML markup needed to implement JS to make the table sortable.

See merge request !132
2017-02-14 14:21:10 -08:00
Rodrigo Caballero ec7c2af24c Add thead and tbody to implement sortable table.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-02-14 16:21:45 -06:00
Rodrigo Caballero 0ec3e6bea7 Merge branch 'word-break' into 'master'
Word break

https://clearlinux.org/documentation/bdl-openssh-server.html it appears that text with pre tag is not resizing to fit the responsiveness

See merge request !131
2017-02-13 12:48:45 -08:00
Eli JacobX Ramirez Cervantes 9dc3cb036c word-break, text with pre tag is not resizing to fit the responsiveness 2017-02-13 14:33:20 -06:00
Rodrigo Caballero d86d446306 Merge branch 'mobile-menu' into 'master'
Mobile menu

Hi Rodrigo this issues has been solved.

- Documentation menu is missing, the bar appears on the footer, but it has no interaction

See merge request !130
2017-02-02 10:26:35 -08:00
Eli JacobX Ramirez Cervantes a7948f0e50 Conflicts were resolved 2017-02-02 12:14:43 -06:00
Eli JacobX Ramirez Cervantes d81f995941 Fix mobile menu 2017-02-02 12:12:19 -06:00
Rodrigo Caballero 91e44c1cc5 Merge branch 'responsive-issues' into 'master'
Responsive issues

Hi Michael! these are the the solved items

- solved responsive design tables.
- Solved breadcrumb mobile.
- Added margin bottom to "main-content" class, in order to solve overlapping with footer.
- Added a scroll to the class "highlight-console", to improve the view in mobile

See merge request !129
2017-02-02 08:04:41 -08:00
Eli JacobX Ramirez Cervantes 44f3841a13 fix responsive for documentation section 2017-01-31 15:51:44 -06:00
Tullis, Michael L 9d10e6414b Per direction from Tom, removed broken link for example version 4.6.4. 2017-01-26 11:43:32 -08:00
Rodrigo Caballero 95f7c81076 Merge branch 'wp-tut' into 'master'
Wp tut

Publication of the WordPress use-case tutorial.

See merge request !128
2017-01-25 12:34:30 -08:00
Rodrigo Caballero 5a54cfc160 Merge branch 'ciao-docu-fix' into 'master'
Ciao docu fix

A few small documentation fixes thanks to a bug report from Brett Warden.

See merge request !127
2017-01-24 14:13:01 -08:00
Rodrigo Caballero 3d8421d4c0 Apply feedback provided by reviewers.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-24 14:50:51 -06:00
Rodrigo Caballero 11eddd8aa6 Add WordPress tutorial to the tutorial's index.
Adds the WordPress tutorial to the index-ts.rst file.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-24 14:40:39 -06:00
Rodrigo Caballero 98a1855706 Add the WordPress installation tutorial.
The WordPress installation provides clear instructions to install
WordPress on top of a LAMP web server running Clear Linux. It requires
the completion of both the bare metal installation and the web server
installation tutorials before starting it.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-24 14:40:39 -06:00
Rodrigo Caballero 8b55b9f522 Add the web server installation tutorial.
The tutorial provides clear instructions to install a LAMP server using
Clear Linux. LAMP servers are needed for various use cases. The tutorial
can be used for multiple use case tutorials.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-24 14:40:39 -06:00
Rodrigo Caballero 958dbc585e Add the bare metal installation tutorial.
The bare metal installation tutorial provides detailed instructions to
install Clear Linux on a bare metal system. This is the first step for
several different use cases and it was written with reusability in mind.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-24 14:40:39 -06:00
Rodrigo Caballero b60a69bd52 Add the WordPress tutorial overview.
The overview file contains the toctree directive to the three parts.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-24 14:40:39 -06:00
Rodrigo Caballero ebb09566a8 Update the supported hardware text to be more generic.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-24 14:37:45 -06:00
Rodrigo Caballero 69a8af6e2c Update text to reflect the supported hardware list.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-23 18:03:46 -06:00
Rodrigo Caballero d1196d4b29 Update the supported hardware list.
Updates the supported hardware list ensuring compliance with the proper
usage guidelines.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-23 12:56:10 -06:00
Tim Pepper 6ce85c2bea ciao: move cluster/node status commands to new cli
Quite some time back the cli invocation for cluster status was changed,
but the documentation was not.  This brings docu back in line with
current behavior.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2017-01-20 15:45:34 -08:00
Tim Pepper 9cb8d1ad3e ciao: remove stale bug reference
Some warnings around ordering of node/daemon startup are no longer
needed as Ciao has enabled connect/disconnect notifications and
cluster formation is more robust nowadays.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2017-01-20 15:33:12 -08:00
Rodrigo Caballero 8909424d68 Merge branch 'mesiment-ciao-cluster-setup' into 'master'
update links for the ciao-deploy page

This pachset updates some broken links in the [ciao-deploy](https://clearlinux.org/documentation/ciao-deploy.html) page in clearlinux.org.

basically 2 changes:
* update broken links from clear-config-management to ciao repo
* remove unused github link

See merge request !126
2017-01-18 12:51:06 -08:00
Simental Magana, Marcos a89cef7f40 remove unused github link
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2017-01-18 13:44:05 -06:00
Simental Magana, Marcos b0a90e5457 update links from clear-config-management to ciao repo
The `hosts` and `group_vars/all` file links points to the
deprecated ciao content in the clear-config-management on
github instead of the new ciao repository, where the content
was moved to.

This commit changes the broken links to the new location in the
github.com/01org/ciao repository

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2017-01-18 13:41:23 -06:00
Rodrigo Caballero 91a042f64b Adds substitutions pertinent to this project.
Replaces the placeholder substitutions with the correct Clear Linux
substitutions.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-01-17 11:43:01 -06:00
Rodrigo Caballero 684c6499f1 Merge branch 'dpdk' into 'master'
Dpdk

See merge request !125
2017-01-12 14:16:38 -08:00
Mario Alfredo Carrillo Arevalo eba49deb27 Update Openvswitch & DPDK use case steps
These steps were updated according to new features
added in OVS 6.1 and DPDK 16.07.

Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.com>
2017-01-12 14:44:40 -06:00
Rodrigo Caballero 66b4163136 Fix typo on diagrams.
Fixes accross to across on both DAX diagrams.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-12-06 09:16:01 -06:00
Rodrigo Caballero 41cdf6ab0d Revert "Merge branch 'new-file-struct' into 'master'"
This reverts commit 4d707bc539, reversing
changes made to b18458758e.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-11-22 10:56:24 -06:00
Rodrigo Caballero 4d707bc539 Merge branch 'new-file-struct' into 'master'
New file struct

This merge reorganizes the source rst files to make contributions and identifying gaps easier.

See merge request !123
2016-11-18 11:42:14 -08:00
Rodrigo Caballero a4b61aecf9 Modify file structure of docs source files.
Changed the file structure to allow for easier and better maintenance of
the docs. Files were renamed as needed and following a consistent
convention. Added a index.rst to every folder allowing for partial
builds of the docs. Included content previously left out of the docs
build. The commit also performs minimal housekeeping.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-11-18 13:36:22 -06:00
Rodrigo Caballero b18458758e Merge branch 'auto-update' into 'master'
Auto update

Add details on Clear Linux auto update and how to disable/reenable it.

See merge request !122
2016-11-17 11:36:28 -08:00
William Douglas b2f80a72d5 Add documentation for auto-update
Clear Linux now enables software updates run automatically by
default. This change notifies users of this behavior as well as how to
disable and reenable it.
2016-11-16 20:59:41 +00:00
Rodrigo Caballero b782c27e57 Merge branch 'mixer' into 'master'
Mixer

See merge request !119
2016-11-16 06:48:03 -08:00
Rodrigo Caballero f3bc348adf Merge branch 'mesiment-ciao-cluster-setup' into 'master'
update ciao deploy with new location of ansible playbooks

This PR changes the documentation to reflect the adoption of the ansible playbooks into the [ciao repo](https://github.com/01org/ciao/)

See merge request !120
2016-11-14 10:15:41 -08:00
Simental Magana, Marcos bad08e4592 ciao-deploy: use the .. note:: rst directive
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-11-14 11:43:37 -06:00
Simental Magana, Marcos 6fd986755d ciao-deploy: use ciao provided ansible playbooks
Since the ciao examples to deploy were moved
from https://github.com/clearlinux/clear-config-management
to https://github.com/01org/ciao/, the instructions
should tell the user to use the ciao ones instead of
deprecated clear-config-management.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-11-11 14:20:31 -06:00
Tudor Marcu b3fb1bda73 mixer feedback changes
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2016-11-09 15:13:05 -08:00
Tullis, Michael L 35bd6c2fe2 Merge branch 'ciao_cli_fixes' into 'master'
Ciao cli fixes

Minor fixups: most of these got changed (months?!) ago, but a few appear to have persisted.

See merge request !118
2016-11-07 16:55:00 -08:00
Tim Pepper 90ea6a221f ciao: update some cli invocations
Some parts of the Ciao cluster setup document still referenced really old
command line style which no longer works.  This commit updates the older
"ciao-cli -command" invocations to the newer "ciao-cli command" (ie: no
'-') style.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-11-07 12:25:11 -08:00
Tullis, Michael L 601d20b2e2 clear_linux_os_on_azure.rst: Updated branding to third-party for Azure. 2016-11-04 17:11:52 -07:00
Tullis, Michael L cabead95d0 Merge branch 'azure-perf' into 'master'
Azure perf

Performance claim disclaimer and better trademark disclaimers.

See merge request !117
2016-11-04 16:58:35 -07:00
Robert Nesius 6100dcd49f Performance claim disclaimer 2016-11-04 16:50:19 -07:00
Tullis, Michael L fabf731552 ciao-deploy.rst: After merge, fixed a few minor language and branding issues. 2016-11-03 15:49:03 -07:00
Tullis, Michael L bb98c15f46 Merge branch 'mesiment-ciao-cluster-setup' into 'master'
update ciao-deploy page with new container instructions

This merge request updates the instructions on the ciao-deploy page, asking the user to download the ansible playbooks to keep them persistent

See merge request !116
2016-11-03 15:36:35 -07:00
Simental Magana, Marcos 30b522facd ciao-deploy: update instructions with new container
the new ciao-deploy container mounts the ansible
files from the docker host instead of those being provided
by the container. This allows the user to keep a persistent
configuration files, useful when deploy takes place more than once.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-11-03 13:46:16 -06:00
Tullis, Michael L c22d4839cc Fixed branding and language issues. Will open an issue on legal considerations for performance claim. 2016-11-02 17:17:32 -07:00
Tullis, Michael L be1ee9c3fd Merge branch 'azure' into 'master'
Azure

First commit for Azure docs. Will add more details once we are public, like the azure command line invocations.

See merge request !115
2016-11-02 16:57:31 -07:00
Robert Nesius 35315b8316 Azure docs - first draft 2016-11-02 00:48:27 -07:00
Tullis, Michael L 528e17ee4c Manually merging Tudor's commit ffae1753 for updates to mixer.rst, then closing merge request 113. 2016-10-31 13:46:34 -07:00
Tullis, Michael L b80be7a175 Merge branch 'remove-bundle-overview-image' into 'master'
Remove bundle overview image

The bundle image references both bundles that no longer exist and a layout of bundles that is not used. For now, simply remove the stale image.

See merge request !114
2016-10-31 12:38:53 -07:00
Tullis, Michael L 71f8a2ba1b Merge branch 'mixer-new-tools' into 'master'
Mixer new tools

See merge request !113
2016-10-31 12:34:06 -07:00
William Douglas 272b6b11e7 Remove out of date bundle overview image
The bundle image references both bundles that no longer exist and a
layout of bundles that is not used. For now, simply remove the stale
image.
2016-10-31 19:16:21 +00:00
Tudor Marcu ffae175390 Update mixer to represent new tool rewrite
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2016-10-28 16:05:23 -07:00
Leona e57687e515 Merge branch 'fix-vbox-which' into 'master'
Fix vbox which

This commit fixes the missing documentation from virtualbox guest additions.

this was reported by external user.

See merge request !111
2016-10-14 09:52:14 -07:00
Leona 737d04b864 Merge branch 'bundle-doc' into 'master'
Bundle doc

This commit adds a bundle base configuration documentation.

Now we can add specific configuration based on bundles.

See merge request !110
2016-10-13 15:23:24 -07:00
Miguel Bernal Marin 242e98d8aa vm-virtualbox: add missing step to install additions 2016-10-13 15:40:50 -05:00
Miguel Bernal Marin 8e1b1cad18 add documentation files to the index 2016-10-13 15:23:55 -05:00
Miguel Bernal Marin 8e51e5edbf add bundle base configuration documentation 2016-10-13 15:23:13 -05:00
Leona 78cd59b4f2 clarify what the various bundle list commands do or show. add date for relevancy 2016-10-12 11:11:56 -07:00
Leona 2c916e9a8b fix start gui command 2016-10-12 11:02:28 -07:00
L.S. Cook b50465280b fix whitespace on ceph-deploy
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-10-11 08:29:08 -07:00
Leona 12389c4361 edit for spelling, grammar, rst syntax
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-10 11:32:00 -07:00
Leona 5c9edab9bd update bundles table status info as of release 10900
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-10 08:31:54 -07:00
Leona 3ab90f5f4f Merge branch 'mesiment-ciao-cluster-setup' into 'master'
update ciao cluster setup

This change introduces the usage of ciao-deploy container, which contains all the setup
previously done by the user. Now it's only required that the user pulls the `clearlinux/ciao-deploy` container
and start it as described in the instructions.

See merge request !109
2016-10-10 07:51:17 -07:00
Simental Magana, Marcos 3217fdb8ad specify to move to /root/ in container 2016-10-07 17:30:26 -05:00
Simental Magana, Marcos 7e09747727 reword the ansible ssh requirement for the deployment. 2016-10-07 16:35:02 -05:00
Simental Magana, Marcos 6c955aef33 replace deployment section with deployment-container
Instead of doing a lot of instructions to setup
a deployment machine, we just ask the user to pull
and use a container already setup with all the needed
tools.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-10-07 15:16:23 -05:00
Leona 86af3ff844 fix spacing issue on README
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-05 11:51:04 -07:00
Leona de7d9cbec4 fix spacing issue on README
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-05 11:49:36 -07:00
Leona fa6fe5cb24 edit ceph deploy for rst syntax and minor grammar fixes
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-05 08:31:25 -07:00
Leona bf7eb959dc update bundles table with new refactored bundles and minor styles change to table rendering
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-05 08:07:17 -07:00
Leona d2caf13b60 Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-10-05 07:15:29 -07:00
Leona 9847b3d4ac remove extra character on line 29 to close issue #14 2016-10-05 07:14:52 -07:00
Leona c4cc76c471 Merge branch 'mixer-cert' into 'master'
Mixer cert

See merge request !108
2016-10-04 11:11:38 -07:00
Tudor Marcu 9decb9d9cf Fix cert location
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2016-10-03 16:06:11 -07:00
Leona 7781b64552 Fix typos and grammar edit on vm-virtualbox
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-03 11:33:39 -07:00
Leona c4049ed744 update link on README 2016-10-03 08:53:44 -07:00
Leona 6cdff123b4 update README 2016-10-03 08:52:24 -07:00
Leona 49f1640059 release 10780 bundles table update 2016-10-03 07:30:43 -07:00
Leona 8c5eb4e5e3 Merge branch 'update_supported_hw' into 'master'
reword supported hardware section.

Start by specify supported hardware and provide help to determinate
if user's system is available to run clearlinux in a later
paragraph.

See merge request !107
2016-09-29 11:40:29 -07:00
Simental Magana, Marcos c5123f7a5d reword supported hardware section.
Start by specify supported hardware and provide help to determinate
if user's system is available to run clearlinux in a later
paragraph.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-09-29 12:02:34 -05:00
L.S. Cook dfb4f1393d update Supported Hardware page
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-09-29 09:32:01 -07:00
Leona a1e605ea9c updating bundles table with current status on bundles_overview page 2016-09-28 07:37:09 -07:00
Leona 0d9fbc8de9 Merge branch 'mesiment-ciao-cluster-setup' into 'master'
update ciao-deploy bundle requirements

Change `os-core-dev` for `c-basic` as we only need gcc.

Change `os-common` for `openstack-common` as the 1st bundle doesn't exists and it really meant the 2nd one.

Please wait for review from @albertom to merge.

See merge request !106
2016-09-26 14:11:39 -07:00
Simental Magana, Marcos 5017472075 ciao-deploy: use the correct bundles.
The `os-common` bundle doesn't exists (should be `openstack-common`
instead) and we can use the `c-basic` instead of `os-core-dev`
as it's smaller.

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-09-26 15:59:04 -05:00
Leona e22ea10b74 Merge branch 'mixer-docs' into 'master'
Mixer docs

Update mixer documentation.

See merge request !105
2016-09-26 13:11:08 -07:00
Tudor Marcu b88c271295 Update mixer documentation
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2016-09-26 12:57:01 -07:00
Leona bc8c14c580 Merge branch 'icis_url' into 'master'
Appended /icis/ to bulk_provisioning URLs

Two of the URLs in source/bulk_provisioning.rst pointed to the wrong
URL on the PXE / ICIS server. They now point to the icis subdirectory
where the uwsgi app is running.

Signed-off-by: John Andersen <john.s.andersen@intel.com>

See merge request !103
2016-09-26 11:32:09 -07:00
John Andersen 6251282b4d Appended /icis/ to bulk_provisioning URLs
Two of the URLs in source/bulk_provisioning.rst pointed to the wrong
URL on the PXE / ICIS server. They now point to the icis subdirectory
where the uwsgi app is running.

Signed-off-by: John Andersen <john.s.andersen@intel.com>
2016-09-26 10:06:12 -07:00
Leona 8cd997c531 edit changes on network_boot file
Signed-off-by: Leona <leonax.cook@intel.com>
2016-09-26 09:07:21 -07:00
Leona 5e77d7779a edit changes on network_boot file for syntax, grammar, clarity
Signed-off-by: Leona <leonax.cook@intel.com>
2016-09-26 08:32:35 -07:00
Leona 13395ea9d8 Merge branch 'network_boot_NAT' into 'master'
Instructions for NATing cluster on network boot

The description of how to construct your network was missing from the
network_boot documentation. This adds instructions on how to
configure the cluster so that the PXE / DHCP server allows traffic
to flow from internal to external networks and vice versa. Without
this the documentation is incomplete as it assumes the user knows how
to set up some kind of networking. By providing this information the
user is able to get a fully functioning cluster up an running biased
solely on this document.

Signed-off-by: John Andersen <john.s.andersen@intel.com>

See merge request !102
2016-09-26 07:50:12 -07:00
John Andersen 06a381d44f Instructions for NATing cluster on network boot
The description of how to construct your network was missing from the
network_boot documentation. This adds instructions on how to
configure the cluster so that the PXE / DHCP server allows traffic
to flow from internal to external networks and vice versa. Without
this the documentation is incomplete as it assumes the user knows how
to set up some kind of networking. By providing this information the
user is able to get a fully functioning cluster up an running biased
solely on this document.

Signed-off-by: John Andersen <john.s.andersen@intel.com>
2016-09-23 15:24:41 -07:00
Leona 8a62d93743 Merge branch 'ciao_deploy_typo_node' into 'master'
Ciao deploy typo node

there was a typo in the install section for the ciao-deploy page.
This Merge Request fixes the typo.

See merge request !101
2016-09-23 13:27:05 -07:00
Simental Magana, Marcos c7c47c6f80 fix typo 'development' -> 'deployment' on install section
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-09-23 15:19:04 -05:00
Leona fceef6671a Merge branch 'get_involved_dropdown' into 'master'
Get involved dropdown

Fixed dropdown slide for header menu

See merge request !100
2016-09-23 11:05:43 -07:00
Noelia Nunez 3a05efb10b Fixed Get Involved dropdown 2016-09-23 12:47:38 -05:00
Leona 750f649c71 Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-09-23 07:13:10 -07:00
Leona 81a50e9aa5 bundles status as of 10600
Signed-off-by: Leona <leonax.cook@intel.com>
2016-09-23 07:12:45 -07:00
Leona 0ef3fe99ad Merge branch 'network_boot' into 'master'
Network boot use latest version

Network boot documentation said to set version variable to
/usr/share/clear/version and then download
https://download.clearlinux.org/current/clear-${version}-pxe.tar.xz
however if /usr/share/clear/version does not match
https://download.clearlinux.org/latest then
clear-${version}-pxe.tar.xz ends up being an xml response saying
that the file was not found and the tar step fails.

This patch tells the user to set version to
https://download.clearlinux.org/latest so that the download from
/current/ succeeds.

Signed-off-by: John Andersen <john.s.andersen@intel.com>

See merge request !99
2016-09-22 15:23:56 -07:00
John Andersen 0bc8c9451c Network boot use latest version
Network boot documentation said to set version variable to
/usr/share/clear/version and then download
https://download.clearlinux.org/current/clear-${version}-pxe.tar.xz
however if /usr/share/clear/version does not match
https://download.clearlinux.org/latest then
clear-${version}-pxe.tar.xz ends up being an xml response saying
that the file was not found and the tar step fails.

This patch tells the user to set version to
https://download.clearlinux.org/latest so that the download from
/current/ succeeds.

Signed-off-by: John Andersen <john.s.andersen@intel.com>
2016-09-22 09:17:00 -07:00
L.S. Cook 93cb76681b fix whitespace and line length
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-09-21 10:16:42 -07:00
L.S. Cook d87ea7450f Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-09-21 09:30:16 -07:00
L.S. Cook cacb450589 adding CIAO deploy specifics for Ubuntu 2016-09-21 09:29:52 -07:00
Leona c6eaa124eb Merge branch 'mryan-ciao-cluster-setup' into 'master'
Mryan ciao cluster setup

Update the Go requirements to Go 1.7.  Ciao no longer builds with Go 1.6.

See merge request !98
2016-09-21 06:31:52 -07:00
Mark Ryan 366eded708 ciao-cluster-setup.rst: Update Go requirements.
Go 1.7 is now required to build ciao.

Signed-off-by: Mark Ryan <mark.d.ryan@intel.com>
2016-09-21 11:10:15 +01:00
Leona fa1efd71df Merge branch 'ciao' into 'master'
Ciao

See merge request !97
2016-09-20 11:01:51 -07:00
Alberto Murillo 2d24ee5e76 ciao-deploy.rst: Explain created files
The playbook creates some files when its executed.

The files are:
./certificates directory which contains the certificates used in the cluster
./images directory which contains the os images used in the cluster
./openrc file which contains environment variables to authenticate openstack cli
./ciaorc file which contains environment variables to authenticate ciao cli

Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
2016-09-20 12:35:14 -05:00
Alberto Murillo c2147039bb ciao-deploy.rst: Update passwords
Update passwords shown un ciao-deploy to match those in
https://github.com/clearlinux/clear-config-management/tree/master/examples/ciao

Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
2016-09-20 12:13:17 -05:00
Leona ceb9476476 run bundles status script for 10490
Signed-off-by: Leona <leonax.cook@intel.com>
2016-09-19 11:50:43 -07:00
Leona fa8679c6c1 fix typos on getting started and clear containers pages
Signed-off-by: Leona <leonax.cook@intel.com>
2016-09-19 10:43:41 -07:00
Leona 0792b600f0 updating bundles details as of Sept 14
Signed-off-by: Leona <leonax.cook@intel.com>
2016-09-14 11:28:02 -07:00
L.S. Cook b17b0191f7 fix doc bug on vm-kvm.rst - port 10022 in start_qemu.sh
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-09-13 15:02:26 -07:00
Leona 666007052f Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-09-07 10:48:31 -07:00
Leona 7164746293 Update table on bundles-overview
The bundles table has updated with current
status of Active / WIP / Deprecated bundles
as of release 10320.

Signed-off-by: Leona <leonax.cook@intel.com>
2016-09-07 10:47:16 -07:00
Leona 2c476ffe43 Merge branch 'ciao' into 'master'
More updates to ciao deployment documentation

See merge request !96
2016-09-07 10:33:44 -07:00
Alberto Murillo ba731a8fab ciao-deploy.rst: More updates to documentation
- The Prerequisite section no longer explains how to
  create an ssh-key. Remove a reference to it.

- Specify defaults/main.yml file on each role contains
  a full list of available variables that can be used.

- "Start" the deployment rather than "fire" it

- Specify the location of ciaorc file

Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
2016-09-07 10:20:59 -05:00
L.S. Cook 08b0c2bc80 grammar edits 2016-09-06 16:00:15 -07:00
L.S. Cook 7a7fae1a4a removing out of date reference to April 2016 download images 2016-09-06 12:56:06 -07:00
Tullis, Michael L 726d75b8bd Language and formatting corrections to merge request 95. 2016-09-06 09:59:36 -07:00
Tullis, Michael L 03a5d5d0c0 Merge branch 'ciao' into 'master'
Update Ciao documentation

This MR updates the ciao documentation
Please do not merge until the team has finished with the review.

See merge request !95
2016-09-06 09:45:54 -07:00
Alberto Murillo 28bcac1d1a ciao-deploy.rst: Update ciao instructions
Update how the ciao deployment is done with the new playbooks.

Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
2016-09-06 11:22:56 -05:00
L.S. Cook e0dcd88171 fix whitespace
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-09-06 08:13:29 -07:00
L.S. Cook 0b8283d7b9 edit pass on bulk_provisioning tutorial
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-09-06 08:00:31 -07:00
Tullis, Michael L e8f5fd415b Punctuation 2016-09-02 23:45:07 -07:00
Tullis, Michael L f996c5086b Adding and reconfiguring ciao content per https://jira01.devtools.intel.com/browse/CLEAR-1593. 2016-09-02 23:01:06 -07:00
Tullis, Michael L ebf94ee792 Add bulk provisioning back into index 2016-08-31 16:19:07 -07:00
Tullis, Michael L a5f8079f7c Remove bulk provisioning from index 2016-08-31 16:16:59 -07:00
Tullis, Michael L 36f66ff853 Added bulk provisioning to index 2016-08-31 15:34:29 -07:00
L.S. Cook 62a9a176cc adding changes to ciao-cluster-setup.rst from Carlos Garcias merge request 94
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-08-30 13:00:58 -07:00
Leona 9cd11a3e0a Merge branch 'rnesius-bulk-provisioning' into 'master'
Bulk Provisioning Documentation

I think this should go under the "Advanced" section, alongside the pxe documentation.  Wasn't sure how to do that though.

See merge request !93
2016-08-30 09:21:23 -07:00
L.S. Cook 187fbede1c updating cc-oci runtime link on clear containers-getting-started page
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-08-30 09:19:26 -07:00
Robert Nesius ae1cb3b607 Corrections and cleanup 2016-08-29 22:39:01 -07:00
Tullis, Michael L 20d9513e30 Merge branch 'docs_sidebar_responsive' into 'master'
Docs - sidebar responsive fix

- Fixed responsiveness for sidebar on mobile devices
- Changed in header: Clear Linux Project* to Clear Linux* Project (star was in wrong word)
- Removed unused js code

See merge request !92
2016-08-29 15:28:57 -07:00
Noelia Nunez 3c0c9abc22 Fixed sidebar responsive styles 2016-08-29 17:18:01 -05:00
Noelia Nunez ff55768c65 Adding css changes for sidebar responsive 2016-08-29 17:15:09 -05:00
Leona 9652f78d71 update bundles_overview.rst with data from release 10140
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-29 08:26:59 -07:00
Leona bcc8fc4d34 Merge branch 'fix-vbox' into 'master'
Update VirtualBox documentation

This commit adds a section to virtualbox documentation and fix an instruction.

See merge request !91
2016-08-25 08:33:03 -07:00
Miguel Bernal Marin fce4821696 vm-virtualbox: update guest addition section 2016-08-25 10:09:44 -05:00
Leona 90f7bbfd97 Merge branch 'mesiment-ciao-cluster-setup' into 'master'
create new user `ciao` instead of `admin`

creating `admin` user instruction will fail due to user `admin` is created on the keystone bootstrap process.
We will create a ciao user instead with admin privileges.

See merge request !90
2016-08-23 13:15:31 -07:00
Simental Magana, Marcos 6eda4b7062 create new user ciao instead of admin 2016-08-23 15:04:35 -05:00
Tullis, Michael L 21449a24ca Merge branch 'mesiment-ciao-cluster-setup' into 'master'
use self-explanatory user/password for the keystone setup

Remove the ``csr`` user, replacing it with a more self-documenting user.

Change passwords to easier-to-understand passwords, avoid duplication
of the very same password for accounts which may confuse the user.

See merge request !89
2016-08-23 11:17:02 -07:00
Simental Magana, Marcos 7275edf942 use self-explanatory user/password for the keystone setup 2016-08-23 10:29:50 -05:00
Leona e1a7a8ad6e Merge branch 'mesiment-ciao-cluster-setup' into 'master'
update ciao-cluster-setup

There are some items that were updated:
- Remove a warning asking to not to start the ciao-controller is no ciao-network node was running.
- Update the configuration example file with new yaml schema changes.
- Use same passwords for the openstack users created to be consistent with the examples provided by the ansible deployment.

See merge request !88
2016-08-22 14:09:06 -07:00
Simental Magana, Marcos 1574143575 remove outdated warning about starting ciao-controller 2016-08-22 15:11:00 -05:00
Simental Magana, Marcos eb3aebe04d update configuration example 2016-08-22 15:09:43 -05:00
Simental Magana, Marcos d6c4507848 use same password as ciao ansible setup examples 2016-08-22 14:59:10 -05:00
Leona 9861edf08b updating details on bundles table as of version 10040
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-22 06:50:47 -07:00
Leona 41b6a4fb4c Fix for rendering of FAQs on clear containers
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-19 09:32:56 -07:00
Leona 97dcc0333d no capital letters in image file names on clear containers
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-18 13:09:43 -07:00
Leona 49f16d46da graphical filenames on clear-containers now with dashes
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-18 11:11:18 -07:00
Leona 219ab4b309 fixing broken images with png so they will render correctly
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-18 11:07:07 -07:00
Leona 93db1737c1 adding Intel Clear Containers graphics to master from stg 2016-08-17 06:53:42 -07:00
Tullis, Michael L fbbe67518d Merge branch 'ceph' into 'master'
Ceph

See merge request !87
2016-08-16 10:15:57 -07:00
Alberto Murillo 4e5b2bfd75 ceph-deploy: Update documentation
- Add metdata server for CephFS
- Use 'deployment' instead of 'development' node
- Clarify Prerequisites section
- Add a link to each roles default variables
- Add a node that EXT4 is not supported and XFS should be used

Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
2016-08-16 12:06:35 -05:00
Leona c52dd38ee8 fix broken link to Arch overview
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-16 10:04:59 -07:00
Leona e483a93b34 adding updates and changes from gwhaley-clear-containers 2016-08-15 10:32:34 -07:00
Leona 870225f793 fixing broken link and consistency in ref to VMware
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-15 09:07:32 -07:00
Robert Nesius 320ba144cb bulk provisioning docs first pass 2016-08-15 00:47:33 -07:00
Leona f0f4f6a0dc correcting ToC links and adding link to Architecture Overview
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-12 13:10:54 -07:00
Leona ca20b647af adding latest version of CC Architecture overview with req consistent use of Intel Clear Containers
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-12 11:55:22 -07:00
Leona 15ba5c5641 delete deprecated file bundles_in_clr and clean whitespace on
ceph deploy
2016-08-12 07:38:36 -07:00
Leona 55053858b2 fix spacing on code-block 2016-08-10 10:47:06 -07:00
Leona ac6b902226 Keep image reference generic for fix on sig validation sha512sum output
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-10 10:46:11 -07:00
Leona 7ca5d6c5e6 Fix doc bug for image sig validation sha512sum output
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-10 10:43:02 -07:00
Leona cc78b42cb6 bundles_overview table details current as of release 9890
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-10 10:07:48 -07:00
Tullis, Michael L 6e9f73dbe6 A few minor language updates in ciao-cluster-setup.rst after merge request 86 and commit b9edd20c. 2016-08-08 16:48:39 -07:00
Tullis, Michael L a749e7b9dc Merge branch 'albertom' into 'master'
Update ciao-cluster-setup

Update with newer usage

    - Remove trailing white-spaces
    - Rename cnci_agent to ciao-cnci-agent
    - Remove options from launchers command line
      (options are now fetched from the controller node)
    - Update cnci image reference from 7470 to 8260
    - Fix broken links
    - Create /etc/ciao/configuration.yaml file

See merge request !86
2016-08-08 16:33:06 -07:00
Alberto Murillo b9edd20c09 ciao-cluster-setup.rst: Update with newer usage
- Remove trailing white-spaces
- Rename cnci_agent to ciao-cnci-agent
- Remove options from launchers command line
  (options are now fetched from the controller node)
- Update cnci image reference from 7470 to 8260
- Fix broken links
- Create /etc/ciao/configuration.yaml file

Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
2016-08-08 18:27:41 -05:00
Leona bf264bee3c latest release update table on bundles_overview
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-08 10:53:22 -07:00
Leona 8607a6f29f fix typo
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-08 08:45:31 -07:00
Tullis, Michael L 3e0c827188 Fixed hyperlink. 2016-08-05 08:59:36 -07:00
Tullis, Michael L b6f6929c87 Minor language/branding correction for http://clrgitlab.intel.com/clr-documentation/project-docs/merge_requests/84. 2016-08-04 11:09:57 -07:00
Tullis, Michael L dd38bae970 Merge branch 'ciao-cnci' into 'master'
Ciao cnci

minor updating of ciao cnci related documentation

See merge request !84
2016-08-04 11:06:34 -07:00
Tim Pepper 7eabc505fa ciao: add openstack/keystone demo project creation command
A "demo" project is needed for the rest of the demostration commands shown.
Something/somebody was pre-creating this automagically in our dev
environment internally, but it needs done manually normally and that needs
documented.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-08-04 09:04:30 -07:00
Tim Pepper 0fc7807fb5 ciao: more ciao-cli syntax changes
Given my prior observation of outdated ciao-cli invocations, I did a read
through of ciao-cli related bits and found a number of additional areas
needing updated.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-08-03 16:03:15 -07:00
Tim Pepper 92b0ce3610 ciao: use updated ciao-cli arguments
Quite some time back the command line was modified without reverse
compatibility, and the docu here has bit rotted.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-08-03 14:26:31 -07:00
Tim Pepper e6c27bbdc2 ciao: simplify CA setup docu for ClearLinux
ClearLinux has simplified their mechanism for CA trust.  This nicely
trims a lot of complexity from our ciao documentation.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-08-03 14:19:54 -07:00
Tim Pepper 893c595675 ciao: note placement of image after creation
The unique thing here versus the upstream documentation is we're describing
a cluster setup where the image, once created, needs to land in a very
specific location.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-08-03 14:11:50 -07:00
Tim Pepper 5699f2db83 ciao: simplify cnci documentation
An upstream page has the maintained/preferred workflow for setting up a
CNCI.  Rather than trying to maintain a duplicate of this, lets minimally
describe what's needed and refer to the upstream documentation point.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-08-03 14:07:49 -07:00
Leona 001e95b8f3 sending fixes for ToC structure and tutorials section
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-03 11:31:50 -07:00
Leona 05a1b20cfc Merge branch 'fix-vm-virtualbox' into 'master'
Fix vm virtualbox

On external IRC (freenode) some people are asking to use VirtualBox on ClearLinux.
This PR updates VirtualBox documentation to ensure a proper usage.

This is a P1 issue that afects ClearLinux.

See merge request !83
2016-08-03 09:32:41 -07:00
Miguel Bernal Marin 4750be4c2f vm-virtualbox: Update documentation
ClearLinux changed the way to use VirtualBox. This commits update
the documentations to use it properly.
2016-08-03 11:21:02 -05:00
Tullis, Michael L ec3a427288 Minor language/branding corrections to commit e654cc2278 2016-08-02 15:54:03 -07:00
Tullis, Michael L 4cb82622c0 Merge branch 'ciao-certs' into 'master'
Ciao certs

We've got a snippet of stale information around adding certificates to a system, and could use some actionable info here to help users get their certs fully configured.

See merge request !82
2016-08-02 15:49:59 -07:00
Tim Pepper e654cc2278 ciao: freshen documentation on certificate authorities
We removed a section on adding certificates to your browser, yet we do need
info on adding a certificate to the system CA trust.  But this varies with
each linux distribution.  It's complicated and authoritative information on
the topic is out there in web, so give minimal information to help a
reasonable system administrator on their way.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-08-01 14:04:56 -07:00
Leona e799720c6d fix wonky list element html from table gen-doc.sh script
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-01 11:55:48 -07:00
Leona 25640d1af1 update bundle details as of version 9640 including go-basic go-extras ml-basic
Signed-off-by: Leona <leonax.cook@intel.com>
2016-08-01 11:33:57 -07:00
Leona 10f42e5d51 updating list of bundles as of release 9560
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-27 10:42:56 -07:00
Leona f8360b72b6 editingand refactoring for cleaner table of contents, Sphinx rendering, typos
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-27 08:40:45 -07:00
Leona 8b94376f2a refactoring ToC to make Clear Containers easier to spot, not hidden under getting_started
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-27 07:52:55 -07:00
Leona 52f341d847 minor edits for formatting, grammar, line length, etc
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-27 07:38:31 -07:00
Leona d1451676c0 branding correction
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-26 09:50:30 -07:00
Leona ff254eed10 branding correction
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-26 09:49:12 -07:00
Leona bdbb4417de updating getting started instructions with feedback from a user
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-26 09:45:24 -07:00
Leona fbd90911f6 fixing link to mailing list on gs_installing_as_host 2016-07-25 14:27:40 -07:00
Leona b103c1e43f fix broken link to clear containers docker and typo on page url
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-22 15:35:27 -07:00
Leona fd8fbdda6d fix links on bundles_overview
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-20 11:25:19 -07:00
Leona fa6fe7663c synchronizing table with more current list of Active and WIP bundles
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-20 11:15:24 -07:00
Leona 21743b44b4 editing validate_sigs.rst to comply with Jira commentary
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-19 08:03:13 -07:00
Leona e6d8b18df2 clarify validating_sigs.rst verifying signed MoM process
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-18 11:33:09 -07:00
Leona cf102d46d7 Merge branch 'ciao_deploy_update' into 'master'
Ciao deploy update

Update *ciao-deploy.rst* documentation with current examples in https://github.com/clearlinux/clear-config-management/tree/master/examples/ciao

Changes:
* updated the group_vars/all file with newest example
* deployment added a compute node
* Added the `--private-key=<ssh_key>` instruction when running the playbooks

Please merge once @onmunoz , @albertom , @lmaciasm , @eocardon  and @carlosag comment it's all OK with the changes

See merge request !81
2016-07-15 14:42:58 -07:00
Simental Magana, Marcos ed5a7bca31 ciao-deploy.rst: update documentation with new ciao ansible variables
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-07-15 15:29:25 -05:00
Leona 60bfd051e5 s 2016-07-14 13:02:58 -07:00
Leona 4ac4ca18f5 adding change by carlos how to access ciao workload
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-14 13:02:21 -07:00
Leona deaeb272c7 minor formatting fixes on validate_sigs.rst for readability
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-12 09:10:10 -07:00
Leona 6b724cc226 more branding minutiae for legal reqs
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-12 08:49:18 -07:00
Leona 05a6f2e20b minutiae regarding product name refs must comply with legal reqs
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-12 07:37:04 -07:00
Leona 0af1ae7902 update pubkey spacing error and format for better website rendering
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-08 16:44:03 -07:00
Leona 0c9677d359 branding symbols needed only on first instance per page
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-08 13:47:00 -07:00
Leona 0a05cbf7ba edit for branding reqs
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-08 13:38:38 -07:00
Leona e180e3dc6f edit for branding reqs
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-08 13:34:18 -07:00
Leona 730493c5a0 update clearcontainers page with Intel branding as per namesdb
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-08 13:29:27 -07:00
Leona 769c6ea11f updating page with required names-db branding fixes
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-08 11:45:38 -07:00
Leona 7112df9f9f consistency in timestamps
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-08 06:08:41 -07:00
Leona 33cdf11162 fixing small format issues due to gitlab rendering rst
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-07 15:21:13 -07:00
Leona ba8456e877 adding info about signing and verifying build artifacts to advanced_config
Signed-off-by: Leona <leonax.cook@intel.com>
2016-07-07 15:15:42 -07:00
Leona ed551e6a17 validate_sigs content being added 2016-07-07 15:13:48 -07:00
Leona b6677bef1a Merge branch 'mryan-ciao-cluster-setup' into 'master'
Mryan ciao cluster setup

See merge request !78
2016-07-07 13:33:59 -07:00
Mark Ryan 95181ccb9f ciao: Update ciao-launcher instructions
This commit removes the --network option that was specified on the various
ciao-launcher example command lines in the previous version of this
document.  --network is no longer needed as the role of a given launcher
instance is now determined from its SSNTP certificate.

The instructions for resetting compute and network nodes have been updated.
The --hard-reset option for launcher makes the other steps unnecessary.

Signed-off-by: Mark Ryan <mark.d.ryan@intel.com>
2016-07-07 20:25:10 +01:00
Leona 52c2c959fe Merge branch 'tcpepper-ciao-cluster-setup' into 'master'
Tcpepper ciao cluster setup

Small edit I forgot to push in May...

See merge request !77
2016-07-07 11:51:42 -07:00
Tim Pepper 3b40a1e93b ciao: update CNCI image location
A new image is rsyncing to https://download.clearlinux.org/demos/ciao/
and the documentation needs to reference it.  To prevent the need for
these changes repeatedly in the future, we'll soon have things set up
to consume automagically whatever is the latest image.

Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
2016-07-07 11:45:21 -07:00
Leona 391ff3d89a Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-07-06 10:48:39 -07:00
Leona 94dcf24397 ciao_ansible content corrected and ready for prod 2016-07-05 05:33:30 -07:00
Leona 99b8d45f63 Merge branch 'ciao_ansible' into 'master'
Ciao ansible

This Merge requests documents how to **use ansible** playbooks offered in clearlinux **to deploy a CIAO cluster**

See merge request !75
2016-07-05 05:31:40 -07:00
Leona e9c931c9b4 Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-07-05 05:28:47 -07:00
Leona 79b8feef92 Merge branch 'fix_usb' into 'master'
Fix command to create clearlinux bootable USB sticks

It was pointed out that our ``dd`` command to create live usb for clearlinux should not have the ``BS=`` parameter.

This merge request remove the BS=4M parameter from our ``dd`` command.

See merge request !76
2016-07-05 05:27:18 -07:00
Simental Magana, Marcos 61a4bcf86d update example creating bootable usb
This example removes the `bs=4M` part of the dd command using also
a newer installer image (clear-9130-installer.img.xz)

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-07-04 14:07:26 -05:00
Simental Magana, Marcos 7b1741cf25 remove BS=4M from the dd command
as pointed out on IRC:
<arjan> bs= on the dd command line will cause dd to not write the last partial
<arjan> block if the file you're writing isn't a multiple of the size

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2016-07-04 13:23:09 -05:00
Simental Magana, Marcos 6833466c6f change wording: to 2016-07-01 15:51:38 -05:00
Simental Magana, Marcos 289457e625 Add ciao-deploy using ansible page 2016-07-01 10:17:49 -05:00
Leona bf3698d504 adding content for user-level sig validating
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-28 16:52:33 -07:00
Leona 0ddb8ea0fc Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-06-24 11:14:20 -07:00
Leona 225f17d3ad updating image with png version
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-24 11:13:50 -07:00
Leona 6d538a5d73 Merge branch 'staging' into 'master'
Staging

Branch vm-doc-fixes getting pulled into master.

See merge request !74
2016-06-23 14:50:39 -07:00
Leona 1a38454bb3 Merge branch 'vm-docs-fixes' into 'staging'
Vm docs fixes

These are a small fixes to the visualized section.

See merge request !73
2016-06-23 14:48:47 -07:00
Miguel Bernal Marin 654d72a5d2 vm-hyperv: add secure boot instructions 2016-06-23 15:49:29 -05:00
Miguel Bernal Marin 0138836f10 link to the image directory instead of show latest version 2016-06-23 15:40:07 -05:00
Leona 9b3ce5efc7 updating diagram with more legible version created by RC
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-23 12:06:10 -07:00
Leona 811beb9f54 updating diagram with more legible version created by RC
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-23 12:01:05 -07:00
Leona 648d136d4a Merge branch 'staging' into 'master'
Staging

See merge request !72
2016-06-17 14:02:01 -07:00
Leona 0276254053 fixing broken table output from bundles script
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-17 13:57:12 -07:00
Leona 7b364dc859 Merge branch 'staging' into 'master'
Staging

See merge request !71
2016-06-17 11:36:22 -07:00
Leona 3c12a9a877 updating bundles_in_clr table to reflect current status of work on individual bundles
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-17 11:16:16 -07:00
Leona af0d939531 updating bundles_in_clr table to reflect current status of work on individual bundles
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-17 10:47:14 -07:00
Leona 6a89910f7a updating bundles_in_clr table to reflect current status of work on individual bundles
Signed-off-by: Leona <leonax.cook@intel.com>
2016-06-17 10:33:58 -07:00
Leona f2d91732d5 Merge branch 'onmunoz-ciao-cluster-setup' into 'staging'
Integrate new configuration package setup

See merge request !70
2016-06-17 10:17:03 -07:00
Munoz, Obed N af9fc10986 Integrate CIAO configuration commands and docs
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2016-06-17 12:00:33 -05:00
Tullis, Michael L 649f2616a9 Merge branch 'staging' into 'master'
Staging

See merge request !69
2016-06-16 13:54:49 -07:00
Tullis, Michael L fb2c81bf4b Merge branch 'ciao-cli' into 'staging'
Ciao cli

I have updated the ciao documentation to reflect the latest changes in ciao-cli

See merge request !68
2016-06-16 13:46:34 -07:00
Alberto Murillo b8fd2666b4 Update ciao documentation to show the new ciao-cli usage 2016-06-16 14:43:46 -05:00
Leona 81eaffac48 Merge branch 'staging' into 'master'
Staging

Mixer_update fixes from Tudor added to master

See merge request !67
2016-06-09 20:25:39 -07:00
Leona 71cb852b98 Merge branch 'mixer_updates' into 'staging'
Mixer updates

Update mixer documentation to reflect changes in the mixer tools scripts.

See merge request !65
2016-06-06 17:52:04 -07:00
Tudor Marcu 583827ee1c Update mixer docs to latest changes
Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2016-06-04 00:52:47 -07:00
Leona 819a592a37 udpate typo in edit of network-boot.rst, respectfully
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-23 09:58:51 -07:00
Leona 31a5543b21 Edit network-boot.rst instructions to be more sensible about PXE chainloading and other potentially ambiguously-confusing things
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-23 09:49:50 -07:00
Leona 06e434949f manually adding Alberto's changes to update ciao-cnci-agent naming convention on ciao-cluster-setup.rst
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-20 17:19:02 -07:00
Leona f2cf4645c9 Updating edit for further consistency and clarity
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-20 12:45:54 -07:00
Tullis, Michael L 36b4d64cc0 Fixed typos in bundles_overview.png. 2016-05-19 16:22:36 -06:00
Tullis, Michael L 009be63a3c Fixed typos in pktgen_lw3fd.png 2016-05-19 16:14:58 -06:00
Tullis, Michael L 26fc93e858 Fixed typos and language in ac-dpdk.rst. 2016-05-19 15:56:15 -06:00
Leona e9f7627d8f edit ac-ovs-dpdk.rst for English, grammar, flow, clarity and formatting
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-19 11:39:41 -07:00
Leona db8996a5fb updating with proposed fix for CLR-1382 JIRA doc bug
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-12 11:04:44 -07:00
Leona 692fabba72 Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-05-12 08:36:13 -07:00
Leona 82e35d5a5a submitting a fix for JIRA doc bug 1382 on vm-kvm.rst
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-12 08:35:52 -07:00
Tullis, Michael L 3de6a7dc50 Per merge request #62, copying commit b57f4440 to master branch from staging after a few minor corrections to punctuation. 2016-05-12 09:04:39 -06:00
Tullis, Michael L 73c3d3abf5 Per commit 16eaf347 to staging, removing the following bundle descriptions from the master branch:
openstack-all-in-one
openstack-compute
openstack-compute-controller
openstack-configure
openstack-controller
openstack-database
openstack-data-processing
openstack-lbaas
openstack-network
openstack-telemetry
openstack-telemetry-controller
openstack-vpnaas
2016-05-05 12:48:11 -06:00
Leona b0f7c45713 editing vm-vmware-player.rst file for syntax, formatting, grammar, lists
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-04 12:23:37 -07:00
Leona 686293f4e4 correct paragraph formatting typo
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-04 10:57:20 -07:00
Leona f589e9bf1b editing vm-vmware-esxi page for rst formatting and clarity
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-04 10:19:40 -07:00
Leona 9299392103 correcting formatting, grammar and typos in vm-hyper-v.rst
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-04 08:11:39 -07:00
Leona 634ec24020 correcting typos and formatting on vm_virtualbox page
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-04 07:40:07 -07:00
Tullis, Michael L 8569f92120 Based on b755b453 Disable Openstack Documentation due to CIAO 2016-05-02 17:18:19 -06:00
Leona 0b375c2471 restructure gs_getting_started to minimize vm vs bare metal install confusion reported on mailing list
Signed-off-by: Leona <leonax.cook@intel.com>
2016-05-02 07:08:23 -07:00
Leona ab25d7c5ef adding updated vm-kvm.rst with feedback
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-29 08:25:18 -07:00
Leona 61b57124a7 Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2016-04-28 14:10:16 -07:00
Leona 1b3afeb150 updating gs-clear-containers feedback received
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-28 14:09:50 -07:00
Tullis, Michael L 81427deb9d Changed TOC level in index-storage.rst to pick up second level headings in nav. 2016-04-28 13:35:46 -06:00
Tullis, Michael L a3e17f2402 Ceph docs from merge request #55 now going to master branch after a few corrections. 2016-04-28 12:17:47 -06:00
Tullis, Michael L be46563f67 This commit provides the documentation for the OpenStack Swift implementation with the clear-config-management tool. 2016-04-28 11:17:37 -06:00
Tullis, Michael L cf188a10ed Additional formatting and language corrections in mixer.rst 2016-04-28 10:13:04 -06:00
Tullis, Michael L bd016554a9 Formatting corrections to mixer doc for proper HTML build from RST. 2016-04-28 09:56:15 -06:00
Tullis, Michael L 1062a17b3f Merge branch 'mixer_formatting_correction' into 'master'
Mixer formatting correction

There were some formatting issues related to the last mixer change. This corrects those

See merge request !60
2016-04-28 08:23:40 -07:00
Brad T. Peters aef9793a47 Mixer formatting fix
Numbering was off, switching to manual numbering and
changing code block

Signed-off-by: Brad T. Peters <brad.t.peters@intel.com>
2016-04-27 23:32:30 +00:00
Tullis, Michael L 3c88447a38 Minor updates to gs_supported_hardware.rst, following up on new script capability. 2016-04-27 16:52:20 -06:00
Tullis, Michael L 2d11b8282f Fixes the clear-VERSION-pxe.tar.xz url Recommends to copy the iPXE files from /usr/share/ipxe/ instead of downloading them from the iPXE website Fixes some minor line breaks 2016-04-27 15:45:48 -06:00
Leona afddccf5c7 adding info to gs pages about the check-config script for hw
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-27 12:14:56 -07:00
Tullis, Michael L 1e6ddf0e47 Case change on title 2016-04-25 21:48:39 -06:00
Tullis, Michael L 5ed4492203 Moving ciao from advanced configuration section to getting started section. 2016-04-25 21:32:11 -06:00
Tullis, Michael L c0c380ab60 Ciao docs to master. 2016-04-25 18:32:22 -06:00
Tullis, Michael L 87337ba42e Merge branch 'CLR-DOCS-THEME-V2' into 'master'
Clr docs theme v2

Hey there,

This merge request contains all the changes needed to render the new theme of ClearLinux site over the automated documentation.

please take a look over it, ;)

See merge request !57
2016-04-25 15:24:07 -07:00
juliocri f1b95e01a6 ClearLinux v2 template changes. 2016-04-25 16:37:11 -05:00
Tullis, Michael L 720e0728cc Modifed conf.py file to update copyright to 2016. Fixed typo in gs_getting_started.rst. 2016-04-23 07:10:39 -06:00
Leona a378079e5d Merge branch 'mixer_update' into 'master'
Mixer update

Update mixer documentation to reference updated bundle set, and clarify format
and OS Epoch concepts

See merge request !54
2016-04-21 06:19:23 -07:00
Brad T. Peters cb8dc9ac30 Update mixer docs
Update bundle listing and format usage, add in descriptive
OS Epoch section
2016-04-20 21:22:48 +00:00
Leona d571fd72a3 A couple more small consistecy fixes for ac-dpdk.rst
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-20 10:28:30 -07:00
Leona bcbde35105 adding edits approved by Manuel
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-20 10:17:15 -07:00
Tullis, Michael L ab219abd7a Updating index_gs.rst 2016-04-18 09:39:32 -06:00
Tullis, Michael L cedd0e757b Updating index.rst 2016-04-18 09:34:35 -06:00
Tullis, Michael L a71b904f80 Fixing index files and headings in other files to repair left-pane nav hierarchy. 2016-04-18 09:18:18 -06:00
Leona 3a9cc8b200 keeping ist of bundle development projects current with recently-generated list
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-15 12:12:28 -07:00
Leona 6a9998a135 adding correct heading level to correct indexing issues
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-15 10:23:37 -07:00
Leona 5c9df43bd5 Merge branch 'staging' into 'master'
Staging

Updating master with updates staged from dpdk branch currently in staging

See merge request !50
2016-04-15 08:20:32 -07:00
Leona 6cb241397a Merge branch 'pxe' into 'staging'
Pxe

Fixes current doc for iPXE, and adds a new 'step - description' format

These changes were tested on NUCs in Intel's GDC site.

See merge request !48
2016-04-13 12:36:38 -07:00
Juan Esteban Castano Ramirez 919b2e4efa Fixes current doc, and adds a new 'step - description' format
Signed-off-by: Juan Esteban Castano Ramirez <juan.castano.ramirez@intel.com>
2016-04-13 14:02:46 -05:00
Tullis, Michael L fd813e3096 Changes to .gitignore to exclude HTML local build files 2016-04-12 18:17:26 -06:00
Leona d691849540 Merge branch 'dpdk' into 'staging'
Dpdk

This is the documentation from DPDK and OVS-DPDK plus some spell fixes.

See merge request !47
2016-04-12 15:08:12 -07:00
Miguel Bernal Marin d0d7a13644 fix ipxe script 2016-04-12 16:35:46 -05:00
Miguel Bernal Marin b9a88d7e03 add dpdk url 2016-04-12 16:31:49 -05:00
Miguel Bernal Marin 7c8763ca9e Renaming titles to short 2016-04-12 16:25:21 -05:00
Miguel Bernal Marin 1bab6bdf8d fix path in hyper-v 2016-04-12 16:19:37 -05:00
Mario Alfredo Carrillo Arevalo 8380fabf38 fix sign on ac-ovs-dpdk 2016-04-12 16:14:54 -05:00
Mario Alfredo Carrillo Arevalo d7b99c1bd0 fix ac-dpdk umount doc 2016-04-12 16:14:25 -05:00
Mario Alfredo Carrillo Arevalo 6735fa36f2 fix symbols on ac-dpdk 2016-04-12 15:55:38 -05:00
Mario Alfredo Carrillo Arevalo ad873384eb add DPDK and OVS-DPDK documentation
Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.com>
2016-04-12 14:30:25 -05:00
Tullis, Michael L 860ca51432 Fixed and verified in local build two broken hyperlinks in bundles_overview.rst 2016-04-11 16:03:39 -06:00
Tullis, Michael L 85b8ed49e4 Fixed and verified in local build two broken hyperlinks in bundles_overview.rst 2016-04-11 16:02:43 -06:00
Tullis, Michael L 4cf62418d4 Fix two hyperlinks in bundles_overview.rst. 2016-04-11 10:52:12 -06:00
Tullis, Michael L 66928e1800 Fixes to two hyperlinks in bundles_overview.rst 2016-04-11 10:33:56 -06:00
Leona fe1f30d8f1 Merge branch 'staging' of clrgitlab.intel.com:clr-documentation/project-docs into staging 2016-04-11 06:03:00 -07:00
Leoswaldo Macias b7c2764e3b Merge branch 'openstack' into staging
Adding new OpenStack documentation with clear-config-management
2016-04-08 16:02:20 -05:00
Simental Magana, Marcos 5b7f79281a Use **bold** for the variables 2016-04-08 15:15:24 -05:00
Simental Magana, Marcos 952485ee67 Fix "Required Parameters Per Component" table 2016-04-08 15:05:55 -05:00
Simental Magana, Marcos d371e82e62 Fix "Optional Parameters Per Component" table.
Having 4 rows makes the table hard to read so change it
to only have 2 rows.
2016-04-08 14:34:25 -05:00
Simental Magana, Marcos 04bf65c149 remove keystone_admin_token variable from documentation.
The installation process for mitaka does not use
admin token for keystone, so remove it from the
documentation.
2016-04-08 13:58:26 -05:00
Munoz, Obed N 9bef8f4da3 Fix roles inline code syntax
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2016-04-07 15:12:42 -05:00
Simental Magana, Marcos 4836b8ef6c openstack_conf_vars_list.rst: fix table headers 2016-04-07 14:58:20 -05:00
Munoz, Obed N f036705c40 Fix a couple of singular/plural words
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2016-04-07 14:44:08 -05:00
Leona 3305c63001 Merge branch 'staging' into 'master'
Staging

Fixing broken links on bundles table (temporary fix until @jchaming  and @fenrus75 can correct typos in the Github sources)

See merge request !46
2016-04-04 10:33:50 -07:00
Leona ba47f889b6 correcting broken links on games and openstack-common resultant from script generation of tables
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-04 10:24:23 -07:00
Leoswaldo Macias 8ad3a1a817 Fix table spacing
Signed-off-by: Leoswaldo Macias <leoswaldo.macias@intel.com>
2016-04-01 12:31:12 -06:00
Leoswaldo Macias a695312660 Add unsupported components table
Signed-off-by: Leoswaldo Macias <leoswaldo.macias@intel.com>
2016-04-01 12:29:49 -06:00
Leona 0cb7f943f3 Merge branch 'staging' into 'master'
Staging

Latest mixer.rst draft changes edited and ready for master branch

See merge request !45
2016-04-01 11:01:31 -07:00
Leona aaf6b23dfb Minor syntax and grammatical fixes on the latest version
Signed-off-by: Leona <leonax.cook@intel.com>
2016-04-01 10:58:17 -07:00
Leona 2846f007ff Merge branch 'mixer_updates' into 'staging'
Mixer updates

See merge request !44
2016-04-01 10:43:56 -07:00
Leoswaldo Macias 2eb3d7aab1 fix table and remove MVP word
Signed-off-by: Leoswaldo Macias <leoswaldo.macias@intel.com>
2016-03-31 15:34:11 -06:00
Leoswaldo Macias b3c57cb383 fix typo 2016-03-31 12:53:13 -06:00
Tudor Marcu 87282481b4 Update mixer docs
Updated some wording to be more accurate, and updated the workflow to
reflect the updated tools.

Signed-off-by: Tudor Marcu <tudor.marcu@intel.com>
2016-03-31 11:50:48 -07:00
Leoswaldo Macias daadf061b4 Fix grammar syntax to present
Signed-off-by: Leoswaldo Macias <leoswaldo.macias@intel.com>
2016-03-31 12:44:56 -06:00
Leoswaldo Macias 71e60d06e4 Add new documentation for openstack deployment with ansible
Signed-off-by: Leoswaldo Macias <leoswaldo.macias@intel.com>
2016-03-31 12:41:47 -06:00
Leoswaldo Macias 22067e6126 Delete old openstack docs
Signed-off-by: Leoswaldo Macias <leoswaldo.macias@intel.com>
2016-03-31 11:23:50 -06:00
Tullis, Michael L ed1e936f54 Merge branch 'staging' into 'master'
Staging

Updating bundles_overview.rst table with formatting and links to github repo.

See merge request !43
2016-03-30 12:45:38 -07:00
Leona f516347b78 Merge branch 'staging' of clrgitlab.intel.com:clr-documentation/project-docs into staging
Conflicts:
	source/bundles_in_clr.rst
	source/bundles_overview.rst
2016-03-30 10:41:29 -07:00
Leona 11faee509a Adding github linkage to bundles
Correcting css styling of striped table for readability of bundle names

Signed-off-by: Leona <leonax.cook@intel.com>
2016-03-30 10:37:49 -07:00
Leona 56121109cf adding github linkage to bundles
Signed-off-by: Leona <leonax.cook@intel.com>
2016-03-30 10:27:46 -07:00
Leona 10c5dbdf03 update borked list on step 3 of mixer tool process 2016-03-28 10:44:21 -07:00
Leona 80977700e4 format correction on process
Signed-off-by: Leona <leonax.cook@intel.com>
2016-03-28 10:28:42 -07:00
Tullis, Michael L 15a78465cd string change to build index for mixer docs 2016-03-23 13:55:19 -06:00
Tullis, Michael L 294785d799 String change to enable index for mixer docs 2016-03-23 13:49:50 -06:00
Tullis, Michael L 6447d72dec Merge branch 'staging' into 'master'
Staging

See merge request !42
2016-03-23 11:47:21 -07:00
Leona c7b995e899 Add mixer tool link to TOC
Signed-off-by: Leona <leonax.cook@intel.com>
2016-03-23 11:39:05 -07:00
Leona afd1e2622d Merge branch 'staging' of clrgitlab.intel.com:clr-documentation/project-docs into staging
Conflicts:
	source/mixer.rst
2016-03-23 11:34:23 -07:00
Leona 6d703d4e3c Adding mixer workflow to documentation
From Tudor's process in the wiki.

Signed-off-by: Leona <leonax.cook@intel.com>
2016-03-23 11:29:34 -07:00
Leona a69566fc42 Adding mixer workflow to documentation 2016-03-23 11:27:11 -07:00
Tullis, Michael L 0b56d750e4 Merge branch 'staging' into 'master'
Staging

Clarify various image options

See merge request !41
2016-03-22 10:42:26 -07:00
Leona 1374687325 installer image options updated with pointers to links in current 2016-03-21 11:51:03 -07:00
Leona f8e7176b05 Merge branch 'hyper-v' into 'staging'
Hyper-V documentation

Add Hyper-V documentation

See merge request !40
2016-03-17 14:10:57 -07:00
Leona f6f0b5030b Merge branch 'supportedhardware' into 'master'
Supportedhardware

Update the supported hardware in which Clear Linux has been tested.

See merge request !39
2016-03-17 14:04:19 -07:00
Miguel Bernal Marin f6010ec4b7 add more tmp files from vim to ignore 2016-03-17 14:49:01 -06:00
Miguel Bernal Marin 15a2309c6c add info regarding imgae size 2016-03-17 14:47:43 -06:00
Miguel Bernal Marin 70469c87a4 fix some typos 2016-03-17 14:42:38 -06:00
Miguel Bernal Marin 51723ead7c add vm-hyper-v to index 2016-03-17 14:29:58 -06:00
Miguel Bernal Marin 08a26d60df add Hyper-V documentation 2016-03-17 14:28:00 -06:00
Navarro, Jose d8b872420c Update showing all the hardware in which Clear Linux is being tested as of now. 2016-03-17 10:33:49 -06:00
Tullis, Michael L b3e7737ee8 Merge branch 'staging' into 'master'
Staging

See merge request !38
2016-03-16 08:53:42 -07:00
Leona bd05d95140 Updating bundles overview table to reflect current bundles 2016-03-14 06:42:55 -07:00
Leona e3e48395b2 Merge branch 'ignore_vim_files' into 'master'
Ignore vim files

With this Merge Request, vim temporary files (*.swp) will be ignored by git, this will avoid adding non-useful files to this repository

See merge request !37
2016-03-11 11:30:01 -08:00
Simental Magana, Marcos c817b0f178 ignore vim *.swp files 2016-03-10 17:45:09 -06:00
Leona d190f10c0f Merge branch 'staging' into 'master'
Staging

Updating master with reviewed virtualization content from staging

See merge request !36
2016-02-22 14:58:10 -08:00
Leona c629da082f Merge branch 'virtualization' into 'staging'
Virtualization Documentation

This patch serie is regarding virtualization software where Clear Linux can be run into.

This brach is based on master due to staging is 6 commits behind master.

This series adds 3 new files, virtualbox, vmware-player and vmware-esxi, and as them are from virtualization and there is already a page talking about virtualization a new section was created, where "running in a virtual environment" document was moved to a new section. All references where updated to create this new section.

See merge request !35
2016-02-19 14:32:59 -08:00
Miguel Bernal Marin 0fa30a6c7f rename pages titles 2016-02-19 15:22:15 -06:00
Miguel Bernal Marin 8bb9bcca6e add index_vm into index file 2016-02-19 15:11:19 -06:00
Miguel Bernal Marin ba75b06527 fix label to be like others vm-* labels 2016-02-19 15:09:10 -06:00
Miguel Bernal Marin 0e2ced0edd remove .rst from index 2016-02-19 15:03:50 -06:00
Miguel Bernal Marin 3954d6a204 add index_vm file 2016-02-19 15:02:45 -06:00
Miguel Bernal Marin 8d33ca0325 rename reference from gs_running_clr_virtual to vm_kvm 2016-02-19 14:46:25 -06:00
Miguel Bernal Marin e56f6e73e0 rename gs_running_clr_virtual to vm-kvm 2016-02-19 14:26:04 -06:00
Miguel Bernal Marin 2fb39de7d9 remove gs_running_clr_virtual from index_gs 2016-02-19 14:19:45 -06:00
Jose Carlos Venegas Munoz ec26657d14 add VMWare ESXi documentation 2016-02-19 13:45:19 -06:00
Jose Carlos Venegas Munoz cd3da2553b add VMWare Player documentation 2016-02-19 13:44:55 -06:00
Mario Alfredo Carrillo Arevalo 9c1219a9b7 add VirtualBox documentation file 2016-02-19 13:41:03 -06:00
Leona b3817c2aa4 Merge branch 'rename_bundle' into 'master'
Rename bundle

openstack-telemetry-controller bundle has been renamed to openstack-telemetry since this bundle is installed
on controller nodes as well as compute nodes so a more generic name is desired.

See merge request !34
2016-02-08 11:18:46 -08:00
Alberto Murillo 42cd0fffc2 Rename bundle openstack-telemetry-controller to openstack-telemetry
- This bundle is installed on hosts other than controller so a more
  generic name is desired
2016-02-08 12:46:51 -06:00
Leona 1c2928d042 Merge branch 'staging' into 'master'
Staging

See merge request !33
2016-01-13 08:31:34 -08:00
Leona ea599e09e3 updating bundles_overview to sync bundle list with current koji repo, small style corrections on table 2016-01-13 08:26:14 -08:00
Leona f837a9fe3a updating release links to images on gs_getting_started.rst 2016-01-06 11:35:28 -08:00
Leona 739e4cc9cd small formatting corrections on swupdate sections 2016-01-04 11:45:10 -08:00
Leona 62414fd544 Merge branch 'staging' into 'master'
Staging

See merge request !32
2015-12-31 10:58:00 -08:00
Leona f3f11a2eb2 swupdate_about edit - fixed awkward wording in a few places, added logical heading structure, changed passive to active voice 2015-12-30 12:10:15 -08:00
Tullis, Michael L 74c798d257 Merge branch 'staging' into 'master'
Remove underscore from update command in swupdate_how_to_run_the_updater.rst

Remove underscore from update command in swupdate_how_to_run_the_updater.rst

See merge request !31
2015-12-29 16:40:20 -08:00
Tullis, Michael L 116881eec2 Remove underscore from update command in swupdate_how_to_run_the_updater.rst 2015-12-29 17:39:13 -07:00
Leona 229b06f917 Merge branch 'staging' into 'master'
Staging

See merge request !30
2015-12-21 12:04:26 -08:00
Leona ed2640ac59 remove deprecated files and update index 2015-12-21 12:01:05 -08:00
Leona c9e863b32c merging bundles overview and list into one page, adding formatting for readability to table 2015-12-21 11:17:36 -08:00
Tullis, Michael L f90aaea2bd Merge branch 'staging' into 'master'
Staging

See merge request !28
2015-12-15 15:13:49 -08:00
William Douglas 6120306d64 network boot: block style file names 2015-12-15 23:07:47 +00:00
Tullis, Michael L 97f20ba58b Merge branch 'staging' into 'master'
Correction to index file.

See merge request !27
2015-12-15 14:52:57 -08:00
Tullis, Michael L 7c18bf9ae0 Correction to index file. 2015-12-15 15:52:03 -07:00
Tullis, Michael L 957cc67c31 Removing white space at end of a line. 2015-12-15 15:42:44 -07:00
Tullis, Michael L d69be558d9 Removing white space at end of a line. 2015-12-15 15:41:38 -07:00
Tullis, Michael L cfee08c98e Merge branch 'staging' into 'master'
Network boot topic and associated index files to master.

See merge request !26
2015-12-15 14:26:16 -08:00
Tullis, Michael L 971306f515 Language and formatting edits to network_boot.rst, plus changes to index files for topic build. 2015-12-15 15:24:46 -07:00
Tullis, Michael L 253da872b3 Merge branch 'staging' into 'master'
Minor punctuation change.

See merge request !25
2015-12-15 11:36:47 -08:00
Tullis, Michael L 59a4f80d7b Minor punctuation change. 2015-12-15 12:34:13 -07:00
Tullis, Michael L f47ac964e1 Merge branch 'staging' into 'master'
Staging

I just want my commit merged (the one about privacy) - but couldn't figure out how to exclude William's commits from the merge request.

http://clrgitlab.intel.com/clr-documentation/project-docs/commit/2a93396f784f7844e538265535bb792c27ecad80

-Rob

See merge request !24
2015-12-15 09:09:02 -08:00
Robert Nesius 2a93396f78 Telemetry disclosure on Getting Started page for Privacy requirements. 2015-12-14 16:25:32 -08:00
William Douglas c086ee4473 Update network boot based on feedback
Should be ready for merge to master after a final review.
2015-12-14 22:35:17 +00:00
William Douglas 082088cef1 Fix whitespace damage 2015-12-14 22:04:15 +00:00
William Douglas 9a27456d3e Revert "Removing network boot topic from Master branch. Not ready for public. Retained in Staging."
This reverts commit ac5effa225.

The removal merged into staging removing the file from staging so this
is just adding the file back.
2015-12-14 22:02:59 +00:00
Tullis, Michael L 3e2a9202d5 Merge branch 'staging' into 'master'
Minor language and formatting corrections to gs_gettings_started.rst.

See merge request !23
2015-12-11 11:37:29 -08:00
Tullis, Michael L 75486809d6 Minor language and formatting corrections to gs_gettings_started.rst. 2015-12-11 12:35:41 -07:00
Tullis, Michael L 6925a8fd5a Merge branch 'staging' into 'master'
Updated documentation regarding images and installation

The existing documentation is woefully out-of-date.  All images are now described, and the instructions for the installer were updated.

See merge request !22
2015-12-11 10:59:59 -08:00
Robert Nesius 202a45a548 Improved getting started and installation docs. 2015-12-10 16:33:38 -08:00
Tullis, Michael L 88e35c8b1a Merge branch 'staging' into 'master'
Push corrected Object Storage topic to master branch.

See merge request !21
2015-12-10 16:01:50 -08:00
Tullis, Michael L 1a5fad7dbd Made a few formatting and linking tweaks to the new openstack_object_storage.rst. 2015-12-10 17:00:03 -07:00
Tullis, Michael L 7992e64bb2 Merge branch 'staging' into 'master'
Add OpenStack Object Storage Documentation

See merge request !20
2015-12-10 15:42:44 -08:00
Munoz, Obed N dac945b6a6 Add OpenStack Swift Documentation
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2015-12-10 17:34:58 -06:00
Leona aa87dc7265 Merge branch 'staging' into 'master'
Staging

See merge request !19
2015-12-10 10:38:33 -08:00
Leona 449b54c847 edit bundle_service_summary file for line length and pw_summary for a csv table for easier additional service add details 2015-12-10 10:19:12 -08:00
Leona e79777ecd0 Merge branch 'staging' into 'master'
Staging

Edit bundles_in_clr.rst -- raw HTML needs to be tidy to render correctly within Sphinx directives

See merge request !18
2015-12-08 06:55:51 -08:00
Leona c24b54330a cleanup table rendering of current bundles 2015-12-08 06:52:00 -08:00
Leona 65d92d3836 Merge branch 'staging' into 'master'
Staging

Keeping table list view of bundles up-to-date.

See merge request !17
2015-12-07 07:56:12 -08:00
Leona adee55b3f8 updating table with current list of available bundles in clearlinux 2015-12-07 07:52:13 -08:00
Tullis, Michael L 1217568e87 Merge branch 'staging' into 'master'
Update to doc license file

See merge request !16
2015-12-02 15:25:26 -08:00
Tullis, Michael L ad3402d908 Removing redundant copyright statement. 2015-12-02 16:24:19 -07:00
Tullis, Michael L ac5effa225 Removing network boot topic from Master branch. Not ready for public. Retained in Staging. 2015-12-02 16:20:44 -07:00
Leona a1c518a163 Merge branch 'staging' into 'master'
Staging

Merge staged GS_ sections (ref links, whitespace and grammar fixes) into master

See merge request !15
2015-12-02 15:13:59 -08:00
Leona 4fb9bad13c network_boot edit and whitespace corrections" 2015-12-02 10:46:29 -08:00
Leona b9f049a7bf editing getting started sections for correct grammar given ref links 2015-12-02 06:19:29 -08:00
Tullis, Michael L 4bff0bd598 Merge branch 'google_analytics_code' into 'master'
Google analytics code

I've just added the tracking code that will help us to track all the content in order to preserve the SEO for the site.

See merge request !14
2015-12-01 15:03:50 -08:00
Tullis, Michael L bf6047a47c Merge branch 'adding_gitignore_file' into 'master'
Adding gitignore file

Here is just a simmle gitignore which will include the build html files since is't necessary to be tracked.

See merge request !13
2015-12-01 15:01:17 -08:00
acidaniel cc2cbb245b Adding GoogleAnalytics Tracking code 2015-12-01 16:52:12 -06:00
acidaniel 90d9af8443 Adding gitignore to exlude the build files since don't need to be tracked 2015-12-01 14:37:40 -06:00
William Douglas fab2b47bff Add preliminary network boot document, still needs revisions 2015-12-01 20:31:14 +00:00
Tullis, Michael L fc129652ab Fix files in bundle section 2015-11-30 09:46:09 -07:00
Tullis, Michael L a561fe94a8 Fixed bundle section 2015-11-30 09:38:45 -07:00
Rodrigo Caballero 435bb24416 theme: Change the index files for the right nav.
Changes the index files for the navigation to generate properly.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-11-30 10:12:03 -06:00
Rodrigo Caballero 820df025f0 theme: Add the theme files provided by DP.
Adds the original files supplied by DP without any modifications.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-11-30 10:05:20 -06:00
Rodrigo Caballero eb15ef6425 theme: Clean up all theme files from master.
This commit gives us a blank slate to implement the theme and be able
to debug it properly.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-11-30 10:03:09 -06:00
Tullis, Michael L 41d478a0ff Merge branch 'staging' into 'master'
Merge the fixed and tested theme and index files from staging to master

This latest version of the Sphinx theme solves the following issues:
Redundant titles on the master index page.
Search box placement and functionality.
Left Navigation panel hierarchy and functionality.
In line code markup is now properly rendered.

Ensure that all theme files and all index files are included in the merge. Changes to content files must not necessarily be included.

See merge request !12
2015-11-26 15:40:32 -08:00
Rodrigo Caballero b561dbe189 Merge branch 'CLR-DOCS-THEME' into staging
Merges the Docs theme brance with staging.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>

Conflicts:
	source/_themes/clearlinux/breadcrumbs.html
	source/_themes/clearlinux/footer.html
	source/_themes/clearlinux/header.html
	source/_themes/clearlinux/layout.html
	source/_themes/clearlinux/navigation.html
	source/_themes/clearlinux/static/css/main.css
	source/_themes/clearlinux/static/css/vendor/bootstrap-theme.min.css
	source/_themes/clearlinux/static/css/vendor/bootstrap.min.css
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.woff
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.eot
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.svg
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Light.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Light.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Light.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Light.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.woff
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.eot
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.svg
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Bd.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Bd.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Bd.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_BdIt.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_BdIt.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_BdIt.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_It.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_It.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_It.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Lt.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Lt.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Lt.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_LtIt.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_LtIt.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_LtIt.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Rg.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Rg.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Rg.woff
	source/_themes/clearlinux/static/images/favicons/favicon_android_192x192.ico
	source/_themes/clearlinux/static/images/favicons/favicon_android_192x192.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_114x144.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_114x144.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_120x120.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_120x120.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_144x144.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_144x144.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_152x152.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_152x152.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_180x180.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_180x180.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_57x57.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_57x57.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_60x60.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_60x60.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_72x72.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_72x72.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_76x76.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_76x76.png
	source/_themes/clearlinux/static/images/favicons/favicon_microsoft_144x144.ico
	source/_themes/clearlinux/static/images/favicons/favicon_microsoft_144x144.png
	source/_themes/clearlinux/static/images/favicons/favicon_web_16x16.ico
	source/_themes/clearlinux/static/images/favicons/favicon_web_16x16.png
	source/_themes/clearlinux/static/images/favicons/favicon_web_32x32.ico
	source/_themes/clearlinux/static/images/favicons/favicon_web_32x32.png
	source/_themes/clearlinux/static/images/favicons/favicon_web_96x96.ico
	source/_themes/clearlinux/static/images/favicons/favicon_web_96x96.png
	source/_themes/clearlinux/static/js/project.js
	source/_themes/clearlinux/theme.conf
	source/conf.py
	source/index-openstack.rst
	source/index.rst
	source/index_bundles.rst
	source/index_gs.rst
	source/index_sw_update.rst
2015-11-26 10:56:52 -06:00
juliocri 0f62a9268f Adding searchbox and second level at sidebar menu 2015-11-26 10:26:02 -06:00
Tullis, Michael L cc2a25ecf5 Updates from Rodrigo to index files: Staging --> Master 2015-11-25 12:44:36 -07:00
Rodrigo Caballero e909078db7 Add website theme to staging for testing.
Adds the theme files developed by digital properties and modifies
the conf.py to use them. This will allow testing and collaboration.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-11-25 11:29:10 -06:00
Rodrigo Caballero 5e69cd80d1 Fix index files' toctree directives.
The modified headings on the index files now work well with the
toctree directives removing the redundant headings on the master file.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-11-25 11:16:42 -06:00
Tullis, Michael L 84b86f4ea5 Adding componentized index files for navigation with new CSS. 2015-11-25 09:20:53 -07:00
Tullis, Michael L b966192df8 Merging commit d9a4e72c from Staging to Master after review and approval by James Hunt. 2015-11-25 08:31:49 -07:00
Tullis, Michael L 74672780ba Adding componentized index files (per category) for proper navigation with new CSS. 2015-11-25 08:23:42 -07:00
Tullis, Michael L d1c357bd03 Merge branch 'clear-containers' into 'staging'
Update bundle addition command for clear-containers documentation

Update clr_bundle_add command to install containers-basic

From Clear Linux **release 5050** the instruction to install a
new bundle has **changed from ``clr_bundle_add`` to ``swupd bundle-add``**.

This change updates the instructions to install the
containers-basic bundle to be compatible with the most recent
Clear Linux image released in public (5140 for native/cloud/kvm
and 5210 for container image).

*Please refer to OpenStack documentation (staging or master branch) to check new swupd syntax
usage to install new bundles in a Clear Linux machine.*

See merge request !10
2015-11-24 15:22:57 -08:00
Simental Magana, Marcos d9a4e72cdd Update clr_bundle_add command to install containers-basic
From Clear Linux* release 5050 the instruction to install a
new bundle has changed from clr_bundle_add to swupd bundle-add.

This change updates the instructions to install the
containers-basic bundle to be compatible with the most recent
Clear Linux* image released in public (5140 for native/cloud/kvm
and 5210 for container image).
2015-11-24 15:58:31 -06:00
Tullis, Michael L e386a14cff Merge branch 'staging' into 'master'
Update Clear Containers for Docker to v1.9.0 and add Fedora 23.

See merge request !9
2015-11-23 08:37:47 -08:00
Leona 3891716c55 cleanup README 2015-11-23 08:02:15 -08:00
James Hunt 3efb9d787e Update Clear Containers for Docker to v1.9.0 and add Fedora 23.
Signed-off-by: James Hunt <james.o.hunt@intel.com>
2015-11-23 13:31:27 +00:00
Tullis, Michael L df1fcf34b2 Fixed formatting in index.rst. No topic changes. 2015-11-20 16:02:42 -06:00
Tullis, Michael L 3e532d81df Fixed formatting in index.rst. No topic changes. 2015-11-20 15:57:55 -06:00
Munoz, Obed N 6db6470ab4 Remove nova-network reference
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2015-11-20 15:55:52 -06:00
Munoz, Obed N 9bd7fc3f45 Remove nova-network reference
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2015-11-20 15:43:46 -06:00
Tullis, Michael L ee821a5272 Merging the 15 OpenStack topics approved for public release (in index.rst) from Staging to Master. 2015-11-20 10:48:25 -06:00
Tullis, Michael L 6062fe0d81 Removing object storage topic from Master until it is approved for public. Retained in staging. 2015-11-20 10:38:45 -06:00
Tullis, Michael L ab9fbb5698 Minor formatting and non-technical text corrections to these files:
- OpenStack Dashboard
- OpenStack Block Storage
- OpenStack Orchestration
- OpenStack Networking
- OpenStack Telemetry
2015-11-20 10:31:23 -06:00
Tullis, Michael L c04d9c0280 Per resolution on issue #9, removed openstack_environment-database.rst and openstack_environment-messaging.rst. These were duplicates. 2015-11-20 09:23:32 -06:00
Simental Magana, Marcos 06a6e71cf9 Remove verify --fix instruction from documentation. 2015-11-19 17:14:22 -06:00
Tullis, Michael L db34ff168a Enable inter-topic navigation in Telemetry and Orchestration topics. 2015-11-19 14:02:41 -06:00
Tullis, Michael L 0484345b6d Updating index.rst and dashboard.rst for issue #9. 2015-11-19 13:30:04 -06:00
Salvador Fuentes 6762504799 Merge branch 'staging' of clrgitlab.intel.com:clr-documentation/project-docs into staging
Conflicts:
	source/openstack_telemetry.rst
2015-11-19 11:02:26 -06:00
Salvador Fuentes 8130556cec telemetry documentation fixed.
Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
2015-11-19 10:55:38 -06:00
Munoz, Obed N 706ee9f71a Update heat docs to Liberty Release
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2015-11-19 10:47:30 -06:00
Alberto Murillo 559917bd36 Update neutron documentation 2015-11-19 10:32:56 -06:00
Munoz, Obed N 42fbaf2d4f Disable swift from official docs, it needs more testing
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2015-11-19 10:32:36 -06:00
Simental Magana, Marcos e96f671daa Add missing line in prerequisites section 2015-11-18 15:55:22 -06:00
Alberto Murillo 2caa18bc2a Prefix # to commands 2015-11-18 15:38:56 -06:00
Leona fe4e176c0c Merge branch 'staging' into 'master'
Staging

See merge request !8
2015-11-18 07:46:00 -08:00
Leona e0f2e1d55f one more try to fix ref linkage in README 2015-11-18 07:41:12 -08:00
Leona f57f093f62 update README with jump-to section link fixed 2015-11-18 07:37:39 -08:00
Leona 42af65be62 update README with link to Sphinx Docs project 2015-11-18 07:32:52 -08:00
Leona 4be88534a6 update README 2015-11-18 07:29:54 -08:00
Leona 61baab7016 updating README; merge into master means one section of the README is conditional to when you cloned repo 2015-11-16 12:02:55 -08:00
Leona ae9aba68fe Merge branch 'staging' into 'master'
Staging

See merge request !7
2015-11-16 11:30:23 -08:00
Leona 54bd382d78 correcting code-block syntax to be consistent with the rest of the documentation 2015-11-16 11:25:09 -08:00
Leona 045fb9abe2 merging new index and Sphinx fixes into master 2015-11-16 11:14:40 -08:00
Leona ccfddb1c32 fixing files upstream to be able to merge 2015-11-16 10:51:48 -08:00
Leona 4e7ed89078 correcting code-block syntax to highlight bash scripting pygments in Sphinx 2015-11-16 10:05:18 -08:00
Leona ec135eae3c cleanup table views add detail to index 2015-11-16 09:08:01 -08:00
Leona 5f15301376 images need to be in _static folder for linkage, updating index with files, syntax editing on message broker service 2015-11-16 08:34:26 -08:00
Leona be89cea6d9 adding reference detail and link to tips for formatting in .rst docs 2015-11-16 07:24:06 -08:00
Leona 158bc2f163 adding instructions for how to correct index 2015-11-16 07:14:06 -08:00
Leona c407e981bc update README fix typo
Merge branch 'staging' of clrgitlab.intel.com:clr-documentation/project-docs into staging
2015-11-16 06:42:05 -08:00
Leona 31e79e9b36 update typo 2015-11-16 06:41:42 -08:00
Munoz, Obed N be0f1b67cb Change to new swupd command format
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2015-11-13 16:49:25 -06:00
Munoz, Obed N 95fa254486 Change to new swupd command format
Signed-off-by: Munoz, Obed N <obed.n.munoz@intel.com>
2015-11-13 15:55:04 -06:00
Leona e16fe932a2 fix typo and add external link to Sphinx doc. 2015-11-13 12:39:35 -08:00
Leona 6506a3f099 fix typo, add link to Sphinx 2015-11-13 12:37:26 -08:00
Leona 8edf3ebfa3 adding updated README 2015-11-13 12:32:01 -08:00
Victor Morales 30d01d4541 Fix some syntax errors on openstack_block_stoge
Signed-off-by: Victor Morales <victor.morales@intel.com>
2015-11-13 14:21:13 -06:00
Victor Morales 5e151b0217 Add software verify fix command
Signed-off-by: Victor Morales <victor.morales@intel.com>
2015-11-13 14:16:12 -06:00
Tullis, Michael L 102d4a7d75 Updated title strings in OpenStack topics for consistency in left-pane navigation. 2015-11-13 09:15:13 -07:00
Tullis, Michael L 1466f0f56a Updated title strings in OpenStack topics for consistency in left-pane navigation links. 2015-11-13 09:10:15 -07:00
Tullis, Michael L 08da077a30 Removing OpenStack "environment" files that were renamed as follows:
-   openstack_environment-database
-   openstack_environment-messaging
+   openstack_supporting-database
+   openstack_supporting-messaging
2015-11-12 16:02:55 -07:00
Tullis, Michael L d5adc2a005 Unmerging openstack_block_storage.rst and openstack_dashboard.rst. Content of these files in Master now reflects what is already public on clearlinux.org. Recent changes to these files in the Staging branch are WIP and are not ready for public release. 2015-11-12 12:22:05 -07:00
Tullis, Michael L dad9990979 Merging OpenStack files from Staging to Master. 2015-11-12 11:14:45 -07:00
Tullis, Michael L d1aaa82219 Added link at bottom of OpenStack Identity topic to next in sequence for navigation. 2015-11-12 10:41:00 -07:00
Tullis, Michael L ed749d6dd6 Added links at the bottom of OpenStack topics to the next topic in the sequence to enhance navigation. 2015-11-12 10:24:25 -07:00
Tullis, Michael L d29f1ae519 Added namespace (bookmark) at the top of each OpenStack topic to enable linking between them. 2015-11-12 10:02:05 -07:00
Simental Magana, Marcos d27cbbccc0 Remove unnecessary link instruction in nova compute (Nova) service 2015-11-12 10:32:32 -06:00
Simental Magana, Marcos dd1caf9fc0 Use the new swupd syntax for the block storage (cinder) service 2015-11-11 17:10:08 -06:00
Simental Magana, Marcos 780dff4113 Use the new swupd syntax for the identity, image, compute services
From CLR release 5050 swupd syntax for adding bundles update and verify
has changed to the following:

clr_bundle_add -> swupd bundle-add
swupd_update   -> swupd
swupd_verify   -> swupd verify
2015-11-11 16:59:21 -06:00
Simental Magana, Marcos 5afdd69bd9 Add verify section to openstack image service (Glance) 2015-11-11 16:34:59 -06:00
Victor Morales 292871597d Reduce the information about OpenStack Image
It was reduced the amount of information provided to the user. The idea is to
only offer minimal information to setup a functional service in order to
highlight those differences that Clear Linux offers.

Signed-off-by: Victor Morales <victor.morales@intel.com>
2015-11-10 17:41:38 -06:00
Simental Magana, Marcos 20263d6eb4 change file from MarkDown to rst to keep consistency. 2015-11-10 17:06:29 -06:00
Simental Magana, Marcos 346d0129b7 fix headers 2015-11-10 17:00:18 -06:00
Simental Magana, Marcos ef959e42d8 Fix explanation to say we're using rst instead of md 2015-11-10 16:57:17 -06:00
Simental Magana, Marcos b01b4a5e61 remove unnecessary note from openstack block storage (Cinder) 2015-11-10 16:35:16 -06:00
Simental Magana, Marcos c5331edcb7 Update openstack block storage (Cinder) documentation for Liberty 2015-11-10 16:33:07 -06:00
Simental Magana, Marcos 60c59b7b56 Add nova-metadata instructions to start in openstack compute (nova) 2015-11-10 16:33:07 -06:00
Victor Morales 6c621540c8 Initial draft for README file
Signed-off-by: Victor Morales <victor.morales@intel.com>
2015-11-10 13:31:42 -06:00
Victor Morales 9d6a3a9775 Reduce information about OpenStack Identity
It was removed several paragraphs in order to reduce the amount of information
available for users.  The main idea is to provide only the informaration
required for setting up a functional OpenStack deployment.

Signed-off-by: Victor Morales <victor.morales@intel.com>
2015-11-10 13:19:04 -06:00
Victor Morales 77aa446bc7 Rename OpenStack Supporting service files
It was renamed those files which correspond to supporting services. Moreover, it
was included the instruction to verify fix for installing the binaries of the
bundles.

Signed-off-by: Victor Morales <victor.morales@intel.com>
2015-11-10 12:18:26 -06:00
Simental Magana, Marcos 2835826e08 Add missing instruction in openstack compute (nova) 2015-11-10 10:38:36 -06:00
Simental Magana, Marcos 23a90c13d0 rearrange instructions in `verify operation` openstack identity (keystone) 2015-11-09 15:15:57 -06:00
Simental Magana, Marcos 7ab57a6011 Use consistent instructions when reloading triggers in openstack compute (nova) 2015-11-09 15:14:37 -06:00
Simental Magana, Marcos 2d549a9966 Restart the socket instead of the service unit for Openstack dashboard (Horizon) 2015-11-09 12:29:33 -06:00
Simental Magana, Marcos 2325841705 Add instruction to restart the keystone-admin service in identity (keystone) 2015-11-09 12:26:57 -06:00
Simental Magana, Marcos 8ee1b5635e Change for password-prompt in openstack image. 2015-11-09 11:49:25 -06:00
Simental Magana, Marcos d04353be96 Fix minor documentation details in compute, identity and compute. 2015-11-05 14:48:44 -06:00
Simental Magana, Marcos 6e431bb51d Add minor fixes for the compute service (Nova) 2015-11-04 16:35:30 -06:00
Simental Magana, Marcos 6e6ed02695 Add the nginx instructions to start the nova-api for Compute service (nova) 2015-11-04 16:10:07 -06:00
Simental Magana, Marcos 57009416cc Address minor details in openstack identity (keystone) documentation 2015-11-04 15:38:14 -06:00
Simental Magana, Marcos df905e8c3a Update openstack dashboard (Horizon) documentation for Liberty 2015-11-04 15:19:31 -06:00
Tullis, Michael L 0a48ff6fca Updating copyright info on index.rst file. 2015-11-03 14:13:18 -07:00
Tullis, Michael L c181bae020 Updating copyright info on index.rst file. 2015-11-03 14:12:05 -07:00
Tullis, Michael L 7ee4f07193 Updated bundles_in_clr_html.rst with the latest auto-generated bundle data. 2015-11-03 13:54:43 -07:00
Tullis, Michael L 3a475ea7da Updated bundles_in_clr_html.rst with the latest auto-generated bundle data. 2015-11-03 13:45:47 -07:00
Tullis, Michael L 38f2c69561 Fixed namespace references in two GS topics. 2015-11-03 12:22:36 -07:00
Tullis, Michael L 7c68827878 Fixed namespace references in two GS topics. 2015-11-03 12:21:32 -07:00
Tullis, Michael L 4edd6b0045 Updated internal cross references in all getting started topics to use the RST :ref: syntax rather than HTML code. Also made topic headings consistent. 2015-11-03 12:10:33 -07:00
Tullis, Michael L baaed9cae6 Updated internal cross references in all getting started topics to use the RST :ref: syntax rather than HTML code. Also made topic headings consistent. 2015-11-03 12:07:10 -07:00
Tullis, Michael L a551537306 Updated nearly all RST files to:
* Fix formatting issues.
* Simplify coding for code blocks.
* Fix typos.

Also adding links from "openstack_installing_bundles" to next-step topics.
2015-11-02 19:19:41 -07:00
Tullis, Michael L c9c84c5414 Updated nearly all RST files to:
* Fix formatting issues.
* Simplify coding for code blocks.
* Fix typos.

Also adding links from "openstack_installing_bundles" to next-step topics.
2015-11-02 19:18:24 -07:00
Tullis, Michael L f523805248 Fixed heading levels for consistency in these topics. These are already synced to the master branch:
openstack_dashboard.rst
openstack_environment-database.rst
openstack_environment-messaging.rst
openstack_identity-openrc.rst
openstack_image.rst
openstack_object_storage.rst
2015-11-02 16:10:13 -07:00
Tullis, Michael L 22b64d3850 Fixed headings for consistency in these topics:
openstack_dashboard.rst
openstack_environment-database.rst
openstack_environment-messaging.rst
openstack_identity-openrc.rst
openstack_image.rst
openstack_object_storage.rst
2015-11-02 16:06:56 -07:00
Tullis, Michael L 68d7b3b96a Removing ".gitignore" file as this is enabled in another location. 2015-11-02 15:15:53 -07:00
Tullis, Michael L 3afc6e5f5c Merge branch 'staging' into 'master'
Staging

MVP documentation has been updated to match with Liberty release of OpenStack.

This series of changes (files) update the documentation:

* index.rst
* openstack_installing_bundles.rst
* openstack_environment-database.rst
* openstack_environment-messaging.rst
* openstack_identity.rst
* openstack_identity-openrc.rst
* openstack_image.rst
* openstack_compute.rst

**Please do review and merge once Issue #1 is closed by Obed N Munoz.**

See merge request !5
2015-11-02 11:50:25 -08:00
Tullis, Michael L 0c13d5a416 Removing build files not needed in git. 2015-11-02 12:48:54 -07:00
Tullis, Michael L 5c0c4ece4e Removing build and theme files not needed in git. 2015-11-02 12:28:19 -07:00
Leona fa539bbc7e doc: fix image rendering, correcting ReST syntax for headings and targets 2015-11-02 09:50:56 -08:00
Simental Magana, Marcos 469325183e Add new content of the MVP into index 2015-10-29 17:38:28 -06:00
Simental Magana, Marcos c900819436 remove content from database, messaging, identity, image and compute 2015-10-29 17:38:03 -06:00
Simental Magana, Marcos df3867a2cb Add OpenStack compute (nova) documentation 2015-10-29 17:36:09 -06:00
Simental Magana, Marcos 1a09625672 Update to use keystone-public instead of keystone-main 2015-10-29 10:22:46 -06:00
Tullis, Michael L 70254a4ba7 Changes from Victor M. and Dimitri to master branch. 2015-10-27 11:54:00 -06:00
Tullis, Michael L 591a2638d7 Merging changes from Victor M and Dimitri. 2015-10-27 11:49:57 -06:00
Tullis, Michael L 039173fc70 Adding OpenStack object storage. 2015-10-27 09:23:22 -06:00
Tullis, Michael L 2ff1f8e854 Adding block storage. 2015-10-27 09:19:19 -06:00
Tullis, Michael L b7e0df7399 Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2015-10-27 08:40:12 -06:00
Tullis, Michael L 8dd8f26c56 Merge branch 'vjmorale/project-docs-staging' 2015-10-27 08:39:11 -06:00
Tullis, Michael L 4521dd0778 Merge branch 'master' into 'master'
Master

This way dev@lists.clearlinux.org becomes a URL of form `mailto:dev@lists.clearlinux.org` upon clicking it, an email client (e.g. outlook, or gmail, or whatever is the default for a user) opens to start writing email.

See merge request !3
2015-10-27 06:47:05 -07:00
Simental Magana, Marcos db63896e2d Add OpenStack image (glance) documentation 2015-10-26 17:46:54 -06:00
Simental Magana, Marcos 569049891c Add the openstack openrc documentation 2015-10-26 12:20:32 -06:00
Simental Magana, Marcos 134412bc27 Add the verify section into openstack_identity doc 2015-10-26 12:03:28 -06:00
Simental Magana, Marcos b7b9952547 Fix command line when creating user in rabbitmq doc 2015-10-26 11:28:43 -06:00
Simental Magana, Marcos 56830380ef Add Openstack Identity (keystone) documentation 2015-10-26 09:29:35 -06:00
Simental Magana, Marcos ad15db3485 Add Message queue documentation for OpenStack 2015-10-26 09:29:19 -06:00
Simental Magana, Marcos 01ab639500 Add MariaDB documentation for OpenStack 2015-10-26 09:26:51 -06:00
Dimitri John Ledkov deee5f6ac1 Use mailto: url for dev mailing list address. 2015-10-23 11:11:50 +01:00
Tullis, Michael L 18b522c387 Adding topic for Clear Containers and theme 2015-10-22 19:42:56 -06:00
Tullis, Michael L 901e6cef13 Clear Containers
Clear Containers
2015-10-22 17:49:50 -06:00
Tullis, Michael L a88dce9724 Merge branch 'staging' of clrgitlab.intel.com:clr-documentation/project-docs 2015-10-22 17:29:28 -06:00
Tullis, Michael L 0799c39e75 Merge branch 'master' of clrgitlab.intel.com:clr-documentation/project-docs 2015-10-22 17:17:58 -06:00
Tullis, Michael L 1d43a764eb Added topic on Clear Containers and updated theme files.
Added topic on Clear Containers and updated theme files.
2015-10-22 16:55:53 -06:00
Morales, Victor 34f74d5dca Remove the optional comment for MVP services 2015-10-13 13:57:23 -07:00
Tullis, Michael L f467fc9a3f Merge branch 'developers' into 'master'
Developers

fixed bugs.

See merge request !1
2015-10-13 10:11:43 -07:00
L.S. Cook 89853ef51e Testing developers branch 2015-10-13 09:55:31 -07:00
L.S. Cook 362f652ef4 formalizing Compute Node 2015-10-13 09:29:30 -07:00
Tullis, Michael L cc9f5e6e51 Initial commit
Initial commit
2015-10-12 15:39:17 -06:00
Tullis, Michael L d1e73affd7 first commit 2015-10-12 15:06:47 -06:00
1200 changed files with 16739 additions and 361771 deletions
-4
View File
@@ -1,4 +0,0 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: cc99ba4fd98ddc62c1fab24f336360f5
tags: 645f666f9bcd5a90fca523b33c5a78b7
@@ -0,0 +1,20 @@
---
name: Identify 'Guides' Type by Role -- For Guides only.
about: For new content in 'Guides', select 1 of 3 categories to which it belongs.
---
New pages will appear here: https://clearlinux.org/documentation/clear-linux/guides
1. Enter an 'x' in the category for the new "guide":
* [ ] Basics
* [ ] Developer
* [ ] Administrator
Complete the field below, following the colon, that matches option selected above:
I am a Clear Linux Beginner (Basics). I want to learn how to:
I am a Clear Linux Developer. I want to learn how to:
I am a Clear Linux Administrator. I want to learn how to:
+6
View File
@@ -0,0 +1,6 @@
#Exluding from the tree the html build files
source/_build
# ignore vi temporary files
*.swp
*~
.*~
-1178
View File
File diff suppressed because it is too large Load Diff
+16
View File
@@ -0,0 +1,16 @@
# Makefile for Sphinx documentation
#
all:
make -C source html
html:
make -C source html
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
clean:
make -C source clean
+83
View File
@@ -0,0 +1,83 @@
Documentation Build Instructions
################################
The `website documentation`_ for Clear Linux\* OS for Intel Architecture
should be written in :abbr:`ReStructuredText (ReST)` AKA ``.rst``, which
makes it easy to build parsable, command-line readable, indexed, and
search-friendly documentation and APIs with `Sphinx`_.
.. _requirements:
Requirements
============
To build documentation with Sphinx, ensure your system has these
prerequisites:
* `GNU make`_
* `Python`_
* `PIP`_
* `Sphinx`_
The instructions for installing these varies according to OS. On a basic out-
of-the-box Ubuntu-like OS (which usually has Python installed by default),
check your python version you might need something like:
.. code-block:: console
$ sudo apt-get install python-pip
$ sudo pip install -U sphinx sphinx-autobuild
.. code-block:: console
$ python -c 'print __import__("sphinx").__version__'
1.3.1
Cloning the documentation repository
====================================
We have confirmed Sphinx installed. The next step is to clone Gitlab
repository to our local machine.
.. code-block:: console
$ git clone https://github.com/clearlinux/clear-linux-documentation
Run make
========
Finally are we ready to run :command:`make`. Be sure to :command:`cd` to the
:file:`source/` directory where your ``.rst`` files are, before
running :command:`make html`, or the doc format of your choice.
.. code-block:: console
$ make html
>
sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v1.3.1
making output directory...
.
.
.
build succeeded, 0 warnings.
Build finished. The HTML pages are in _build/html.
Open one of the .html pages in a web browser to view the rendered
documentation.
For tips on how to contribute documentation formatted in the .rst style
needed to integrate beautifully on the clearlinux.org website, please see
`Theming Sphinx`_.
.. _website documentation: https://clearlinux.org/documentation
.. _Sphinx: http://sphinx-doc.org/
.. _GNU make: https://www.gnu.org/software/make/
.. _Python: https://www.python.org/
.. _PIP: https://pypi.python.org/pypi/pip/
.. _Theming Sphinx: https://github.com/otcshare/tcs-hub/blob/master/theming-sphinx.rst
Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 195 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

Some files were not shown because too many files have changed in this diff Show More