Commit Graph
2267 Commits
Author SHA1 Message Date
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
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
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 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
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
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 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