Commit Graph

2251 Commits

Author SHA1 Message Date
DougTW e39019c016 Replaced include with ref. (#654)
* Reworded paragraph and linking text.

Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-20 19:49:22 -07:00
DougTW 61620b4b6a vmw-player.rst: replaced links to download-verify-decompress. (#653)
* Replaced include with ref.

Signed-off-by: DougTW <doug.martin@intel.com>

* Reworded paragraph and linking text.

Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-19 18:41:06 -07:00
Kristal Dale 687aa3abcc Initial commit for translation clean up (network and telemetry guides) (#650)
Signed-off-by: Kristal Dale <kristal.dale@intel.com>

Clean up in preparation for translations …

- Standardize page formatting (use of intro sentence, TOC tree, etc)
- Simplify intro sentences, remove idioms, etc
- Standardize use of roles (remove use of `` and * for emphasis on special words or options)
- Misc clean up (opportunistic)

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

Updates per requested changes on PR.

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

Minor revision to use :file: for directories referenced in deploy-at-scale.rst

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

Minor clean-up on network-related files.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-19 18:40:27 -07:00
Kristal Dale b9e5806856 Initial commit for maintenance guides clean up (preparation for translation) (#648)
Signed-off-by: Kristal Dale <kristal.dale@intel.com>

Initial commit of cleanup for translations (maintenance guides)

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

Clean up in preparation for translations

- Standardize page formatting (use of intro sentence, TOC tree, etc)
- Simplify intro sentences, remove idioms, etc
- Standardize use of roles (remove use of `` and * for emphasis on special words or options)
- Misc clean up (opportunistic)

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

Update per requested changes on PR.

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

Edits per requested changes on PR from @mvincerx

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-07-19 18:15:45 -07:00
michael vincerra 5ab6383d6d Moves stacks from tutorials to guides. (#644)
- Modifies guides.rst to add stacks subdir
- Replaces all internal refernces in docs from tutorials to guides
- Cleans up cruft left from merge conflict on kernel-modules-dkms.rst

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

Closes #579

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

Revise for rebase updates.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-19 15:02:22 -07:00
Mary Camp 67907a111d New guide: how to query upstream CL repo (#637)
Signed-off-by: MCamp859 <maryx.camp@intel.com>

Added feeback and TOC sections.

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

Revise formatting for conformity to Sphinx syntax.

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

Edits to code-block console output for alignment.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-19 14:50:34 -07:00
michael vincerra bfa5831d8a Revise Table 1 to clarify labels, filesystem, and default verbiage. (#646)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-19 14:00:44 -07:00
Beth Dean 55afe3a126 Update VMWare installation guide (#626)
* Update VMWare installation guide

Cleanup to respond to review.

Refresh VMware Player images and refactor UEFI section

Clean up installer download instructions.

Add note regarding open-vm-tools

Adds note re downloaded latest version, possibly different commands.

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

Revise sentence 2 for copyright usage.

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

* Resolves conflicts. Aha!

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-19 13:53:35 -07:00
DougTW d9a53a1266 Merged download, verify, and decompress instructions (#645)
* Merged Linux, Mac, Windows instructions for download, verify, decompress CL image.
- closes #631

Signed-off-by: DougTW <doug.martin@intel.com>

* Added TOC, revised hierarchy of steps and headings.

Signed-off-by: DougTW <doug.martin@intel.com>

* Revised heading hierarchy...again...

Signed-off-by: DougTW <doug.martin@intel.com>

* Simplified headings to improve TOC and translation effort.

Signed-off-by: DougTW <doug.martin@intel.com>

* Added ref to Clear Linux OS image types file.

Signed-off-by: DougTW <doug.martin@intel.com>

* Resets starting point for include; rewrites intro; fixes errors.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-18 17:37:56 -07:00
michael vincerra 2860bccbf0 Revise Table 1 to clarify labels, filesystem, and default verbiage. (#647)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-18 16:24:48 -07:00
Mary Camp cac1634962 Text edits in prep for xlation. (#640)
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-07-17 15:54:04 -07:00
DougTW c91bd2357e Revised link to stateless.rst and added trademarks. (#635)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-17 15:47:35 -07:00
DougTW 1abe189da3 Revised link to stateless.rst, formatting, and trademarks. (#634)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-17 15:42:20 -07:00
DougTW 59c0f13160 Fixed broken link to stateless.rst. Made minor editorial and trademark/branding revisions. (#633)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-17 15:38:32 -07:00
DougTW 6c2edca52b Fixed broken link in kernel-modules-dkms.rst. (#632)
- Resolved merge conflicts.

Signed-off-by: DougTW <doug.martin@intel.com>

Clean-up and testing to resolve conflicts.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-17 11:27:41 -07:00
DougTW 5bd551fda5 Docker.rst. Removed broken link and corrected trademark errors. (#627)
* Removed broken link and corrected trademark errors.

Signed-off-by: DougTW <doug.martin@intel.com>

* Resolve build error due to missing char on header.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-17 10:45:26 -07:00
DougTW 5835e70a19 Telemetry guide: made editorial, formatting, and spelling revisions. (#615)
* Editorial revisions to telem-guide.rst.

Signed-off-by: DougTW <doug.martin@intel.com>

* Telem-guide: completed sphinx formatting revisions requested by mvincerx

Signed-off-by: DougTW <doug.martin@intel.com>

* Final edits to headers and removing spaces.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-17 10:36:35 -07:00
DougTW 07f61f81f6 kernel-modules: revised link to mixer.rst and minor editorial changes (#629)
* revised link to mixer.rst and minor editorial changes

Signed-off-by: DougTW <doug.martin@intel.com>

* Restore change by @DougTW
2019-07-17 10:00:53 -07:00
Kristal Dale ec9e3caf5a Clean up of syntax around gui elements in preparation for translation. (#636)
- Items clearly referring to an element in a GUI (e.g. buttons, menus,
areas in GUI/screen) updated to use :guilabel: or :menuselection: as
apprpriate.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-07-16 19:34:38 -07:00
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
michael vincerra 676fc1fb37 Maintenance Guides: Basic link clean up in advance of translation of content (#625) (#609)
* Basic link clean up in advance of translation of content

- Remove unused links
- Updated links  defined as named refs to use simple text e.g. name of linked content
instead of narrative text
- Minor edits to accomodate minor changes to name of ref links

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

* Update links according to feedback on PR.

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

* Update link according to feedback on PR.

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

Adds new figures for live-desktop, checking prerequisites, kernel options.

- Ref: https://github.com/clearlinux/clr-installer/issues/406
- Ref: https://github.com/clearlinux/clr-installer/issues/384

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

Re-orders all figures; adds new section, advanced config as placeholder.

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

Re-scopes PR to include only checking prereqs, kernel update, and software update.
- Three new screenshots/figures

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

Adds edits to bare-metal-install-desktop.

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

Revise wording for Proxy configuration per new Network Manager.

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

Cleans up in-text reference to reordered figures.

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

Squash commit fake.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-16 16:10:53 -07:00
Kristal Dale 4f32e1995f Maintenance Guides: Basic link clean up in advance of translation of content (#625)
* Basic link clean up in advance of translation of content

- Remove unused links
- Updated links  defined as named refs to use simple text e.g. name of linked content
instead of narrative text
- Minor edits to accomodate minor changes to name of ref links

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

* Update links according to feedback on PR.

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

* Update link according to feedback on PR.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-07-16 15:23:16 -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
Beth Dean ddf04eb8c8 Add link for terms of use. Closes #622 (#623) 2019-07-15 16:06:06 -07:00
pixelgeek 744d99d23b Update fmv.rst (#616)
* Update fmv.rst

Fix FFT typo in section header

* Update fmv.rst

Updates explaining that FFTW is an FFT library
2019-07-15 11:53:09 -07:00
Mary Camp ecb9593c3d New guide: how to install using config file (#568)
* New guide: how to install using config file

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

* New guide: how to install using config file.

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

* Added line numbers, minor text edits

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

* Incorporated review feedback.

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

* Adding more feedback.

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

* More text changes per reviewer feedback.

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

* Add reviewer feedback.

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

* Completed more text edits.

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

* Adding latest feedback.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-07-15 09:57:43 -07:00
Kristal Dale af63cd4105 Tooling link clean up (#620)
Basic link clean up in advance of translation of content.

- Removed unused links
- Updated links defined as named refs to use simple text e.g. name of linked content
instead of narrative text.
- Minor text edits to accomodate minor changes to name ref links.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-07-15 09:13:25 -07:00
Kristal Dale e5338e5f0a Get Started section link clean up (#618)
* Link clean up

Basic link clean up in advance of translation of content.
- Removed unused links
- Updated links defined as named refs to use simple text e.g. name of linked content
instead of narrative text.
- Minor text edits to accomodate minor changes to name ref links.

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

* Fix typo from first commit.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-07-12 17:20:24 -07:00
DougTW 31e872669e Fixed cross-ref and made minor formatting and editorial changes. (#619)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-12 14:57:58 -07:00
DougTW beab785600 Fixed cross-ref in bare-metal-install-server.rst to autoproxy (#617)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-12 12:44:07 -07:00
michael vincerra 9b47a4a599 Fix error in sequence of figures, live-desktop. (#613)
- repetition of Fig 3. and Fig. 4

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-11 17:14:43 -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
michael vincerra d9b97cda29 Revises bare-metal-install-desktop fig 3 to clarify installer icon. (#603)
* Revises bare-metal-install-desktop to clarify installer icon.
- Closes #577

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

* Revisions to "Launch the installer" text.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-10 17:54:27 -07:00
michael vincerra 70a9988c6b Add section on settign a static machine id. (#606)
- Closes #558.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-10 09:04:17 -07:00
Mary Camp f4f2e2bec7 Corrects Step 4 command to verify integrity. (#602)
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-07-09 09:59:47 -07:00
DougTW 6290be9041 NVIDIA; Trademark, branding, and editorial changes (#601)
* Minor editorial and trademark/branding changes.

Signed-off-by: DougTW <doug.martin@intel.com>

* Fixed file directive. Made grammatical change suggested by puneetse.

Signed-off-by: DougTW <doug.martin@intel.com>

* Fixed heading markup requested by mvincerx.

Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-09 09:25:32 -07:00
michael vincerra 55f70475cf Replaces telemetry figure per Engineering for clr-installer 2.0.8. (#595)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revises Figure 16, telemetry, to remove installer version.
- Closes #590 to address non-UEFI USB entry in BIOS during install

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

Closes #590.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-09 09:22:05 -07:00
michael vincerra 0f0eb17809 Replaces telemetry figure with clr-installer 2.0.8 version, live-desktop. (#597)
* Update telemetry figure per Engineering to reflect clr-installer 2.0.8.

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

Revise instruction to match new GUI.

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

* Revise wording of step to match new GUI.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-08 17:30:10 -07:00
Beth Dean fe2194355a Add a note about running stack on other Linux distros (#598)
* Add a note about running stack on other Linux distros

* Add unistall instructions
2019-07-08 15:07:44 -07:00
DougTW 000a3d60df mixer.rst: editorial changes (#585)
* Editorial, spelling, and formatting changes only.

Signed-off-by: DougTW <doug.martin@intel.com>

* Fixed indentation error on mixer.rst

Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-08 12:58:30 -07:00
Kevin Putnam d6c7796382 Added FAQ to sitemap and shortened FAQ title text to "FAQ." (#600)
Closes #599 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-08 11:58:36 -07:00
Beth Dean 09f3f68649 Add link to terms of use in the dlrs tutorial (#596) 2019-07-03 20:00:09 -05:00
bktan8 264001c830 q
* Retested QEMU-KVM doc. against latest Clear and 3rd-party distros.
Updated doc. to reflect any changes.

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

* Added reviewer comments.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-07-03 14:13:50 -05:00
DougTW 66778cc38b Minor editorial changes to swupd-guide.rst. (#591)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-03 13:27:36 -05:00
puneetse 1769d6eff4 Fix minor syntax on nvidia.rst (#594) 2019-07-02 17:03:28 -07:00
michael vincerra b44b744a0a Adds note to clarify BIOS behavior if installing on multiple partitions. (#582)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Rewording revisions.

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

Incorporates reviewer feedback.

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

Editorial change.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-07-02 15:46:11 -07:00
puneetse 1e29bd2f8f Add a step restart NetworkManager in static IP doc (#584)
* Update assign static IP doc to have NM instructions

* Add step to restart NetworkManager
2019-07-02 15:11:35 -07:00
puneetse 4f86b06936 Update NVIDIA documentation to isolate install even further (#586)
* Add updating section to NVIDIA  doc

* Isolate NVIDIA files under /opt and /etc even more

Adds more parameters to avoid nvidia-installer placing files under /usr and have applications use alternative paths.

* Explicitly add warning about libGL.so conflict

Add a warning about the well-know libGL conflict between mesa and NVIDIA packages.

* Update nvidia.rst
2019-07-02 14:59:46 -07:00
DougTW ea7263c429 minor editorial changes; edits complete. (#580)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-07-02 12:11:33 -07:00
puneetse a829786be6 Update assign static IP doc to have NM instructions (#574) 2019-07-01 08:55:35 -07:00