Commit Graph

126 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
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
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
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
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
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
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
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
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
Adeel Mujahid
83b12c65fd Fix typo: s/bundle <search term>/search <term>/ (#1025) 2020-02-07 12:44:25 -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
bktan8
77d7631e37 Update mixer build image to use clr-installer. (#1015)
* Update mixer build image to use clr-installer.

Closes #1006

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

* Reverts Example 7 to recent master, omitting Tutorials header, etc.
- Reason: Separate branches not sync'ed based on upstream master

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

* Adds line in Example 4 to assure Example 2 is known prereq.

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

* Simplify sentence.

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

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
2020-02-05 10:59:47 -08:00
Kristal Dale
1dc3d59bc4 Minor edit to mixer guide for clarity (#1007)
In Example 7:
- Remove 'tutorial' subsection as it was not clear that it was an example of the
advanced example of manual format bump.
- Roll existing tutorial content under 'advanced' as it is the advanced example.
- Result is a basic and advance example for Example 7: execute format bump

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-31 12:49:19 -08:00
Kevin Putnam
d0e71c8f5a 1. Fixes link to http://try.redis.io in redis tutorial. (#1012)
2. Fixes link to pmem-csi readme in DBRS stack guide.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-01-31 10:30:36 -08:00
bktan8
c0981002a6 Update lsblk commands to make it easier to identify devices. (#1000)
Closes #984

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-01-23 14:59:29 -08:00
Kristal Dale
10165b31ba Correct capitalization of DKMS to make standard with rest of doc. (#990)
Remove extra use of :abbr: (per contribe guide).

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-14 10:20:18 -08:00
Beth Dean
ff5f2e41c7 Add inference and multinode guide page for DLRS stack (#877)
Closes #876 

* Add inference and multinode guide page for DLRS stack

* Add images for Locust, add section on autoscaling & comms

* update Seldon autoscaling, move INGRESS_DDRSS section

* Move INGRESS_ADDRESS to benchmarking section, changes for readabiity, reduce ToC to 1

* remove gitlab URL

* Move INGRESS_ADDRESS section and reword introduction
2020-01-13 10:49:27 -08:00
puneetse
ce3a6c3321 Add document for Broadcom drivers (#980) 2020-01-10 14:25:15 -08:00
Kevin Putnam
66babf4915 1. Created support for max-3 column view and smallcards.
2. Updated Clear Linux guides with 3 column view, smallcards, and 3 feature cards.
3. Updated Guides with 3 column view and smallcards.

3 column view allows for graceful resizing of the grid and simplified source reducing the number of multicolumn containers.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-01-10 10:30:11 -08:00
Kevin Putnam
3d842f73f7 Updated guides landing page with cards and featured guides. Added landing pages for guide categories. Will add featured guides to these as well.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-01-09 15:43:17 -08:00
michael vincerra
c913639121 Prepends mixer build commands with sudo for successful execution. (#979)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-01-07 14:27:32 -08:00
guowangy
df0063ef02 cpu-performance.rst: add thermal configuration section (#961)
* cpu-performance.rst: add thermal configuration section

* Apply suggestions from code review

Co-Authored-By: michael vincerra <37549381+mvincerx@users.noreply.github.com>
Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* remove workaround part and add BIOS requirement

* ensure acpi tools is installed

* Apply suggestions from code review

Co-Authored-By: michael vincerra <37549381+mvincerx@users.noreply.github.com>

* format fixup

* Apply suggestions from code review

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
Co-authored-by: puneetse <22071208+puneetse@users.noreply.github.com>
2019-12-31 11:58:38 -08:00
puneetse
41ca0a41b9 Update note on wireless in live-server getting started (#966)
* Add reference to configuring wifi guide

Add reference to configuring wifi guide and place the note according the required order of operations

* Fix line too long RST warning.
2019-12-27 10:38:35 -08:00
Beth Dean
056119551c Update readme URL and remove redundant Seldon section (#965)
LGTM
2019-12-20 16:26:00 -08:00
Kevin Putnam
4e16119846 Fixed two broken links found in weekly check. (#963)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-12-20 11:15:26 -08:00
Kevin Putnam
f975d1dc00 Update to wifi guide to include wpa_supplicant. (#939)
* Update to wifi guide to include wpa_supplicant.

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

* Addressed reviewer feedback.

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

* Missed one piece of feedback.

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

* Small changes based on testing on Clear Linux to verify the current solution.

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

* Caught a couple small things.

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

* Update wifi.rst

Add more context and update commands to be as executable as possible.

* Fixed a typo and a couple of formatting problems.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-12-18 14:24:37 -08:00
Beth Dean
e90885986f Update for DLRS V5 release (#962) 2019-12-17 21:20:01 -08:00
bktan8
7b21fb9159 Update increase-virtual-disk-size doc. (#958)
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-12-16 14:46:23 -08:00
DougTW
1b15019f03 vnc.rst: corrected figure numbering to be sequential (#944)
* vnc.rst: corrected figure numbering to be sequential, starting with Figure 5.

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

* Fixed incorrectly numbered reference to a figure.

Signed-off-by: Doug Martin <doug.martin@intel.com>
2019-12-13 09:43:18 -08:00
extremepayne
f9d976de41 Windows command sha512 -> SHA512 (#956)
* Windows command sha512 -> SHA512

The command fails (on my computer) unless the hash algorithm is passed as uppercase.
As per: https://answers.microsoft.com/en-us/windows/forum/all/certutil-hashfile-sha1-failed/1a9f31fa-bdf5-4c63-8e72-91608606ba14

* trigger CI
2019-12-13 09:38:08 -08:00
michael vincerra
cdaa36e279 Add improved role descriptions and bundles to developer-workstation (#947)
* Add bundle function and desc to developer-workstation.
- Closes #764

* Add more bundles relevant to each role.

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

* Add `ltp` to kernel developer; revise AI Dev to AI/ML Engineer.

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

* Revise bundles listed for kernel developer and add maker dev.

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

* Removes Embedded Systems profile due to few relevant bundles.

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

* Remove game developer per review from @ahkok.

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

* Adds containers-virt to Computer Vis. Engineer; and reference note.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-12-12 10:42:43 -08:00
michael vincerra
e2e1a2896c Replace stacks-tensorflow-mkl with stacks-dlrs-mkl per @DnPls. (#955)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-12-11 11:21:01 -08:00
michael vincerra
410768be7e Simplify section "Boot a live desktop image to fix..." in fix-broken-install (#951)
* Simplify section Boot a live desktop image to fix...
- Remove include per request from @bktan8
- Make concise the Prereq's

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

* Fix spacing syntax.

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

* Clarify swupd scope re /var dir. Revise wording in Prereqs.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-12-05 13:33:39 -08:00
mns6070
389887026e Updated to mount the /boot partition (#946)
* Update fix-broken-install.rst
* Updates to lsblk command Ln 52 and wording on Ln 56.
2019-12-04 13:29:36 -08:00
DougTW
0aa9fad0ec dpdk.rst: Fixes Figure caption indent (see pr 896) (#945)
- This PR doesn't close pr 896 because there are multiple files to be fixed. Last PR will close pr 896.

Signed-off-by: Doug Martin <doug.martin@intel.com>
2019-12-02 23:47:14 +01:00
DougTW
d539c6feff dlrs.rst: Fixes Figure caption indent (see pr 896) (#943)
-This pr doesn't close pr 896 because multiple files need to be edited. Last PR will close pr 896.

Signed-off-by: Doug Martin <doug.martin@intel.com>
2019-12-02 15:30:19 -06:00
bktan8
8ca656b901 iPXE updated to use clr-installer. (#932)
ister and icis deprecated.

See also: https://github.com/clearlinux/clr-bundles/issues/171
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-11-21 15:39:14 -08:00
Kevin Putnam
112ec79c56 Added support for sphinx-tabs and created an example on the Stacks DB reference stack guide. (#928)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-11-21 15:05:26 -08:00
michael vincerra
9264ae8b73 Correct external GitHub link; correct syntax of internal link to building custom Docker image. (#931)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-20 14:02:13 -08:00
puneetse
dbf84a7bb9 Add guide for Media Reference Stack (#929)
* Add guide for Media Reference Stack

* Correct errors in syntax and docstring refs for successful build.

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

* Corrects docstring ref title from `tutorial-proxy` to `proxy`
- Resolves build error detected by Travis

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-20 11:38:42 -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