Documentation📄: RHEL edge device keyword

[johnwalicki]

What is the current documentation state?

On the https://open-horizon.github.io/docs/installing/adding_devices.html
page, RHEL is one of the supported edge device operating systems. However the bullet on the above html rendered page reads as:

8.1, 8.2, and 8.3

The actual .md markdown is:

{{site.data.keyword.rhel}} 8.1, 8.2, and 8.3

We need to investigate why the {{site.data.keyword.rhel}} keyword is not substituted correctly.

The {{site.data.keyword.rhel}} keyword is not defined in the keyword.yml file at
https://github.com/open-horizon/open-horizon.github.io/blob/master/_data/keyword.yml

Reference markdown pages:

• https://github.com/open-horizon/open-horizon.github.io/blob/master/docs/installing/adding_devices.md

[johnwalicki]

Here is how that page and keyword correctly render in the IEAM product documentation:
https://www.ibm.com/docs/en/eam/4.3?topic=devices-preparing-edge-device

[johnwalicki]

Open Horizon also works on RHEL / CentOS 8.4 and RHEL / CentOS 8.5 (you have to uninstall podman and install Docker). While Docker is not officially supported by Red Hat, Open Horizon does work correctly. Why can't the Open Horizon docs list those versions?

[johnwalicki]

The fix is to insert the following keyword in https://github.com/open-horizon/open-horizon.github.io/blob/master/_data/keyword.yml

  rhel:
    Red Hat Enterprise Linux®

at the alphabetically appropriate location.

[johnwalicki]

@Rene-Ch1 @joewxboy FWIW - When comparing the IEAM product conrefs.yml and the Open Horizon _data/keyword.yml I see a variety of keyword differences (some intentional, but some omissions, some out of sync)

Intentionally, I did not sync the keyword files in the giant #220 PR. We should review the differences anyway?

[johnwalicki]

I noticed this missing keyword when reviewing the merged PR #242
We should make it a practice to inspect not just the bespoke patch but the actual rendered page and the rest of the resulting document.

[johnwalicki]

The adding_devices.md references this {{site.data.keyword.rhel}} keyword in multiple places. A complete review of
https://open-horizon.github.io/docs/installing/adding_devices.html is recommended (once the PR is merged)

[johnwalicki]

I scanned the Open Horizon documentation tree. The {{site.data.keyword.rhel}} is only mentioned in the adding_devices.md markdown file.

[johnwalicki]

Before merging this PR, the adding_devices.html page is missing the RHEL keyword in this sentence:

While Open Horizon 4.2 supports running 8.x with Docker, it is officially unsupported by .

[johnwalicki]

This fix will resolve the following sentences in the markdown:

./docs/installing/adding_devices.md:   * {{site.data.keyword.rhel}} 8.1, 8.2, and 8.3
./docs/installing/adding_devices.md:   * {{site.data.keyword.rhel}} 7.6, 7.9, 8.1, 8.2, and 8.3
./docs/installing/adding_devices.md:* CentOS and {{site.data.keyword.rhel}} on {{site.data.keyword.ieam}} {{site.data.keyword.version}} only support Docker as a container engine.
./docs/installing/adding_devices.md:* While {{site.data.keyword.ieam}} {{site.data.keyword.version}} supports running {{site.data.keyword.rhel}} 8.x with Docker, it is officially unsupported by {{site.data.keyword.rhel}}.
./docs/installing/adding_devices.md:* [{{site.data.keyword.rhel}} 8.x devices or virtual machines](#rhel8)
./docs/installing/adding_devices.md:Prepare your device by installing a Debian, {{site.data.keyword.rhel}} 7.x, or Ubuntu {{site.data.keyword.linux_notm}}. The instructions in this content are based on a device that uses Ubuntu 18.x.
./docs/installing/adding_devices.md:## {{site.data.keyword.rhel}} 8.x devices or virtual machines
./docs/installing/adding_devices.md:Prepare your device by installing {{site.data.keyword.rhel}} 8.x.
./docs/installing/adding_devices.md:Prepare your device by installing {{site.data.keyword.rhel}}.

[joewxboy]

@bencourliss Do you know if Open Horizon is actually tested on RHEL? Or is it alternatively tested on Fedora? Or not on those OSes at all?