Commit Graph

127 Commits

Author SHA1 Message Date
Kristal Dale b7288202cf Get Started cleanup for translation (#630)
* Basic clean up and standardization of intro in preparation for translation.

- Simplify sentences.
- Remove idiomatic phrases.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Additional minor edits to simplify sentence/word choice for translation.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Removed section "Kernel Container" from compatible-kernels.rst as
Clear Containers are now deprecated and bundle no longer exists.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-07-16 19:25:46 -07:00
DougTW 95d8252c8e Corrected trademarks use on system-requirements (#624)
Closes #610 
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-15 16:09:52 -07:00
puneetse db5b8e0737 Update system requirements documentation (#589)
Update to include installer requirements section calling out higher needs for live desktop installer.

Over all revision of document and formatting.
2019-07-11 12:04:07 -07:00
George T Kramer e3538c68a5 Remove non-production image types (#555)
container-host-kvm.img is considered developmental and should not be
shown in documentation.  Want to keep list of image types in
documentation oriented toward production.

Signed-off-by: George T Kramer <george.t.kramer@intel.com>
2019-06-18 10:35:49 -07:00
Kevin Putnam cff315e9c6 Update image types to match current offerings. (#548)
* * updated image types to match current offerings
* fixed broken link in ister.rst - now pointing at image-types.rst

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Updates based on peer review.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Removed deprecated cloud image.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-06-17 12:24:41 -07:00
michael vincerra 52e8e1ff01 virtualbox-cl-installer: Revise figures to match VirtualBox 6.0.8 and new live-server installer. (#502)
* Revises instruciton to match VirtualBox 6.0.8 and new live-desktop installer; -live.img deprecated.
- Incorporates LGA and Troubleshooting from virtualbox.rst
- Replaces virtualbox.rst.
- Refer also to GH-493.
- Closes #495 
- Closes #502
- Closes #498 

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

Resizes figures; reassigns Troubleshooting section from virtualbox this doc.

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

Adds Troubleshooting section.

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

Removes ununsed figures, previously from virtualbox.rst.

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

Re-adds prev removed CAUTION in substitutions.txt

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

Revises guide per reviewer feedback.

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

Adds note on file size if using live-desktop install--below Fig. 6.

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

Incorporates reviewer feedback.

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

Revert to use case of live-server per reviewer feedback.
- Revise all Figures
- Revise all steps

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

Respond to reviewers' feedback.

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

Revise figures; add step for VBoxSVGA; move add desktop-autostart to post-install.

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

Respond to reviewer feedback re clarifying post-installation steps.

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

Simplify steps; define context for steps; correct values in code-block.

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

* Replaces step with note re kernel update in LGA section.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-31 11:10:29 -07:00
michael vincerra de8f97102c Corrects typo in intro para. (#491)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-15 18:39:59 -07:00
michael vincerra 53ab457fb9 Update available bundles 05-14-19. Revise intro, bundles.rst. (#489)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise wording per reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-14 12:31:59 -07:00
michael vincerra 9a4df878ed Add tut on how to connect to Win share using CL Nautilus (#430)
* Adds smb-desktop for samba sharing from CL Gnome desktop.

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

Add tut on how to connect to Win share with Nautilus on CL.

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

Add toc reference.

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

* Adds missing `_` leading space before file name; root cause image failure. (#431)

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

* Remove older unused openssh-server ref from toctree. (#432)

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

* updating dd command to add sync for Linux section (#425)

* Add document on installing proprietary NVIDIA drivers (#429)

* Add document on using YubiKey with U2F  (#416)

* Add document on using YubiKey with U2F

* Add yubikey doc to tutorials TOC

* Update all links to the download website to use the CDN (#434)

Update all links pointing at https://download.clearlinux.org to use
the CDN, i.e. https://cdn.download.clearlinux.org

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>

* Move autoproxy content to updated guide template (#417)

* first draft revision of autoproxy guide with guide template

* removed related topics as there is currently nothing that qualifies

* restructured a bit more to match guide template; removed autoproxy_about.txt and autoproxy_guide.txt as they are no longer needed

* made changes recommended by @mvincerx

* minor corrections based on feedback

* Update to the swupd Guide (#409)

* partial commit to save work

* latest changes

* replaced out of date swupd-guide.rst with contents of swupd-temp.rst; removed swupd-temp.rst

* changed page ref to swupd-guide from swupd; too many existing dependencies

* Added descriptions of manifests and delta packs from How to Clear

* fixed typo

* changed header organization slightly and removed unnecessary text formatting

* updated a couple headers to make more sense

* numerous cosmetic and readability changes based on full render review

* changes to description section based on updated swupd concept page

* updates based on feedback

* updates based on technical review

* removed swupd-search.rst; updated maintenance.rst toc tree after removal; updated references in developer-workstation.rst and kernel-module.rst that linked to swupd-search.rst

* Bootable USB (#436)

* bootable-usb: Add extra caution about unmount

Not unmounting an USB partition before an image is burned could cause
file system checksum errors leading to other issues (including kernel
panics) when trying to boot from the USB drive. This commit adds an extra
caution note to warn the users about the possible issues they could find
when this step is not followed correctly.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>

* bootable-usb: Add o_sync to the dd command

Update the example 'dd' command to burn an image, by adding the 'oflag=sync'
option. This allows to reduce the flashing time in conjunction with the
recommended 'bs=4M', enables a more accurate progress indicator, and allows
to remove the additional sync command, while preserving some cache
optimizations.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>

* Revises intro to add expl of CIFS/SMB in context; removes empty ref.

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

* Adds smb-desktop for samba sharing from CL Gnome desktop.

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

Add tut on how to connect to Win share with Nautilus on CL.

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

Add toc reference.

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

Revises intro to add expl of CIFS/SMB in context; removes empty ref.

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

* Revise intro per feedback; corrects hidden indent error; adds note.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-15 10:00:45 -07:00
Geoffroy Van Cutsem 8a6d69b82e Update all links to the download website to use the CDN (#434)
Update all links pointing at https://download.clearlinux.org to use
the CDN, i.e. https://cdn.download.clearlinux.org

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-03-20 14:31:30 -07:00
michael vincerra ce37ed3814 Remove older unused openssh-server ref from toctree. (#432)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-18 17:04:11 -07:00
michael vincerra c6bd5e7a55 Add Distro factory guide for DevOps' process automation (#411)
- Adds `architect-lifecycle` as Phase 1 prior to `distro-factory` in guides for a DevOps toolchain. 
- Adds Figure 1 overview.
- Adds architect-lifecycle to toctree in maintenance.rst

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

Incorporate @mbelluzzo feedback. In progress.
Include reference/reference changes.

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

* Redefine scope, title of document: Maintain CL life-cycle.

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

* Revise intro after re-scoping.

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

* Revises scope as overview of life-cycle; context for distro-factory.
Adds new simplified graphic.

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

* Retitles; revises intro and Content Workflow.
Revise Figure 1 and renames it. Revises document filename.

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

* Removes older version.

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

* Adds revised title to toctree. Corrects missing `-`.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-03-15 09:51:55 -07:00
Michael Vincerra e6210910ea Updates bundles, pundles as of 02-20-2019.
- Fixes #404
- Other regex fixes to follow in subsequent PR.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-20 09:45:37 -08:00
Michael Vincerra a1e5c4547a Adds openssh-server to reference/bundles.
- Adds openssh-server to reference toctree.
- Changes location of openssh-server to reference/.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 17:33:33 -08:00
Michael Vincerra c05190db11 Adds openssh-server to reference.rst toctree.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 09:50:31 -08:00
Michael Vincerra 023c28ec59 Brings back openssh-server and applies command updates.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 09:49:18 -08:00
Michael Vincerra 5ca61a686c bundle_lister.py, et al:
- Adds <ul> to template
- Removes repeated 'gimp' and incorrect package `gui component`.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-01-28 11:25:24 -08:00
Michael Vincerra 72f24c09f5 Updates available bundles per clr-bundles repo 01.28.2019.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-01-28 09:10:30 -08:00
Kristal Dale 1aa805dddc Minor revisions to structure-formatting and writing-guide (based on feedback)
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-23 13:18:15 -08:00
Kristal Dale 7f7841d40a - Correct typo in README
- Add example/bullets to headlines section in writing guide

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-17 11:54:39 -08:00
Kristal Dale b099433b6c - Clean up indentation for examples.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-16 17:24:25 -08:00
Kristal Dale 52b93d649e - white space correction
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-16 17:07:33 -08:00
Kristal Dale 7270dbe3e2 - Clean up remaining reference to mailing list
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-16 17:02:52 -08:00
Kristal Dale 7d70b47969 - Remove GitHub repo link from toctree
- Reword description for use of :abbr:
- Simplify reference to mailing list

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-16 16:57:24 -08:00
MCamp859 b6db090cee Minor text edits for clarity.
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-01-14 17:25:33 -05:00
Kristal Dale 0855e8ed8d Next round revisions:
- alphabetize formatting table
- readd toctree to landing page, with alternate text
- line-length clean up
- add links to references available online
- misc cleanup

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-11 13:52:33 -08:00
MCamp859 52a6071097 Edited text.
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-01-11 11:51:42 -05:00
Kristal Dale 88a09a22f6 Contribution guideline reorg and clean up
- Reorg content into 3 pages for collab guides: overview (collaboration.rst),
structure and formatting, and writing guide.
- Simplify content, including removal of definitions/guidelines provided by
our listed resources, simplification of wording and examples.
- Add in quick ref section for our updated BKMs
- Update the README installation instructions
- Clarify different methods of contribution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-08 13:33:25 -08:00
Michael Vincerra 7bd80a2eee Updates bundles.html.txt to:
- Capture most recent bundles, pundles added; modified
- Correct URL from packages-descriptions to packages

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-12-27 12:50:52 -08:00
Michael Vincerra 69061a3253 Removes first link to GH; directs user to select Name link in Col 1.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-12-19 17:25:25 -08:00
Michael Vincerra 72515eedde Adds sentence to direct user to select hyperlink Name.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-12-19 12:35:19 -08:00
Michael Vincerra ecbbb78759 Removes extra <tr> at top; removes <style>, overwritten by parent css.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-16 17:17:01 -08:00
Michael Vincerra b94c22cf59 Revises first two <tr>'s of table; includes <style> as test.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-16 17:04:31 -08:00
michael vincerra 159263d7b9 Merge branch 'master' into mv-edits-bundles-04 2018-11-15 14:49:58 -08:00
Michael Vincerra 276d764221 Adds newly generated bundles.html.txt to:
- Capture latest activity in clr-bundles since PR initial commit
- Revises datetime to appear in <th> instead of <tr> of table

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-14 13:48:19 -08:00
Kristal Dale 44fd806ade Update word in collab guide code section
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-08 10:29:34 -08:00
Michael Vincerra e6bce3b1e0 Incorporates program-generated list of bundles and packages:
- This uses automated result of bundle_lister.py, not yet integrated
- Naive UTC time and date stamp used; going forward it replaces prose.
- Constitutes most recent update from clr-bundles as of 7 Nov. 2018.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-07 12:10:24 -08:00
Michael Vincerra 5ac83dc3e8 Revisions include:
- Removes prosiac inclusion of date; replaced by automated UTC
- Adds sentence with link to bundles-about

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-07 12:08:40 -08:00
Kristal Dale 1e2b3fdfa4 Update product name substitution
-Replace instances of CLOSIA substitution with CL-ATTR.
-Replace in-line use of Clear Linux with CL.
-Clean up white space.
-Limited clean up in collab section, in pref of future rework
-Set landing page toctree to use maxdepth 1

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-06 13:59:22 -08:00
Michael Vincerra 296dbbfa16 Removes <head> element from bundles.html to address css error.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-02 11:58:42 -07:00
Michael Vincerra 68d9e7ca76 Removes inline styles to address error:
- Root cause unknown; likely PHP or Drupal related
- Previous PR 277 did NOT include any edits to bundle.html
- Inline styles are overwritten by higher-levell css

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-02 10:19:58 -07:00
Michael Vincerra 2cefc36098 Revise header level to test error: mistaken styles inclusion.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-11-02 09:14:39 -07:00
michael vincerra c95d8c08a0 Merge pull request #277 from mvincerx/mv-edits-bundles
Remove 4 bundle descriptions on bundles.rst reference page
2018-10-31 18:32:48 -07:00
Michael Vincerra 84217dfdf2 Changes heading level to match standard.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-10-29 08:57:06 -07:00
Kevin Putnam 24cad8de93 fixed link to sphinx-doc.org 2018-10-25 11:32:51 -07:00
Michael Vincerra 6577f229d3 Remove bundle description files:
- containers-basic
- openssh-server
- os-core
- kvm-host

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-10-23 17:21:38 -07:00
Michael Vincerra a1553223bd Remove list of 4 bundles because:
- Bundles cater to cloud use cases only
- Include Clear Containers; deprecated
- Give undue emphasis without justification for their selection

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2018-10-23 17:16:36 -07:00
Kristal Dale 3d92de602b Clean up extra returns.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-08 14:57:29 -07:00
Kristal Dale b75b688066 - Updated section headings to use correct underlining and capitalization. Updated heading text for clarity.
- Update first CL reference to use CL-ATTR.
- Break out first steps in Change default port section to be one step per #.
- Update code-block command examples to use bash style. Separate the example commands from the example output.
- Remove prompt # from example commands (per guidelines).
- Minor capitalization and grammar edits.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-08 14:47:31 -07:00
Simental Magana, Marcos 19c6f692b6 Document how to change OpenSSH default port.
This commit documents how to change the OpenSSH port on Clear Linux*.

Clear Linux* enables an `sshd.socket` systemd unit, which listens in
port 22 by default.

This commit fixes #261

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2018-10-08 10:49:41 -05:00