Commit Graph

2328 Commits

Author SHA1 Message Date
Michael Vincerra
9e442dc1c6 Merge branch 'development' of https://github.com/intelkevinputnam/clear-linux-documentation into development 2020-04-03 19:45:38 -07:00
Michael Vincerra
e6b4f024ad Merge branch 'mv-about-architect' of https://github.com/mvincerx/clear-linux-documentation into development
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-03 19:44:57 -07:00
Michael Vincerra
550b919bc0 Creates component list table and reorganizes content coherently.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-03 19:29:23 -07:00
Michael Vincerra
e7f141ce83 Provide overview of CL architecture, including rationale.
Closes #1102

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-03 18:06:51 -07:00
michael vincerra
2ffff6fa9e Adds swupd-3rd-party option; removes instruction on Docker. (#1050)
- Use of Docker with mixer is now deprecated.
- Recreates grid table as list-table for future maintenance.
- Adds new section, Bundle definition files, for illustration
- Revises builder.conf in References, removing docker path.
- Updates mixer builder.conf to VERSION 1.2.
- Fix typo in filepath for LOCAL_RPM_DIR in builder.conf.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-03-30 17:02:59 -07:00
puneetse
154beef96e Fix version of OpenVINO and branding on Media Reference Stack (#1095)
* Fix OpenVINO version branding

MeRS uses the open source OpenVINO not the Intel® Distribution of OpenVINO™ toolkit

* Fix line length warnings

* Fix OpenVINO trademark branding

Fix OpenVINO trademark branding and add required acknowledgement
2020-03-26 13:10:27 -07:00
michael vincerra
40559931b6 Replace Fig. 32 to update embedded URL for swupd on docs.01.org. (#1097)
Closes #1038.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-03-25 14:37:25 -07:00
bktan8
c740464e73 Minor updates to the Stateless doc. (#1094)
Closes #1089

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-25 09:15:32 -07:00
puneetse
6c1d61b9d2 Add path to kernel source headers (#1092)
Add the path to kernel source headers in kernel module documentation for reference.
2020-03-24 11:25:42 -07:00
bktan8
1e048709b1 Remove CBM "update" after "set-timeout" (#1091)
Closes #1090

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-24 10:47:08 -07:00
Kevin Putnam
cdb5531bcc Fixed broken links: (#1087)
Added escape character so they aren't turned into links:
guides/clear/mixer.rst:1127:
   [broken] http:/
guides/clear/swupd-3rd-party.rst:61:
   [broken] http:/

Pointed to containers and bundles that still exist:
guides/maintenance/developer-workstation.rst:58:
   [broken] https://clearlinux.org/software/docker/machine-learning/
guides/maintenance/developer-workstation.rst:187:
   [broken] https://clearlinux.org/software/bundle/web-server-basic
guides/maintenance/developer-workstation.rst:193:
   [broken] https://clearlinux.org/software/bundle/database-basic

Unable to fix - this document doesn't appear to exist. Recommend removing reference.
guides/stacks/dbrs.rst:41:
   [broken] https://clearlinux.org/news-blogs/database-reference-stack-dbrs-v2-now-available

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-03-20 11:20:23 -07:00
Beth Dean
cb1e5c3942 Fix broken link (#1088) 2020-03-20 11:19:52 -07:00
bktan8
9e17ed2172 Update nginx setting for iPXE doc (#1086)
Closes #1085

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-20 08:46:19 -07:00
bktan8
2417f133c6 Create, Install, and Manage 3rd-party Bundles (#1075)
Closes #528

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-19 17:43:25 -07:00
Beth Dean
57929c7af8 Add memcached instructions for v2.0 (#1081)
* Add memcached instructions for v2.0

* Fix broken link, update Optane branding

* Add link to release announcement
2020-03-19 14:23:54 -07:00
bktan8
c5db9bbaa7 Update unattended installation doc and deprecate ister doc. (#1079)
Closes #1052

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-18 19:18:02 -07:00
bktan8
f15f84ba81 Import Clear AWS image, create AMI, and launch. (#1072)
Closes #890

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-10 16:39:49 -07:00
odwdinc
3b467b9682 Added fix for swupd bundle-add Error (#1067)
Signed-off-by: Anthony Pray anthony.s.pray@intel.com
When using the docker image you may see error
"Failed to install x of x"
ruining  "swupd clean" will fix the problems.
2020-03-10 11:25:22 -07:00
Lucius Hu
de72a05153 nvidia.rst: Remove chmod +x on installer (#1070)
With `sudo sh NVIDIA-Linux-x86_64-<VERSION>.run`, we don't need to change its permission.

This commit makes it a bit more convenient for users.
2020-03-10 11:23:06 -07:00
Beth Dean
9e94e80ef8 Update instructions for X11 forwarding and SFTP (#1066)
* Update instructions for X11 forwarding and SFTP, closes #1027

* Clean up instruction steps for consistency
2020-03-10 11:11:50 -07:00
Lucius Hu
11736014d7 nvidia.rst: Correct the path for desktop files (#1069)
Desktop files should be created under `$HOME/.local/share/applications` instead of `$HOME/.local/share`,
at least on my system only the former one works.

This commit fixed the path for both installation and uninstallation.
2020-03-10 09:50:53 -07:00
Lucius Hu
2e5ca06c35 nvidia.rst: Add a section to restore ld.so.conf (#1068)
During installation, `ld.so.conf` was modified to include `/etc/ld.so.conf.d`, under which
a file `nvidia.conf` was created so that `ld` looks for shared library installed by NVIDIA driver.

This commit adds information on removing `nvidia.conf` file.
Users could optionally remove the line `include /etc/ld.so.conf.d/*.conf` that we added to
`/etc/ld.so.conf`.
2020-03-10 09:40:18 -07:00
Eric Adams
5bc7d20547 Adds hugepages config guide to explain defaults and config settings (#1061)
* Adds hugepages config guide to explain defaults and config settings

Closes #1005

Signed-off-by: Adams, Eric <eric.adams@intel.com>

* Made revisions per feedback from reviewer.

Signed-off-by: Adams, Eric <eric.adams@intel.com>
2020-03-06 15:26:02 -08:00
Chadwick Ferguson
311f86d55c Makes driver find application profiles (#1064)
* Makes driver find application profiles

muchas importante

* Update nvidia.rst

* Update nvidia.rst

* Update nvidia.rst
2020-03-06 14:59:39 -08:00
puneetse
0d4a550731 Add container images to get-started page (#1051)
Add a page under get-started section for Clear Linux OS container images
2020-03-06 14:57:09 -08:00
puneetse
f1c1786936 Update FAQ (#1062)
Add 3 questions and revise top-down readability
2020-03-06 14:47:52 -08:00
michael vincerra
e179118e1c Correct filenames (#1060)
its the small things that matter, 2 missing hyphens; fixing them turned my symlinks from red to green.  I only hope these are the correct names!
2020-03-05 08:39:33 -08:00
puneetse
44d07ab728 Update kata doc after default runtime change (#1054)
After Clear Linux version 31390 kata containers is no longer the default runtime for docker.
2020-03-03 14:32:22 -08:00
puneetse
63ac1a54be Add mkdir command for /etc/kernel (#1053) 2020-02-28 18:06:38 -08:00
michael vincerra
e39fd30704 Adds tick marks for for File System descriptors, Default partition schema (#1057)
- Match exatcly syntax in bare-metal-install-desktop
- Improve UI legibility in HTML

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-02-28 18:05:02 -08:00
Mark Horn
d67b9beac9 Note support for f2fs for clr-installer (#1056)
Support for f2fs file system type was enabled in the clr-installer
release 2.4.1.
https://github.com/clearlinux/clr-installer/pull/654

Signed-off-by: Mark D Horn <mark.d.horn@intel.com>
2020-02-28 17:42:17 -08:00
Beth Dean
990966b5b4 Add Horovod and OpenMPI section, closes #1041 (#1055)
* Add Horovod and OpenMPI section, closes #1041

* changing pygment lexar to console to fix build issue

* Remove single quotation mark inside code-block to correct build error.

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

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
2020-02-28 17:33:47 -08:00
Kevin Putnam
76e377278f Sets max width of content container to 1100 pixels and adjusts a few other settins to fit in the new arrangement. (#1046)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-02-26 14:07:47 -08:00
Kevin Putnam
ce716eff61 Update to CPU performance guide. (#1037)
* Changed .. code:: to .. code-block:: to match project standards.

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

* Updates to power and performance for readability and consistency with project reST standards.

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

* Further updates to CPU performance guide with BIOS snapshot to show what DPTF setting might look like.

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

* Addressing editorial feedback.

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

* Added disclaimer for Intel Turbo Boost Technology.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-02-24 13:56:08 -08:00
michael vincerra
851a41de88 Revise steps for clarity and dist UI components, bootable-usb. (#1035)
* Revise steps for clarity and dist UI components.
- Resize all images for uniformity
- Revise from balenaEtcher to Etcher per USPTO trademark

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

* Add intro and revise wording where applicable.

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

* Resizes image to be slightly larger.

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

* Resizes Figure 2 for uniformity and makes minor edits.

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

* Add Advanced Linux CLI section per group discussion.

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

* Responds to user feedback applies editorial changes.

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

* Corrects `lsblk` command labels to reflect output; adds ! for Flash complete.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-02-21 14:15:17 -08:00
michael vincerra
4d62a23039 Revises telemetry figure to correct URL; reorders steps. (#1040)
* Revises telemetry figure to correct URL; reorders steps.
- Reorders Assign Hostname to match oreder of menus in UI
- Corrects typos and grammatically unclear sentences.
- Renames figures as a result of reordering sections, above.
- Closes #1039.

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

* Recaptures Fig 31, Swupd Mirror menu:
- Adds "allow installation over insecure connections..." checkbox

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-02-20 15:43:15 -08:00
eeeple
bba463cb49 Update NVIDIA tutorial to recommend LTS kernel (#1034)
* Added recommendation to run LTS kernel for proprietary NVIDIA drivers (see https://github.com/clearlinux/distribution/issues/1725)

* Updated wording following puneete comment

* Updated wording following puneete comment
2020-02-20 12:55:08 -08:00
Kevin Putnam
72a6b7f212 Updates based on native Chinese speaker review. (#1036)
* Updates based on native Chinese speaker review.

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

* Updates based on feedback.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-02-20 12:51:15 -08:00
odwdinc
4151fb20d7 Updated underlins
Signed-off-by: Anthony Pray anthony.s.pray@intel.com
2020-02-19 13:37:11 -08:00
odwdinc
8d9fe19c89 Update ImageTemplit
Signed-off-by: Anthony Pray anthony.s.pray@intel.com
2020-02-19 13:37:11 -08:00
odwdinc
29a77b8ba7 Updated format
Signed-off-by: Anthony Pray anthony.s.pray@intel.com
2020-02-19 13:37:11 -08:00
odwdinc
ca40794a49 Images to update USB install instrusctions
Signed-off-by: Anthony Pray <anthony.s.pray@intel.com>
2020-02-19 13:37:11 -08:00
odwdinc
f84ed4bdc9 Using balenaEtcher to create a bootable USB drive
Signed-off-by: Anthony Pray <anthony.s.pray@intel.com>
Need to get the images in to the doc? .. figure:: /_figures/bootable-usb/ ???
Find a way to do tabs for ejecting the usb drive  form each os, Windows, OSX, Linux
2020-02-19 13:37:11 -08:00
Kevin Putnam
f9d2bbdb25 Convert Qing Cloud to English. (#1031)
* Replaced Chinese text with English. First pass.

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

* Translated Qing Cloud deployment page to English.

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

* Attempting fix for broken build caused by GitPython==2.1.11

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-02-18 12:54:42 -08:00
puneetse
3957464189 Add OpenFaaS tutorial (#1023) 2020-02-12 09:54:15 -08:00
Christoph
96217f6179 update to current settings (#1024)
The current CUDA Toolkit is v10.2 and now supports gcc8. I was able to install it only when the --samples option was removed. This is advice from https://community.clearlinux.org/t/cuda-toolkit-installation-error/1699
2020-02-11 11:34:57 -08:00
Adeel Mujahid
83b12c65fd Fix typo: s/bundle <search term>/search <term>/ (#1025) 2020-02-07 12:44:25 -08:00
bktan8
c95c1ffd70 Dual-boot win - add link to server install as another option. (#1022)
Closes #1008

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-02-06 13:56:48 -08:00
puneetse
b2ecf5f144 Add a workarounds section (#1016)
Add a section for known workarounds to NVIDIA driver issues
2020-02-05 17:02:52 -08:00
Eric Adams
855153c10e Updated time.rst (#1013)
* Updated time.rst

When I tried this I had an error when I tried to set ntp to true that polkit was missing. Adding that bundle allowed the step to complete.

* Update time.rst 

Removed adding the polkit and instead added sudo to the timecatectl set-ntp command.
2020-02-05 13:52:09 -08:00