Compare commits

..
Author SHA1 Message Date
michael vincerra c443b3faef Create greetings.yml
Create a greetings message to show users who submit their first Issue or first PR to the repo.
2019-11-16 16:11:42 -08:00
Mary Camp 2258c90604 Fixed nesting issue. (#895)
* Fixed nesting issue.
* Fixes #888 
Editorial changes for grammar and formatting.

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

* Moved Background section, made minor text edits

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-11-15 15:34:46 -08:00
Kevin Putnam 3ec50a2cf8 Added 4 links to whitelist as they consistently report as failing but manual checks show them working. (#921)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-11-15 11:35:39 -08:00
Beth Dean dd6d5aeed2 Update URL for kfctl_k8s_istio.yaml (#920)
* Update URL for kfctl_k8s_istio.yaml

* Update URL to pull raw file for config ENV variable
2019-11-14 12:00:28 -08:00
Kevin Putnam d4cb55239f Restore Tl telem (#794) (#916)
* Tl telem (#794)

* update telemetry opt-in requirement

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>

* update telemetry docs for opt-in changes

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Update telemetry guide

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* telemetry typo and bundle name update

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Spelling correction line 186

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

* Formatting revisions:
-Removed EOL spaces
- broke lines longer than 78 characters
- re-wrapped text as needed

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

* Minor editorial changes to telemetrics.rst

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

* Fixes based on feedback.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-11-13 11:20:38 -08:00
Marcos Simental 7f61f94836 guides/clear/stateless: specify /usr/local as user owned (#912)
besides /var, /etc, /opt and /home, users are allowed to make
local installations in /usr/local without getting swupd
operations to remove such content.

be excplicit about /usr/local in the stateless guide.

Relates to https://github.com/clearlinux/distribution/issues/1475

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2019-11-13 09:37:32 -08:00
Kevin Putnam 5a66e0effe Add support for multiple column displays and cards (#906)
* Adds support for multiple columns in reStructuredText. Required for landing page redesign.

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

* Catching the branch up to master.

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

* Fixing line endings in tcs_theme.js.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-11-13 08:52:28 -08:00
bktan8 69f7314da2 Added bash console directive for the clr-boot-manager commands. (#914)
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-11-13 08:51:34 -08:00
bktan8 b3dc735a6c Doc. on how to enable systemd boot menu (#911)
* Doc. to enable systemd-boot menu.

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

* removing dual-boot-linux and multi-boot from this commit

* Update source/guides/maintenance/enable-systemd-boot-menu.rst
2019-11-12 06:09:59 +00:00
Beth Dean a1c4bf38dc Update URL for DARS repository (#893)
* Update URL for DARS repository

* Update path in command to build Docker image

* update path for dockerfile build instructions
2019-11-11 18:09:45 +00:00
David Shade 0351271a7e Update dbrs.rst (#903)
modify the Optane DCPMM configuration section to add additional clarity
2019-11-07 16:39:15 -08:00
David Shade 63cd737447 Update dbrs.rst (#902)
update to hardware configuration to remove references to DCPMM codenames
2019-11-07 16:32:03 -08:00
bktan8 23bbd6ba73 Update VNC doc. (#900)
* Update dual-boot-win with better systemd-boot screenshot.

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

* Revised VNC doc.
Minor tweaks.

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

* Correct minor formatting indentation error.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-06 21:47:55 -08:00
michael vincerra c99e596c79 Removes 1 empty space to assure proper render in dual-boot-linux. (#899)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-05 18:26:02 -08:00
bktan8 5eebaea1f6 Update dual-boot-win with better systemd-boot screenshot. (#898)
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-11-05 18:07:20 -08:00
michael vincerra d5dcf8a7a0 Add dual-boot-linux for CL with other grub-based linux distros. (#884)
* Adds dual-boot tut for CL with other grub-based linux distros.

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

* Change lowercase grub to uppercase in intro.

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

* Revise indentation levels of substeps; add new Fig. 12.

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

* Fix trailing space in command.

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

* Create additional indented ordered lists for partition config.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-05 17:59:08 -08:00
michael vincerra 32e1b94030 Correct obsolete URL for contribution guidelines. (#897)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-05 16:33:38 -08:00
Mary Camp d744224c8e Editorial changes for grammar and formatting. (#892)
* Editorial changes for grammar and formatting.

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

* Added reviewer feedback. Standardized captions.

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

* Fixes nested auto-enumerated list.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-01 16:42:21 -07:00
Kevin Putnam 4df2dfdc15 Fixes a problem where nested collapsible sections do not expand correctly. (#887)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-11-01 09:15:05 -07:00
Kevin Putnam 58cba207fa Add Wi-Fi guide (#882)
* First commit.

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

* update

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

* Added content for CLI and TUI.

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

* * Removes unused .png files
* Addresses feedback:
  1. Changed title to leave room for updates include wpa_supplicant.
  2. Minor editorial updates.
  3. Added Other resources section including links to nmcli examples and documentation.
  4. Added note recommending using the TUI if concerned with having password in bash history.

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

* Adds contextual link to bare metal desktop installer in first paragraph.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-31 09:35:19 -07:00
R Primus 9095e06aad https://github.com/clearlinux/clear-linux-documentation/issues/857: F… (#885)
* https://github.com/clearlinux/clear-linux-documentation/issues/857: Fix assorted typos

* Update for changes made since initial cloning of repository

* Fix case of word
2019-10-28 16:32:46 -07:00
Kevin Putnam 992a703fbe Fixes a problem caused by there being two ways of indicating reStructuredText code blocks: (#883)
* rst
* rest

Now both are handled gracefully.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-28 09:25:57 -07:00
Tom Leavitt fab1ad6f85 Add virt-manager getting started guide (#880)
* Add virt-manager getting started guide

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Update virt-manager.rst

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* fix link

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Fix missing downloads link

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Minor editorial changes for virt-manager

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Add header back into virt-manager

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Applies minor edits for transitions and continuity.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-25 18:31:05 -07:00
Beth Dean b3ca8be1a5 Clean up DLRS release section (#879)
* Clean up DLRS release section

* added a space after a link.
2019-10-25 09:02:28 -07:00
mns6070 7e74e7b8ca Update nvidia-cuda.rst (#878)
The installation path is set to /opt so the path to test nvcc needs to be updated.
2019-10-25 08:53:52 -07:00
michael vincerra 20af82abd8 Move Manage User to Required options; secure root in bare-metal-install-server (#874)
* Move Manage User to Required options; secure root in bare-metal-install-server.

- Align with clr-installer merged PR: https://github.com/clearlinux/clr-installer/pull/576
- Replace Figures 18-21 to reflect TUI with Admin selected by default
- Renumber all figures after 18 and reassign
- Add note to Manage User re requirement to assign Admin to proceed.

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

* test new machine settings.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-23 19:35:05 -07:00
Mary Camp 1b24b3629f Editorial changes in Hyper-v guide for grammar and formatting. (#871)
* Editorial changes for grammar and formatting.

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

* Closes #774 

* Added reviewer feedback.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-10-18 09:20:13 -07:00
Beth Dean 211e5c1bdd Add tutorial for PHP install & config (#869)
* Add tutorial for PHP install & config

* Add php-fpm configuration detail to php tutorial

* Change bundle name to httpd

* Remove httpd references from php tutorial

* Fix typos, change instructions to active verbs
2019-10-17 14:04:53 -07:00
Tom Leavitt 718e480d71 Update PXE tutorial to add client requirements (#873)
* Update PXE tutorial to add client requirements

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Additional changes to PXE tutorial

Move client requirements to the top of the prerequisite section
2019-10-17 13:17:15 -07:00
Beth Dean 46a25b42e7 Add examples for Hadoop and Kubernetes (#863)
* Add examples for Hadoop and Kubernetes

* Edits to new content in DARS for readability
2019-10-17 12:11:55 -07:00
michael vincerra 9b13de39be Update compatible version to CL-31130; replace bundles to install in dpdk (#854)
* Update compatible version to CL-31130; replace pkgs:
- Replace network-basic-dev w/ dpdk, devepkg-dpdk
- Revise instances of linuxapp to linux and other commands

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

* Resolve hyperlink error and preface to install bundles.

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

* Re-add network-basic-dev to Prereqs for bundles in dpdk.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-16 08:47:38 -07:00
puneetse 72cca8f019 Update NVIDIA drivers documentation (#850)
* Simpplify headings and download instructions

* Add note about NVIDIA Optimus systems

* Add step to symlink nvidia-settings.desktop

* Add section on brightness control
2019-10-15 17:26:49 -07:00
Beth Dean 2102b71d83 Add kubectl section for basic use case verification (#867) 2019-10-15 17:09:50 -07:00
Kristal Dale 0fcb703eeb Remove AES requirement from Sys Req doc (#859)
Remove AES requirement from the recommended minimum system requirements.
AES has been removed as a hard requirement for installation.

Closes #840

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-15 15:37:29 -07:00
BirokratskaZila deb72b741c Update index.rst (#865)
Removed white trailing space and optimized the grammar.
2019-10-15 12:17:29 -07:00
michael vincerra 1688e2241a Revert "Tl telem (#794)" (#861)
This reverts commit 1bc2804b1b.
2019-10-14 12:33:16 -07:00
puneetse a1822e21e8 Update modify container images document (#855)
* Consolidate and update examples

* Bump to 31110

* Be explicit with all docker build parameter names
2019-10-14 11:49:00 -07:00
Kevin Putnam 3fa6558b07 Adds labels for code blocks used in Clear Linux docs (#852)
* Added support for labeling code blocks. Currently supported code blocks:

* yaml
* bash
* console
* reStructuredText
* Python
* PowerShell

Handling added for re-aligning code blocks with line numbers with labels.

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

* Adds the following code block handlers:

* Diff
* C
* json
* spec
* Perl
* PHP
* xml

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-11 09:48:33 -07:00
Mary Camp c811324028 Upleveled Contribution guidelines, edited text. (#848)
* Upleveled Contribution guidelines, edited text.

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

* Simplify doc title and sub-bullets under Contrib. guidelines per standup, 10/10/19.
Closed GH-828.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-10 18:16:23 -07:00
Tom Leavitt 1bc2804b1b Tl telem (#794)
* update telemetry opt-in requirement

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>

* update telemetry docs for opt-in changes

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Update telemetry guide

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* telemetry typo and bundle name update

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Spelling correction line 186

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

* Formatting revisions:
-Removed EOL spaces
- broke lines longer than 78 characters
- re-wrapped text as needed

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

* Minor editorial changes to telemetrics.rst

Signed-off-by: DougTW <doug.martin@intel.com>
2019-10-10 13:14:48 -07:00
Beth Dean a3f72d407a Remove -version flag from os-install command (#853)
* Remove -version flag from os-install command

* Remove weird whitespace
2019-10-09 14:23:39 -07:00
michael vincerra 59c745abfd Revise bare-metal-install-desktop and -server to allow offline installation. (#851)
- -desktop: Removes Fig. 4; renumbers all subsequent Figures
- -desktop: Revises header to Select Additional Bundles and add note on network
- -server: Adds similar preface as above in Select Additional Bundles
- -server: Adds missing `_` in MOUNT point, Fig. 15.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-09 12:50:28 -07:00
Tom Leavitt 2387065e74 typo fix for :command: directive (#849)
Removed the space between the :command: and the text
2019-10-08 14:17:02 -07:00
bktan8 73e5ba9f6f Remove reference to "decompress" in bare metal installer docs. (#847)
- In Preliminary steps, remove penultimate step on verify.
- Verify integrity of image is already included in `bootable-usb`
- If `bootable-usb` is referenced in installation docs, `verify` is implied
- Edits `..-install-server` to make Prelim steps consistent with `..-install-server`

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-07 19:48:32 -07:00
Kristal Dale 265469c584 Correct example commands in autoproxy guide (#838)
* Correct example commands in autoproxy guide

- Fix example commands that were split into two snippets (should be one)
- Spelling corrections and minor edits for readability

Fixes #795

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

* Minor edits to improve clarity with
 output samples.

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

* Add sudo to commands that require it.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-07 15:50:32 -07:00
Kevin Putnam 3bbc77a187 Removes Previous/Next buttons on each page of docs. (#846)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-07 11:45:04 -07:00
Kristal Dale 6e7c909fef Update 400 http error pages (#844)
- Update paths to search and image to be absolute URLs
- Correct typo in CSS

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-07 09:34:54 -07:00
michael vincerra b2e82fe887 Revises scale of figures for better UI XP in dual-boot-win. (#845)
Resizes Fig. 2 for consistency.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-07 09:33:34 -07:00
michael vincerra eb5c874627 Adds CL with Windows OS in new dual-boot tutorial & multi-boot index. (#820)
- Adds more details, explanation to Method 1; adds 2 figures.
- Update to using Windows 10 OS throughout
- Add Fig. 3
- Update source/tutorials/multi-boot/multi-boot.rst
- Incorporate Advanced section -- in progress.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-04 18:05:35 -07:00
bktan8 cace98df58 Updated bootable USB Linux per https://github.com/clearlinux/clear-li… (#842)
* Updated bootable USB Linux per https://github.com/clearlinux/clear-linux-documentation/issues/796.
Also minor updated the macOS and Windows as well.

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

* Applies editorial corrections only.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-04 17:38:26 -07:00
Kevin Putnam 29d9bd2233 Fixed broken link to dev mailing list. (#843)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-04 15:03:45 -07:00
puneetse 7030b996e9 Add a new document for firewall options (#639) 2019-10-04 11:22:49 -07:00
Kevin Putnam 0df6c38203 * Adds ability to create code blocks with prepended "$" that won't be copied (wip). (#837)
* Fixes behavior and appearance of permalinks in collapsible sections.
* Fixes links to collapsible sections so that header is now target.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-04 11:12:11 -07:00
Mary Camp fbfe5f43c6 New doc: create custom application container image (#775)
- Add CLI steps to contextualize diff output.
- Add Sphinx roles for clarity of command flags.
- Apply edits for clarity of sequence and prior to output diffs.

<michael.vincerra@intel.com>
2019-10-04 10:46:53 -07:00
Kristal Dale d4529b126b Add custom 404 and 403 pages. (#841)
- Added static html pages for 404 and 403 server responses.
- Added conf.py setting html_extra_path to copy static _errors folder
  with static 404/403 files into build output

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-04 09:38:41 -07:00
puneetse 2f0a056995 Add document on firmware (#824)
Adds a new document on firmware laoding and a reference to it from the stateless document.
2019-10-03 07:36:40 -07:00
michael vincerra 8c588b9ac2 Apply wording corrections to to bootable-usb. (#839)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-02 18:19:50 -07:00
Sergey Ponomarev 36c8cf81da bootable-usb.rst small improvement (#833)
* Added a note to keep label as `CLR_ISO`

* UDB drive size requirements: make them lower
2019-10-02 18:04:08 -07:00
michael vincerra 6cc03629a3 Remove title case for sample application and fix typo, OpenVINO. (#836)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-02 16:03:05 -07:00
michael vincerra a4b24d7f86 Adds OpenVINO tutorial with image classification app and benchmark app. (#830)
- Add example of automobile in Run image classification.
2019-10-02 14:42:47 -07:00
Kevin Putnam d671e584aa Adds youTube video tutorial for autospec to guide page. (#835)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-02 13:40:06 -07:00
DougTW fc972821c1 bootable-usb.rst: Editorial changes (#832)
Signed-off-by: DougTW <doug.martin@intel.com>
2019-09-30 22:33:43 +02:00
140 changed files with 4354 additions and 972 deletions
+13
View File
@@ -0,0 +1,13 @@
name: Greetings
on: [pull_request, issues]
jobs:
greeting:
runs-on: ubuntu-latest
steps:
- uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: 'Welcome to Clear Linux OS Docs. Thanks for submitting your first issue. :thumbsup:'
pr-message: 'Welcome to Clear Linux OS Docs. Thanks for submitting your first PR. :thumbsup:'
+2 -2
View File
@@ -65,7 +65,7 @@ to view the rendered documentation.
If you want to build the documentation exactly as seen on the website, use
``make py`` followed by ``make htmlall``. This builds some
external dependenices and all supported languages.
external dependencies and all supported languages.
Additional help
***************
@@ -98,6 +98,6 @@ To stop the web server simply use ``ctrl-c``.
.. _Clear Linux\* OS documentation: https://docs.01.org/clearlinux/
.. _Sphinx: http://sphinx-doc.org/
.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _contribution guidelines: https://clearlinux.org/documentation/clear-linux/reference/collaboration
.. _contribution guidelines: https://docs.01.org/clearlinux/latest/collaboration/collaboration.html
.. _instructions for installing Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html
+3 -3
View File
@@ -16,7 +16,7 @@ Why did you make another distro?
================================
The |CL| team felt that performance was left on the table with Linux software.
|CL| takes a holistic approach to improving performance across the stack. We
|CL| takes a holistic approach to improve performance across the stack. We
also wanted to take more modern approaches with OS updates and tooling.
|
@@ -31,7 +31,7 @@ Yes, we absolutely love open source reuse and upstreaming improvements.
How often do you update?
========================
The |CL| team puts out multiple releases a week, often releasing 2 or more
The |CL| team puts out multiple releases a week, often releasing two or more
times a day. This rolling release approach allows |CL| to remain agile to
upstream changes and security patches.
@@ -137,7 +137,7 @@ Is Microsoft\* Visual Studio Code\* available?
Yes. Find the CLI command for installing `VS Code`_ and other Flatpak apps in
the `software store`_. Installing Flatpak apps is also covered in our
:ref:`tutorial <flatpak-tutorial>`.
:ref:`tutorial <flatpak-tutorial>`.
The |CL| team is working on a natively packaged version of Visual Studio Code
for future release.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 105 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 93 KiB

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 195 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 195 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 396 KiB

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 212 KiB

+79
View File
@@ -0,0 +1,79 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Page Not Found</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<script async="" src="https://www.google-analytics.com/analytics.js"></script><script>(function(i,s,o,g,r,a,m){i["GoogleAnalyticsObject"]=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,"script","https://www.google-analytics.com/analytics.js","ga");ga("create", "UA-61272224-1", {"cookieDomain":"auto","allowLinker":true});ga("require", "linker");ga("linker:autoLink", [/(community\.|www\.|^)clearlinux\.org/gi], true);ga("set", "anonymizeIp", true);ga("send", "pageview");</script>
<style>
* {
line-height: 1.2;
margin: 0;
}
html {
color: #404040;
display: table;
font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;
height: 100%;
text-align: center;
width: 100%;
background: #fcfcfc;
}
body {
display: table-cell;
vertical-align: middle;
margin: 2em auto;
}
h1 {
color: #555;
font-size: 2em;
font-weight: 400;
margin-bottom: 1em;
}
p {
margin: 1em auto;
}
input {
padding: .3em .5em;
font-size: 1em;
background-color: #fff;
}
@media only screen and (max-width: 280px) {
body, p {
width: 95%;
}
h1 {
font-size: 1.5em;
margin: 0 0 0.3em;
}
}
</style>
</head>
<body>
<img src="https://docs.01.org/clearlinux/latest/_static/clearlinux.png" class="logo" alt="Logo">
<h1>403 Forbidden</h1>
<p>Sorry, looks like you don't have permission to access this page.</p>
<p>Please go back to the <a href="https://docs.01.org/clearlinux">documentation home page</a> or try searching:</p>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="https://docs.01.org/clearlinux/latest/search.html" method="get">
<input type="text" name="q" id="clear-docs-search" placeholder="Search documentation" results="0">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
</div>
</body>
</html>
+79
View File
@@ -0,0 +1,79 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Page Not Found</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<script async="" src="https://www.google-analytics.com/analytics.js"></script><script>(function(i,s,o,g,r,a,m){i["GoogleAnalyticsObject"]=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,"script","https://www.google-analytics.com/analytics.js","ga");ga("create", "UA-61272224-1", {"cookieDomain":"auto","allowLinker":true});ga("require", "linker");ga("linker:autoLink", [/(community\.|www\.|^)clearlinux\.org/gi], true);ga("set", "anonymizeIp", true);ga("send", "pageview");</script>
<style>
* {
line-height: 1.2;
margin: 0;
}
html {
color: #404040;
display: table;
font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;
height: 100%;
text-align: center;
width: 100%;
background: #fcfcfc;
}
body {
display: table-cell;
vertical-align: middle;
margin: 2em auto;
}
h1 {
color: #555;
font-size: 2em;
font-weight: 400;
margin-bottom: 1em;
}
p {
margin: 1em auto;
}
input {
padding: .3em .5em;
font-size: 1em;
background-color: #fff;
}
@media only screen and (max-width: 280px) {
body, p {
width: 95%;
}
h1 {
font-size: 1.5em;
margin: 0 0 0.3em;
}
}
</style>
</head>
<body>
<img src="https://docs.01.org/clearlinux/latest/_static/clearlinux.png" class="logo" alt="Logo">
<h1>404 Not Found</h1>
<p>Sorry, we didn't find the page you're looking for.</p>
<p>Please go back to the <a href="https://docs.01.org/clearlinux">documentation home page</a> or try searching:</p>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="https://docs.01.org/clearlinux/latest/search.html" method="get">
<input type="text" name="q" id="clear-docs-search" placeholder="Search documentation" results="0">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
</div>
</body>
</html>
@@ -12,4 +12,8 @@ https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html
http://www.intel.com/content/www/us/en/nuc/nuc-kit-nuc6i5syh.html
https://software.intel.com/en-us/mkl
https://www.intel.com/content/www/us/en/architecture-and-technology/turbo-boost/turbo-boost-technology.html
https://www.nvidia.com/download/index.aspx
https://www.nvidia.com/download/index.aspx
https://www.intel.com/content/www/us/en/architecture-and-technology/optane-technology/optane-for-data-centers.html
https://downloadcenter.intel.com/download/28695/Intel-Server-Board-S2600WF-Family-BIOS-and-Firmware-Update-Package-for-UEFI
https://software.intel.com/en-us/articles/quick-start-guide-configure-intel-optane-dc-persistent-memory-on-linux
https://software.intel.com/en-us/articles/configure-manage-and-profile-intel-optane-dc-persistent-memory-modules
@@ -119,6 +119,8 @@ th,td {
padding-left: 0 !important;
}
/*Begin support for collapsbile sections*/
.clps1 {
font-size: 175%;
}
@@ -173,9 +175,29 @@ th,td {
.content-collapse {
overflow: hidden;
transition: max-height 0.2s ease-out;
/*transition: max-height 0.2s ease-out;*//*removed as it was breaking nested collapsible sections*/
}
/*Fix for permalinks to collapsible sections*/
button a.headerlink {
visibility: hidden;
}
button a.headerlink:after {
content: "\f0c1";
font-size: 14px;
font-family: FontAwesome;
font-weight: normal;
}
button:hover a.headerlink:after {
visibility: visible;
}
/*End support for collapsbile sections*/
/*Begin support for custom Clear Linux header*/
#header {
width: 100%;
display: block;
@@ -278,6 +300,8 @@ th,td {
line-height: 100px;
}
/*End support for custom Clear Linux header*/
/*Adds a bit of spacing after the last paragraph in a bulleted list*/
.wy-plain-list-disc li p:last-child, .rst-content .section ul li p:last-child, .rst-content .toctree-wrapper ul li p:last-child, article ul li p:last-child {
margin-bottom: 10px;
@@ -291,7 +315,7 @@ div#trademarks {
color: gray;
}
/*Adds magnifying glass to search box*/
#clear-docs-search {
background: url(./mag-glass.png) left no-repeat;
background-size: 15px 15px;
@@ -312,3 +336,187 @@ div#trademarks {
.pending-delete-status {
color:#ce2029;
}
/*Begin support for code blocks with $ signs that aren't copied with content*/
.bash-dollar:before {
content: '$ ';
}
/*End support for code blocks with $ signs that aren't copied with content*/
/*Begin support for labeled code-blocks - need to add an entry for every type of code-block that needs to be labeled*/
div.highlight-powershell .highlight:before{
background: #909090;
color: white;
content: " PowerShell ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-python .highlight:before{
background: #909090;
color: white;
content: " Python ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-console .highlight:before{
background: #909090;
color: white;
content: " Console ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-rst .highlight:before{
background: #909090;
color: white;
content: " reStructuredText ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-rest .highlight:before{
background: #909090;
color: white;
content: " reStructuredText ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-yaml .highlight:before{
background: #909090;
color: white;
content: " yaml ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-bash .highlight:before{
background: #909090;
color: white;
content: " bash ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-diff .highlight:before{
background: #909090;
color: white;
content: " Diff ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-c .highlight:before{
background: #909090;
color: white;
content: " c ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-json .highlight:before{
background: #909090;
color: white;
content: " json ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-spec .highlight:before{
background: #909090;
color: white;
content: " spec ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-perl .highlight:before{
background: #909090;
color: white;
content: " Perl ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-php .highlight:before{
background: #909090;
color: white;
content: " php ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.highlight-xml .highlight:before{
background: #909090;
color: white;
content: " xml ";
font-family: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;
font-size: 14px;
white-space: pre;
}
div.linenodiv:before { /*add extra new line to make sure code and line numbers align*/
content: '\00000a';
white-space: pre;
}
/*End support for labeled code-blocks*/
/*Begin support for multi-column sections*/
.column {
float: left;
width: 350px;
padding: 10px;
margin: 10px;
border: 10px;
background: white;
}
.column.featurecard {
background: #CCE9F5;
}
.column.verticalcard {
height: 615px;
overflow: auto;
}
/* Clear floats after the columns */
.multicolumns:after {
content: "";
display: table;
clear: both;
}
.colh2 {
font-size: 150%;
font-weight: 700;
font-family: "Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;
}
.video.docutils.container {
margin: 10px;
width:720px;
height:405px;
}
/*End support for multi-column sections*/
@@ -1,50 +1,76 @@
var i;
var contents = document.getElementsByClassName("content-collapse section");
for (i = 0; i < contents.length; i++) {
//Make sure the "content-collapse section" class is occurring in <div>
if (contents[i].tagName.toLowerCase() == 'div') {
var element = contents[i].children[0];
var element_type = element.tagName.toLowerCase();
var span_id;
var spanElement;
//if the next element is a span grab the id and skip to the header
if (element_type == 'span') {
span_id = element.id;
element.id = "";
element = contents[i].children[1];
element_type = element.tagName.toLowerCase();
}
var btn = document.createElement("BUTTON");
//If it is a header capture which level and pass on to button
if (element_type.length == 2 && element_type[0] == 'h') {
var newClass = 'clps' + element_type[1];
//collapses the section by default only if javascript is working
contents[i].style.maxHeight = 0;
//Build the button and define behavior
btn.className += " " + newClass;
btn.innerHTML = element.innerHTML;
btn.className += " collapsible";
btn.id = span_id;
btn.addEventListener("click", function() {
this.classList.toggle("active");
var content = this.nextElementSibling;
if (content.style.maxHeight != "0px"){
content.style.maxHeight = 0;
} else {
content.style.maxHeight = content.scrollHeight + "px";
}
});
//Add the button to the page and remove the header
contents[i].parentNode.insertBefore(btn, contents[i]);
contents[i].removeChild(element);
}else{
//reset span id if it isn't followed by Hx element
spanElement.id = span_id;
}
}
}
var i;
var contents = document.getElementsByClassName("content-collapse section");
var bashDollarDivs = document.getElementsByClassName("bash-dollars highlight-bash");
for (i = 0; i< bashDollarDivs.length; i++) {
_pre = bashDollarDivs[i].querySelectorAll("pre");
for (j = 0; j < _pre.length; j++) {
console.log(_pre[j]);
_pre[j].innerHTML="<span class='bash-dollar'>"+(_pre[j].textContent.split("\n").filter(Boolean).join("</span>\n<span class='bash-dollar'>"))+"</span>";
}
}
//needed for nested collapsible sections - otherwise the top container
//won't resize after expanding a child.
function resetActiveCollapsedSections() {
var sections = document.getElementsByClassName("content-collapse section");
//for (i = 0; i < sections.length; i++) {
for (i = sections.length -1; i >= 0; i-- ){
if (sections[i].style.maxHeight != "0px"){
sections[i].style.maxHeight = sections[i].scrollHeight + "px";
}
}
}
for (i = 0; i < contents.length; i++) {
//Make sure the "content-collapse section" class is occurring in <div>
if (contents[i].tagName.toLowerCase() == 'div') {
var element = contents[i].children[0];
var element_type = element.tagName.toLowerCase();
var btn_id;
var divElement;
divElement = contents[i];
btn_id = contents[i].id;
//if the next element is a span skip to the header
if (element_type == 'span') {
element = contents[i].children[1];
element_type = element.tagName.toLowerCase();
} else {
divElement.id = "";
}
var btn = document.createElement("BUTTON");
//If it is a header capture which level and pass on to button
if (element_type.length == 2 && element_type[0] == 'h') {
var newClass = 'clps' + element_type[1];
//collapses the section by default only if javascript is working
contents[i].style.maxHeight = 0;
//Build the button and define behavior
btn.className += " " + newClass;
btn.innerHTML = element.innerHTML;
btn.className += " collapsible";
btn.id = btn_id;
btn.addEventListener("click", function() {
this.classList.toggle("active");
var content = this.nextElementSibling;
if (content.style.maxHeight != "0px"){
content.style.maxHeight = 0;
} else {
content.style.maxHeight = content.scrollHeight + "px";
}
resetActiveCollapsedSections(); //reset the size of parent containers
});
//Add the button to the page and remove the header
contents[i].parentNode.insertBefore(btn, contents[i]);
contents[i].removeChild(element);
}
}
}
+1 -1
View File
@@ -44,7 +44,7 @@ Ease of Use
environments without needing to be configured.
* Being :ref:`stateless` means that configuration settings are easier to manage
and remain untouched when system sofware is updated.
and remain untouched when system software is updated.
* :ref:`swupd-guide` simplifies managing software and maintaining compatibility.
+74
View File
@@ -0,0 +1,74 @@
.. _collaboration:
Contribute
##########
There are multiple ways to help improve our documentation:
* `Contribute via GitHub`_: Submit pull requests in the GitHub\* documentation
repository.
* `Log an issue`_: Enter an issue in the documentation repository for
minor issues such as typos.
* `Make a suggestion`_: Send your documentation suggestion to the mailing list.
* Test documentation: Step through our guides and tutorials to verify the
instructions. `Log an issue`_ or `submit a pull request`_ with your findings.
All contributions must follow our `code of conduct`_.
Contribute via GitHub
*********************
Our documentation is hosted in GitHub and we follow the standard `GitHub flow`_.
Here are the basic steps for contributing:
#. Clone the `documentation repository`_.
#. Create your own fork of the repository.
#. Create a branch for your contribution.
#. Add your commits.
#. Open a pull request.
#. Discuss, review, and update your contributions.
#. Once the maintainer approves, your contribution is merged and published as
part of the documentation.
Contribution guidelines
***********************
The |CL| documentation is written using reStructuredText. Use our guidelines
and best practices to write consistent, readable documentation.
.. toctree::
:maxdepth: 1
Writing guide <writing-guide>
Structure and formatting guide <structure-formatting>
.. _references:
References
**********
We use the following references for grammar, style, and formatting:
* `Microsoft Writing Style Guide`_
* `Merriam-Webster Dictionary`_
* The Chicago Manual of Style (15th edition), The University of Chicago Press
* Microsoft Press Computer Dictionary, Microsoft Press
* Read Me First!, Oracle Technical Publications
.. _`code of conduct`: https://clearlinux.org/community/code-of-conduct
.. _Make a suggestion: https://lists.clearlinux.org/postorius/lists/dev.lists.clearlinux.org/
.. _GitHub flow: https://guides.github.com/introduction/flow/
.. _Log an issue: https://github.com/clearlinux/clear-linux-documentation/issues
.. _Contribute via GitHub: https://github.com/clearlinux/clear-linux-documentation
.. _submit a pull request: https://github.com/clearlinux/clear-linux-documentation
.. _documentation repository: https://github.com/clearlinux/clear-linux-documentation
.. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/
.. _Merriam-Webster Dictionary: https://www.merriam-webster.com/
@@ -55,7 +55,7 @@ For example, the :ref:`collaboration` page toctree looks like:
Additionally, each page must include a uniquely named reST label directly before
the page title, to enable the `Sphinx ref role`_ for linking to a page.
For example, this page "Structure and formating" has the label
For example, this page "Structure and formatting" has the label
``.. _structure-formatting``:
.. code-block:: rest
@@ -18,7 +18,7 @@ Use simple English
Write using simple English: Be brief and communicate only the information that
is needed. Be friendly and informative. Emphasize clarity and avoid
unecessary complicated or technical terms. Make the content accessible to
unnecessary complicated or technical terms. Make the content accessible to
non-native speakers.
Be brief
@@ -93,7 +93,7 @@ what they need quickly, and to understand the information more efficiently.
document first, and organize supporting information towards the end of the
page.
* **Write scannable headings.** Expect readers of documentation to skim and scan
the content, and to leave if they dont find what they need quickly. Good
the content, and to leave if they don't find what they need quickly. Good
headings add organization to your content and help the reader to find and
understand content more effectively. Follow our guidelines for writing
effective `Headings`_.
+2 -1
View File
@@ -132,6 +132,7 @@ html_theme_options = {
'navigation_depth': 4,
'display_version': False,
'collapse_navigation': False,
'prev_next_buttons_location': 'None',
'sticky_navigation': True
}
@@ -178,7 +179,7 @@ html_favicon = '_images/favicon.ico'
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
html_extra_path = ['_html_extra']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@@ -19,6 +19,8 @@ installation:
* :ref:`system-requirements`
* :ref:`compatibility-check`
.. _preliminary-steps-install-desktop:
Preliminary steps
*****************
@@ -31,13 +33,8 @@ Preliminary steps
<release-number> is the latest |CL| auto-numbered release.
#. Verify and decompress the file per your OS.
* :ref:`download-verify-decompress`
#. Follow your OS instructions to create a bootable USB drive.
* :ref:`bootable-usb`
#. Follow your OS instructions to
:ref:`create a bootable usb drive <bootable-usb>`.
.. _install-on-target-start:
@@ -61,6 +58,8 @@ these steps.
#. Reboot the target system.
.. _preliminary-steps-install-desktop-end:
#. Select :guilabel:`Clear Linux OS` in the boot menu, shown in Figure 1.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-01.png
@@ -111,20 +110,6 @@ Launch the |CL| installer
#. Select :guilabel:`Next`.
Checking prerequisites
======================
The installer automatically launches :guilabel:`Checking Prerequisites`,
which checks your target system for compatibility and network connectivity.
After the installer shows `Prerequisites passed`, select :guilabel:`Next` to
proceed with installation.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-04.png
:scale: 100%
:alt: Checking Prerequisites
Figure 4: Checking Prerequisites
Network Proxy (optional)
------------------------
@@ -165,16 +150,16 @@ To fulfill minimum installation requirements, complete the
|CL| Desktop Installer
**********************
The |CL| Desktop Installer Main Menu appears as shown in Figure 5. To meet
The |CL| Desktop Installer Main Menu appears as shown in Figure 4. To meet
the minimum requirements, enter values in all submenus for the
:guilabel:`Required options`. After you complete them, your selections appear
below submenus and a check mark appears at right.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-05.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-04.png
:scale: 100%
:alt: Clear Linux OS Desktop Installer - Main Menu
Figure 5: Clear Linux OS Desktop Installer - Main Menu
Figure 4: Clear Linux OS Desktop Installer - Main Menu
Navigation
**********
@@ -203,11 +188,11 @@ Select Time Zone
#. Select :guilabel:`Confirm`.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-06.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-05.png
:scale: 100%
:alt: Select System Timezone
Figure 6: Select System Time Zone
Figure 5: Select System Time Zone
Select Keyboard
===============
@@ -219,11 +204,11 @@ Select Keyboard
#. Select :guilabel:`Confirm`.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-07.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-06.png
:scale: 100%
:alt: Select Keyboard menu
Figure 7: Select Keyboard menu
Figure 6: Select Keyboard menu
Select Installation Media
=========================
@@ -233,11 +218,11 @@ Select Installation Media
#. Choose an installation method: `Safe Installation`_ or
`Destructive Installation`_.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-08.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-07.png
:scale: 100%
:alt: Select Installation Media
Figure 8: Select Installation Media
Figure 7: Select Installation Media
Safe Installation
-----------------
@@ -268,21 +253,21 @@ For greater security, disk encryption is supported using LUKS. Encryption is
optional.
#. To encrypt the root partition, select :guilabel:`Enable Encryption`,
as shown in Figure 9.
as shown in Figure 8.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-09.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-08.png
:scale: 100%
:alt: Enable Encryption
Figure 9: Enable Encryption
Figure 8: Enable Encryption
#. When :guilabel:`Encryption Passphrase` appears, enter a passphrase.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-10.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-09.png
:scale: 100%
:alt: Encryption Passphrase
Figure 10: Encryption Passphrase
Figure 9: Encryption Passphrase
.. note::
@@ -310,22 +295,22 @@ Our example uses the `Default partition schema`_. The space you allocate for
#. Select :guilabel:`Partition Media`, shown in Figure 11.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-11.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-10.png
:scale: 100%
:alt: Advanced Installation
Figure 11: Advanced Installation
Figure 10: Advanced Installation
boot partition
--------------
#. Select the available target media shown as `unallocated`.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-12.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-11.png
:scale: 100%
:alt: Advanced Disk Partitioning
Figure 12: Advanced Disk Partitioning
Figure 11: Advanced Disk Partitioning
#. Choose :menuselection:`Device --> Create Partition Table`.
@@ -341,18 +326,18 @@ boot partition
The `/boot` partition must be `VFAT(FAT32)`.
#. In :guilabel:`Create new Partition`, complete the following fields to
match Figure 13. Don't change other default values.
match Figure 12. Don't change other default values.
* :guilabel:`New size:` 150
* :guilabel:`Partition name:` CLR_BOOT
* :guilabel:`File system:` fat32
* :guilabel:`Label:` boot
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-13.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-12.png
:scale: 100%
:alt: boot partition
Figure 13: boot partition
Figure 12: boot partition
#. Select :guilabel:`Add`.
@@ -363,18 +348,18 @@ swap partition
:menuselection:`Partition --> New`.
#. In :guilabel:`Create new Partition`, complete the following fields to
match Figure 14. Don't change other default values.
match Figure 13. Don't change other default values.
* :guilabel:`New size:` 256
* :guilabel:`Partition name:` CLR_SWAP
* :guilabel:`File system:` linux-swap
* :guilabel:`Label:` swap
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-14.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-13.png
:scale: 100%
:alt: swap partition
Figure 14: swap partition
Figure 13: swap partition
#. Select :guilabel:`Add`.
@@ -385,7 +370,7 @@ root partition
:menuselection:`Partition --> New`.
#. In :guilabel:`Create new Partition`, complete the following fields to
match Figure 15. Don't change other default values.
match Figure 14. Don't change other default values.
#. In :guilabel:`New size`, enter the desired size, or leave as is
to accept the *default: remaining size*.
@@ -395,20 +380,20 @@ root partition
* :guilabel:`File system:` ext[234] or XFS
* :guilabel:`Label:` root
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-15.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-14.png
:scale: 100%
:alt: root partition
Figure 15: root partition
Figure 14: root partition
#. After all partitions are defined, verify your partition
configuration is similar to Figure 16.
configuration is similar to Figure 15.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-16.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-15.png
:scale: 100%
:alt: Final partition configuration
Figure 16: Final partition configuration
Figure 15: Final partition configuration
#. Select :menuselection:`Edit --> Apply All Operations`.
@@ -431,11 +416,11 @@ Manage User
#. In :guilabel:`User Name`, enter a user name.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-17.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-16.png
:scale: 100%
:alt: Manage User
Figure 17: Manage User
Figure 16: Manage User
#. In :guilabel:`Login`, create a login name. It must start with a letter
and can use numbers, hyphens, and underscores. Maximum length is 31
@@ -485,11 +470,11 @@ team for improvements.
#. Select :kbd:`Yes`.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-18.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-17.png
:scale: 100%
:alt: Enable Telemetry
Figure 18: Enable Telemetry
Figure 17: Enable Telemetry
#. If you don't wish to participate, select :kbd:`No`.
@@ -505,28 +490,31 @@ after reboot.
You can always add more bundles later with :ref:`swupd-guide`.
Bundle Selection
================
Select Additional Bundles
=========================
#. On the Advanced menu, select :guilabel:`Bundle Selection`
This option is only available with a valid network connection.
Bundle selection is disabled if no network connection exists.
#. On the Advanced menu, select :guilabel:`Select Additional Bundles`.
#. Select your desired bundles.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-19.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-18.png
:scale: 100%
:alt: Bundle Selection
Figure 19: Bundle Selection
Figure 18: Bundle Selection
#. Select :kbd:`Confirm`.
#. View the bundles that you selected.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-20.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-19.png
:scale: 100%
:alt: Bundle Selections - Advanced Options
:alt: Select Additional Bundles
Figure 20: Bundle Selections - Advanced Options
Figure 19: Select Additional Bundles
Optional: Skip to `Finish installation`_.
@@ -537,11 +525,11 @@ Assign Hostname
#. In :guilabel:`Hostname`, enter the hostname only (excluding the domain).
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-21.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-20.png
:scale: 100%
:alt: Assign Hostname
Figure 21: Assign Hostname
Figure 20: Assign Hostname
.. note::
@@ -559,11 +547,11 @@ Kernel Configuration
#. In :guilabel:`Kernel Configuration`, navigate to select your desired
kernel. :guilabel:`Native` is selected by default.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-22.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-21.png
:scale: 100%
:alt: Kernel Configuration
Figure 22: Kernel Configuration
Figure 21: Kernel Configuration
#. To add arguments, enter the argument in :guilabel:`Add Extra Arguments`.
@@ -582,11 +570,11 @@ Software Updater Configuration
#. :guilabel:`Enable Auto Updates` is selected by default. If you **do not**
wish to enable automatic software updates, uncheck the box.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-23.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-22.png
:scale: 100%
:alt: Software Updater Configuration
Figure 23: Software Updater Configuration
Figure 22: Software Updater Configuration
#. Select :kbd:`Confirm`.
@@ -596,11 +584,11 @@ Finish installation
#. When you are satisfied with your installation configuration, select
:guilabel:`Install`.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-24.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-23.png
:scale: 100%
:alt: Assign Hostname
Figure 24: Finish installation
Figure 23: Finish installation
.. note:
@@ -609,13 +597,13 @@ Finish installation
#. If you do not enter a selection for all :guilabel:`Required Options`,
the :guilabel:`Install` button remains disabled, as shown
in Figure 25. Return to `Required Options`_ and make selections.
in Figure 24. Return to `Required Options`_ and make selections.
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-25.png
.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-24.png
:scale: 100%
:alt: Required Options - Incomplete
Figure 25: Required Options - Incomplete
Figure 24: Required Options - Incomplete
#. After installation is complete, select :guilabel:`Exit`.
+124 -126
View File
@@ -22,16 +22,17 @@ installation:
Download the latest |CL| live server image
******************************************
Get the latest |CL| installer image from the `Downloads`_ page. Look for the
:file:`clear-[version number]-live-server.iso` file.
#. Visit our `Downloads`_ page.
#. Verify and decompress the file per your OS.
#. Download the file :file:`clear-<release number>-live-server.iso`,
also called the |CL| Server.
* :ref:`download-verify-decompress`
.. note::
#. Follow your OS instructions to create a bootable USB drive.
<release-number> is the latest |CL| auto-numbered release.
* :ref:`bootable-usb`
#. Follow your OS instructions to
:ref:`create a bootable usb drive <bootable-usb>`.
Install |CL| on your target system
**********************************
@@ -467,6 +468,99 @@ be configured post-installation using the ``cryptsetup`` tool.
:guilabel:`Confirm` is only highlighted if passphrases match.
Manage User
===========
Add New User
------------
#. In Required Options, select :guilabel:`Manage User`.
#. Select :guilabel:`Add New User` as shown in Figure 18.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-18.png
:scale: 100%
:alt: Add New User, User Name
Figure 18: Add New User
#. Optional: Enter a :guilabel:`User Name`.
.. note:
The User Name must be alphanumeric and can include spaces, commas, underscores or hyphens. Maximum length is 64 characters.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-19.png
:scale: 100%
:alt: User Name
Figure 19: User Name
#. Enter a :guilabel:`Login`.
.. note::
The User Login must be alphanumeric and can include hyphens and underscores. Maximum length is 31 characters.
#. Enter a :guilabel:`Password`.
.. note:
Minimum length is 8 characters. Maximum length is 255 characters.
#. In :guilabel:`Confirm`, enter the same password.
#. The :guilabel:`Administrator` checkbox is selected by default.
.. note::
Selecting Administrator enables sudo privileges for the user. For the installation to proceed, at least one user must be assigned as an Administrator.
#. Select :kbd:`Confirm`. To reset the form, select :guilabel:`Reset`.
#. In :guilabel:`Manage User`, navigate to :guilabel:`Confirm`.
#. With :guilabel:`Confirm` highlighted, select :kbd:`Enter`.
Modify / Delete User
--------------------
#. In :guilabel:`Manage User`, navigate to the user you wish
to modify until highlighted, as shown in Figure 20.
#. Select :kbd:`Enter` to modify the user.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-20.png
:scale: 100%
:alt: Modify User
Figure 20: Modify User
#. Modify user details as desired.
#. Navigate to :kbd:`Confirm` until highlighted.
.. note::
Optional: Select :guilabel:`Reset` to rest the form.
#. Select :guilabel:`Confirm` to save the changes you made.
#. Optional: In :guilabel:`Modify User`, to delete the user, navigate to
the :guilabel:`Delete` button and select :kbd:`Enter`.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-21.png
:scale: 100%
:alt: Delete User
Figure 21: Delete User
You are returned to :guilabel:`Manage User`.
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :guilabel:`Enter` to complete :guilabel:`Manage User` options.
Telemetry
=========
@@ -482,19 +576,18 @@ Select your desired option on whether to participate in telemetry.
#. Select :kbd:`Enter` to confirm.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-18.png
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-22.png
:scale: 100%
:alt: Enable Telemetry
Figure 18: Enable Telemetry
Figure 22: Enable Telemetry
Recommended options
*******************
After you complete the `Required options`_, we highly recommend completing
these selected `Advanced options`_ at minimum:
some `Advanced options`_:
* `Manage User`_ Assign a new user with administrative rights
* `Assign Hostname`_ Simplify your development environment
Skip to finish installation
@@ -532,22 +625,22 @@ interface settings are automatically applied.
.. note:: Multiple network interfaces may appear.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-19.png
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-23.png
:scale: 100%
:alt: Configure Network Interfaces
Figure 19: Configure Network Interfaces
Figure 23: Configure Network Interfaces
#. Notice :guilabel:`Automatic / dhcp` is selected by default (at bottom).
Optional: Navigate to the checkbox :guilabel:`Automatic / dhcp` and select
:kbd:`Spacebar` to deselect.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-20.png
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-24.png
:scale: 100%
:alt: Network interface configuration
Figure 20: Network interface configuration
Figure 24: Network interface configuration
#. Navigate to the appropriate fields and assign the desired
network configuration.
@@ -583,11 +676,11 @@ instruction.
#. Navigate to the field :guilabel:`HTTPS Proxy`.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-21.png
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-25.png
:scale: 100%
:alt: Configure the network proxy
Figure 21: Configure the network proxy
Figure 25: Configure the network proxy
#. Enter the desired proxy address and port using conventional syntax,
such as: \http://address:port.
@@ -605,13 +698,16 @@ Test Network Settings
To manually assure network connectivity before installing |CL|,
select :guilabel:`Test Network Settings` and select :guilabel:`Enter`.
A progress bar appears as shown in Figure 22.
.. note::
If using the :command:`off-line installer`, this option is not available.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-22.png
A progress bar appears as shown in Figure 26.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-26.png
:scale: 100%
:alt: Testing Networking dialog
Figure 22: Testing Networking dialog
Figure 26: Testing Networking dialog
.. note::
@@ -620,20 +716,23 @@ A progress bar appears as shown in Figure 22.
Optional: Skip to `Finish installation`_.
Bundle Selection
================
Select Additional Bundles
=========================
#. On the Advanced menu, select :guilabel:`Bundle Selection`
This option is only available with a valid network connection.
Bundle selection is disabled if no network connection exists.
#. On the Advanced menu, select :guilabel:`Select Additional Bundles`.
#. Navigate to the desired bundle using :kbd:`Tab` or :kbd:`Up/Down` arrows.
#. Select :kbd:`Spacebar` to select the checkbox for each desired bundle.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-23.png
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-27.png
:scale: 100%
:alt: Bundle Selection
Figure 23: Bundle Selection
Figure 27: Bundle Selection
#. Optional: To start developing with |CL|, we recommend
adding :file:`os-clr-on-clr`.
@@ -644,107 +743,6 @@ Bundle Selection
Optional: Skip to `Finish installation`_.
Manage User
===========
Add New User
------------
#. In Advanced Options, select :guilabel:`Manage User`.
#. Select :guilabel:`Add New User` as shown in Figure 24.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-24.png
:scale: 100%
:alt: Add New User, User Name
Figure 24: Add New User
#. Optional: Enter a :guilabel:`User Name`.
.. note:
The User Name must be alphanumeric and can include spaces, commas, or
hyphens. Maximum length is 64 characters.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-25.png
:scale: 100%
:alt: User Name
Figure 25: User Name
#. Enter a :guilabel:`Login`.
.. note::
The User Login must be alphanumeric and can include hyphens and underscores. Maximum length is 31 characters.
#. Enter a :guilabel:`Password`.
.. note:
Minimum length is 8 characters. Maximum length is 255 characters.
#. In :guilabel:`Confirm`, enter the same password.
#. Optional: Navigate to the :guilabel:`Administrative` checkbox and select
:kbd:`Spacebar` to assign administrative rights to the user.
.. note::
Selecting this option enables sudo privileges for the user.
#. Select :kbd:`Confirm`.
.. note::
If desired, select :guilabel:`Reset` to reset the form.
#. In :guilabel:`Manage User`, navigate to :guilabel:`Confirm`.
#. With :guilabel:`Confirm` highlighted, select :kbd:`Enter`.
Modify / Delete User
--------------------
#. In :guilabel:`Manage User`, navigate to the user you wish
to modify until highlighted, as shown in Figure 26.
#. Select :kbd:`Enter` to modify the user.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-26.png
:scale: 100%
:alt: Modify User
Figure 26: Modify User
#. Modify user details as desired.
#. Navigate to :kbd:`Confirm` until highlighted.
.. note::
Optional: Select :guilabel:`Reset` to rest the form.
#. Select :guilabel:`Confirm` to save the changes you made.
#. Optional: In :guilabel:`Modify User`, to delete the user, navigate to
the :guilabel:`Delete` button and select :kbd:`Enter`.
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-27.png
:scale: 100%
:alt: Delete User
Figure 27: Delete User
You are returned to :guilabel:`Manage User`.
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :guilabel:`Enter` to complete :guilabel:`Manage User` options.
Optional: Skip to `Finish installation`_.
Kernel Command Line
===================
@@ -842,7 +840,7 @@ Optional: Skip to `Finish installation`_.
Automatic OS Updates
====================
Automatical OS updates are enabled by default. In the rare case that you
Automatic OS updates are enabled by default. In the rare case that you
need to disable automatic software updates, follow the onscreen instructions,
shown in Figure 32.
+55 -43
View File
@@ -3,8 +3,8 @@
Create a bootable USB drive
###########################
Follow the instructions applicable to your system to create a bootable |CL-ATTR|
USB drive:
Follow the instructions applicable to your system to create a bootable
|CL-ATTR| USB drive:
* :ref:`bootable-usb-linux`
* :ref:`bootable-usb-mac`
@@ -13,34 +13,29 @@ USB drive:
Prerequisites
*************
* Use an **8GB** or larger USB drive.
* Download the |CL| live boot image or interactive installer image from the
`Downloads`_ page.
* Download the |CL| Desktop or Server image from the `Downloads`_ page
* Recommended minimum **4GB** USB drive or larger
.. _bootable-usb-linux:
Create a bootable USB drive on Linux\*
**************************************
Make sure you have completed all `Prerequisites`_.
* Make sure you completed all `Prerequisites`_.
Before burning the image onto your USB drive, :ref:`verify-linux` on Linux.
* :ref:`verify-linux` on Linux.
Burn the |CL| image onto a USB drive
====================================
.. caution::
Burning an image formats the USB drive, and will destroy all pre-existing
Burning an image formats the USB drive and destroys all pre-existing
content. Back up your data before proceeding.
#. Open a terminal emulator and get root privilege.
#. Open a terminal window.
.. code-block:: bash
sudo -s
#. Go to the directory with the decompressed image.
#. Change directory to where the image resides.
#. Plug in the USB drive.
@@ -48,7 +43,7 @@ Burn the |CL| image onto a USB drive
drives attached to the system, including the primary hard disk. In the
example output below, there are 4 drives
(`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached, where
`/dev/sda` is primary drive. The remaining are three USB drives. The output
`/dev/sda` is the primary drive. The remaining are three USB drives. The output
also shows the mounted partitions (under the `MOUNTPOINT` column) for each
drive.
@@ -59,6 +54,7 @@ Burn the |CL| image onto a USB drive
Example output:
.. code-block:: console
:emphasize-lines: 1-5
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
sdd 8:48 1 15G 0 disk
@@ -79,22 +75,24 @@ Burn the |CL| image onto a USB drive
├─sda8 8:8 0 30G 0 part /
└─sda6 8:6 0 7.9G 0 part [SWAP]
#. You must unmount a USB drive before burning an image onto it. Note that
some Linux distros automatically mount a USB drive when it is plugged in.
Unmount a USB drive with the :command:`umount` command followed by the device
identifier/partition. For example:
.. note::
Some Linux distros may automatically mount a USB drive when it is plugged in.
#. If the USB drive you want to use is mounted, it must be umounted before
burning an image onto it. Use the :command:`umount` command followed by
the device identifier/partition. For example, to unmount all /dev/sdd
partitions:
.. code-block:: bash
umount /dev/sdd2
umount /dev/sdd3
sudo umount /dev/sdd*
#. Burn the image onto the USB drive. The example below burns an uncompressed
image onto `<your USB device>`:
#. Burn the image onto the USB drive. The example below burns an image onto `<your USB device>`:
.. code-block:: bash
dd if=./clear-[version number]-[image type] of=<your USB device> oflag=sync bs=4M status=progress
sudo dd if=./clear-[version number]-live-[desktop | server].iso of=<your USB device> oflag=sync bs=4M status=progress
.. caution::
@@ -107,21 +105,21 @@ Burn the |CL| image onto a USB drive
Create a bootable USB drive on macOS\*
**************************************
Make sure you have completed all `Prerequisites`_.
* Make sure you completed all `Prerequisites`_.
Before burning the image onto your USB drive, :ref:`verify-mac` on macOS.
* :ref:`verify-mac` on macOS.
Burn the |CL| image onto a USB drive
====================================
.. caution::
Burning an image formats the USB drive, and will destroy all pre-existing
Burning an image formats the USB drive and destroys all pre-existing
content. Back up your data before proceeding.
#. Launch the Terminal app.
#. Open a Terminal window.
#. Change directory to where the decompressed image is saved.
#. Change directory to where the image resides.
#. Plug in a USB drive and get its identifier:
@@ -129,7 +127,7 @@ Burn the |CL| image onto a USB drive
diskutil list
This will list available disks and their partitions, as shown in Figure 1.
This lists available disks and their partitions, as shown in Figure 1.
.. figure:: /_figures/bootable-usb/bootable-usb-mac-01.png
:scale: 100 %
@@ -137,21 +135,22 @@ Burn the |CL| image onto a USB drive
Figure 1: macOS - Get USB drive identifier
#. Unmount the USB drive identified in the previous step. For example:
#. Unmount the USB drive identified in the previous step. For example, to unmount /dev/disk2:
.. code-block:: bash
diskutil umountDisk /dev/disk2
#. Burn the image onto the drive using the :command:`dd` command.
This example uses `./`, your current directory, and it shows how to burn an uncompressed image onto `<your USB device>`:
This example uses `./`, your current directory, and it shows how to burn
an image onto `<your USB device>`:
.. code-block:: bash
sudo dd if=./clear-[version number]-[image type] of=<your USB device> bs=4m
sudo dd if=./clear-[version number]-live-[desktop | server].iso of=<your USB device> bs=4m
To accelerate the imaging process, add an r before the disk identifier.
Example: `sudo dd if=./clear-30800-live-server of=/dev/rdisk2 bs=4m`.
Example: `sudo dd if=./clear-30800-live-server.iso of=/dev/rdisk2 bs=4m`.
Press :kbd:`<CTRL>-T` to check imaging progress.
@@ -163,29 +162,36 @@ Burn the |CL| image onto a USB drive
.. _bootable-usb-windows:
Create a bootable USB drive on Windows\*
****************************************
Create a bootable USB drive on Windows
**************************************
Make sure you have completed all `Prerequisites`_.
* Make sure you completed all `Prerequisites`_.
Before burning the image onto your USB drive, :ref:`verify-windows` on Windows.
* :ref:`verify-windows` on Windows\* OS.
Burn the |CL| image onto a USB drive
====================================
.. caution::
Burning an image formats the USB drive, and will destroy all pre-existing
Burning an image formats the USB drive and destroys all pre-existing
content. Back up your data before proceeding.
#. Download the `Rufus`_ utility to burn the image onto a USB drive.
We use Rufus 3.5 here. **Only use the latest version of Rufus**.
We use Rufus 3.5 for this example.
**Only use the latest version of Rufus**.
#. Plug in the USB drive and open Rufus.
#. Plug in the USB drive.
#. Launch Rufus.
#. Under `Device`, select the USB drive.
#. Under `Boot selection`, click the :guilabel:`SELECT` button.
#. Find and select the previously extracted |CL| image file.
.. note::
For other image tools, verify the `Volume label` is set to :guilabel:`CLR_ISO` **Do not change the label as installer relies on it.**
#. Click the :guilabel:`START` button. See Figure 2.
@@ -204,7 +210,13 @@ Burn the |CL| image onto a USB drive
Figure 3: ISOHybrid image detected
#. Select the Windows taskbar menu for USB and select eject.
#. Click :guilabel:`OK`.
#. The process make take more than a few minutes. When the process completes,
close Rufus.
#. Select the Windows taskbar menu for USB and select
:guilabel:`Eject <drive name>`.
.. _Rufus: https://rufus.ie/
.. _Downloads: https://clearlinux.org/downloads
+1 -1
View File
@@ -4,7 +4,7 @@ Check processor and EFI firmware compatibility
##############################################
Before installing |CL-ATTR|, check your host system's processor and EFI firmware
compatibility. To check compatibilty, choose one of the following paths:
compatibility. To check compatibility, choose one of the following paths:
* From a system with a Linux\* OS installed, follow the instructions to :ref:`check-compatibility-steps`.
+3 -3
View File
@@ -4,7 +4,7 @@ Get started
###########
The Get Started section guides you through the requirements and installation of
|CL-ATTR|. Follow these step-by-step intructions to get started with |CL|, fast.
|CL-ATTR|. Follow these step-by-step instructions to get started with |CL|, fast.
Pre-install
***********
@@ -15,7 +15,7 @@ There are a couple of things to take care of before you install.
* :ref:`compatibility-check`
* :ref:`bootable-usb`
When installing |CL-ATTR| in a VM, consider which kernel to use.
When installing |CL-ATTR| in a VM, consider which kernel to use.
* :ref:`Compatible VM kernels <vm-kernels>`
@@ -55,4 +55,4 @@ Deploy to the cloud
:maxdepth: 1
:glob:
cloud-install/*
cloud-install/*
Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

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