mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-09-01 19:31:48 +00:00
puneetse
2ce50349a0
* Update from upstream (#15) * Add section for kubectl to dlrs tutorial (#550) * Add section for kubectl to dlrs tutorial * Editorial clean up to Kubectl section. * Minor grammatical edits: missing punctuation and line length clean up. Signed-off-by: Kristal Dale <kristal.dale@intel.com> * Dm autospec guide editorial (#565) * Edited for syntax, spelling, trademarking, and branding. Signed-off-by: douglasm <doug.martin@intel.com> * Made editorial revisions, e.g., grammar and spelling. Signed-off-by: douglasm <doug.martin@intel.com> * changed one phrase to use active voice present tense. Reset autoproxy.rst. Signed-off-by: douglasm <doug.martin@intel.com> * Add document on debug system (#561) * Add stateless concept document (#564) * Changed ister.rst for trademarks, branding, and editorial issues. (#573) * Minor editorial revision to test multiple commits on one file. Signed-off-by: douglasm <doug.martin@intel.com> * Minor editorial revisions completes my revisions to this file. Signed-off-by: douglasm <doug.martin@intel.com> * Add a FAQ page (#547) * Add a new FAQ document * Clerical changes to faq doc Signed-off-by: MCamp859 <maryx.camp@intel.com> * Add note about AUTOINSTALL=yes in dkms.conf (#575) * Add link for launcher.py and note MKL HW reqs for DLRS tutorial. (#570) * Add link for launcher.py and note MKL HW reqs for DLRS tutorial. * Reword note about MKL, change from note to warning. Closes #560, Closes #559 * Add note specifying Kubeflow v0.4 when using launcher.py * Closes #559 , Closes #560 * Update assign static IP doc to have NM instructions (#574) * minor editorial changes; edits complete. (#580) Signed-off-by: DougTW <doug.martin@intel.com> * 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 * Add a step restart NetworkManager in static IP doc (#584) * Update assign static IP doc to have NM instructions * Add step to restart NetworkManager * 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> * Fix minor syntax on nvidia.rst (#594) * Minor editorial changes to swupd-guide.rst. (#591) Signed-off-by: DougTW <doug.martin@intel.com> * 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> * Add link to terms of use in the dlrs tutorial (#596) * Added FAQ to sitemap and shortened FAQ title text to "FAQ." (#600) Closes #599 Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * 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> * Add a note about running stack on other Linux distros (#598) * Add a note about running stack on other Linux distros * Add unistall instructions * 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> * 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> * 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> * Corrects Step 4 command to verify integrity. (#602) Signed-off-by: MCamp859 <maryx.camp@intel.com> * Add section on settign a static machine id. (#606) - Closes #558. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * 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> * 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. * 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> * Fixed cross-ref in bare-metal-install-server.rst to autoproxy (#617) Signed-off-by: DougTW <doug.martin@intel.com> * Fixed cross-ref and made minor formatting and editorial changes. (#619) Signed-off-by: DougTW <doug.martin@intel.com> * 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> * 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> * 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> * Update fmv.rst (#616) * Update fmv.rst Fix FFT typo in section header * Update fmv.rst Updates explaining that FFTW is an FFT library * Add link for terms of use. Closes #622 (#623) * Corrected trademarks use on system-requirements (#624) Closes #610 Signed-off-by: DougTW <doug.martin@intel.com> * 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> * 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> * 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> * 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> * 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 * 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> * 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> * 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> * Fixed broken link to stateless.rst. Made minor editorial and trademark/branding revisions. (#633) Signed-off-by: DougTW <doug.martin@intel.com> * Revised link to stateless.rst, formatting, and trademarks. (#634) Signed-off-by: DougTW <doug.martin@intel.com> * Revised link to stateless.rst and added trademarks. (#635) Signed-off-by: DougTW <doug.martin@intel.com> * Text edits in prep for xlation. (#640) Signed-off-by: MCamp859 <maryx.camp@intel.com> * Add documentation on resource limits * Revise Table 1 to clarify labels, filesystem, and default verbiage. (#647) Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * 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> * 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> * Revise Table 1 to clarify labels, filesystem, and default verbiage. (#646) Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * 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> * 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> * 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> * 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> * 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> * Reworded paragraph and linking text (#655) Signed-off-by: DougTW <doug.martin@intel.com> * Replaced include with ref. (#656) * Reworded paragraph and linking text. Signed-off-by: DougTW <doug.martin@intel.com> * Clean up of last 2 tooling pages in preparation for translations (#651) * Clean up in preparation for translations - Standardize use of roles (remove use of `` and * for emphasis on special words or options) - Misc clean up (opportunistic) - Move pages to tooling in prep for final organization Signed-off-by: Kristal Dale <kristal.dale@intel.com> * Fixes code-block errors; minor verbiage clean up. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Minor clean up in preparation for translation. (#652) Signed-off-by: Kristal Dale <kristal.dale@intel.com> Updated note re Software store. Signed-off-by: Kristal Dale <kristal.dale@intel.com> Adds link to download, verify, etc.; revise desktop intro for accuracy. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Minor editorial revisions. (#657) * Checked trademark/branding Signed-off-by: DougTW <doug.martin@intel.com> * mixer: Adds bullet list in format bump; adds Example 3 for editors. (#659) * Adds bullet list in format bump; adds Example 3 for editors. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Revise Editors example per reviewer feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Revise to integrate form Ex. 4 into Ex. 2. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Integrates how to edit bundle editors in Ex. 2 and Ex. 3. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Respond to feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Stacks guide cleanup for translation (#660) * Initial commit for stacks guides cleanup (prep for translation) Signed-off-by: Kristal Dale <kristal.dale@intel.com> * Basic clean up in preparation for translation - Links/wording of links - Simplify intro/overview Signed-off-by: Kristal Dale <kristal.dale@intel.com> * Escaped local URLs that were being turned into links. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * docs: Missing spaces after '.'s (#658) A `grep '\.[A-Z]'` showed up a few places where there was a space missing after a full stop. Initiall spotted reading the 'stateless' guide. A similar grep for missing spaces after commas turned up nothing. Signed-off-by: Graham Whaley <graham.whaley@intel.com> * Minor formatting changes to swupd-guide.rst (#666) Fixes #665 Signed-off-by: DougTW <doug.martin@intel.com> Fixed indents of Output. Signed-off-by: DougTW <doug.martin@intel.com> Removed trailing space. Signed-off-by: DougTW <doug.martin@intel.com> * Update resource-limits.rst Expand out commands into codeblocks as requested in review.