まえがき
この記事を執筆するに至った背景は、私自身もRed Hatのドキュメントを読むコツを教わって以降かなり検索効率が向上したことが理由です。
なんとなくですが、Red Hatのテクノロジーや製品は全般的に難しいと思われがちです。
製品のことを知るためのドキュメントに対して少しでも検索のコツが伝われば、皆さん自身もRed Hatのプロダクトに対しての親近感も持っていただけると思い、この記事をご用意しましたので一人でも多くの方の目に留まれば幸いです。
この記事の目指すゴール
- Red Hatのドキュメントから得たい情報を探しやすくなる
- Red Hat認定資格試験でもドキュメントを活用できるようになる
- より正確で新しい情報にアクセスできるようになる
- PDFでのドキュメントを取得できるようになる
Red Hatのドキュメントの表示方法
まず、Red Hatの公式ドキュメントを検索します。このように検索をすれば表示されます。
公式ドキュメントのトップページがこちら
ドキュメントを確認する時は、おおよそ調べたい製品が決まっていると思います。
ここではRed Hat Enterprise Linuxについて検索をしたい場合を例に挙げます。
この場合は画像内の左下にあるRed Hat Enterprise Linuxをクリックします。
ちなみに、ロゴの中をよく見ると赤いEと白いLが重なっています。(Enterprise Linux)
RHELのドキュメント
まず、こちらがRHELのドキュメントのトップページです。
Red Hatのドキュメントページの基本的なレイアウトは左側にツリーがあり、
右側にメイン画面が存在します。
表示バージョンの切り替え
確認したい製品のバージョンを切り替えたい場合はプルダウンメニューから切り替えが可能です。
なお、本記事作成時点ではRHEL 5(2007にGA)まで遡ることもできます。
ここまで古いものに遡ることはさほどないとは思いますが、古い製品についても同じページから同じレイアウトで表示できることは技術者としてもありがたいです。
特に、お客様によってはサポート期間終了後もレガシーな製品を使用し続けているケースがあるためです。
メーカーのテクニカルサポートは利用できなくても、ご自身で当該製品について調べられる点は嬉しいはずです。
ツリー構造部
基本的にこのツリー構造部が、大項目を表します。
各大項目の中に、より詳細なレベルでの項目が1つ以上属している形になります。
ここでのポイントを1つご紹介すると、『製品のバージョンによって、ツリーの大項目に含まれる各項目の組み合わせが変更される場合がある』 ということです。
例えば、RHEL10とRHEL 9 それぞれのネットワークの項目を比較してみましょう。
項目数は2つと共通していますが、2個目の項目が明らかに違います。
また各画像の下の方にあるIdentity Managementでも同じ6つの項目でも、中身が違います。
つまり、バージョンごとに情報の配置が変わるので、自分がよくアクセスする情報ほど『あの情報は確かこの項目にあったな』と固定的に覚えてしまうことは危険なので避けた方が良い です。
RHEL 10のネットワークの項目
RHEL 9のネットワークの項目
大項目内の中項目と小項目
以下の図は、RHEL 10のネットワークに関するドキュメントページです。
先ほどの製品に対するドキュメントトップページとレイアウトは似ています。
但し、ツリー構造の階層が多く、項目ごとに右側のページが用意されています。
また下図のように、ドキュメントの中にはサンプルのコマンドが表示されるページもあるので、ご自身が行いたい作業のためのコマンドがわからない場合は、ドキュメント内から情報を得ることが可能です。
なお、ページ内のコマンドは そのままコピーアンドペーストで使用できるものもあれば一部コマンドの中身をご自身の操作環境に応じて変更する必要があるコマンドもある(図内のオレンジの箇所) のでご注意ください。
なお、ページによっては下図のように技術情報ではなく表紙のみの場合などもあります。
このように、ツリー内の1つの項目ごとに右側の本ページが用意されているので、通常はご覧になりたい項目を探す際に何度も左側のツリー内の項目をクリックし続けて情報を探すことになります。
シングルページの活用
そこで、上記の問題を解決する方法として、シングルページ形式での情報表示があります。
画面右上の表示形式プルダウンをシングルページにすると、1つ1つの情報ページが全て上下のスクロールで移動可能なようにブラウザ内に表示されます。
もちろん、Ctrl+Fなどの検索機能を使用すれば全範囲に対して検索をかけることができます。
但し、検索範囲が大変広いので、その点は考慮事項となります。
以下の図では nmcli というキーワードで検索していますが327件ヒットしています。
画像右側のスクロール範囲が非常に広いこともわかります。
ですのでシングルページでの検索はある程度長めのキーワードを使って、ヒットする検索対象を絞るスキルが求められます。
PDFでのドキュメント閲覧
PDFでドキュメントを閲覧したい場合は、下図のように形式プルダウン内で全ドキュメントPDFで表示するをクリックします。
プルダウンにてPDFを選ぶと、ブラウザの別タブとしてPDFページが表示されます。
なお、PDFへのダイレクトリンクは以下のように記事内にも含めることが可能です。
PDFドキュメントはダウンロードして、ご自身のPCなどに保存して利用もできます。
また、以下のようにダウンロードしたPDFをAIに読み込ませて、複数のPDFから横断的に情報を検索させるような方法を取ることも可能です。
Red Hatのドキュメントを読む際に覚えておきたいこと
1. バージョン間で共通の項目名の中でも油断ならない
以下の図は、RHEL 10とRHEL 9の両方にあるネットワークの設定および管理の中身です。
左側のツリーを比較してみると、赤枠の項目がバージョン間での違いとなっています。
このように、同じ項目名のページを見ていても、中身のレイアウトが違うということも多いです。
2. 日本語と英語とでページのレイアウトが違うことがある
以下の図はOpenShiftのドキュメントの様子です。
同じストレージのページにアクセスをしているのですが、ページの表示のされ方が違います。
このため、もし日本語以外のドキュメントをご利用いただく際は、レイアウトの違いを考慮に入れる必要があります。
また、日本語版よりも先行して英語版の方が新しい情報が掲載されますので、より新しく正確な情報を得たい場合は
可能な限り英語版のドキュメントを参照することをお勧めします。
3. バージョン切り替え機能に頼りすぎない
ドキュメント内に存在するバージョン切り替え機能は便利ですが、一部のページは下図のようにエラーが表示される場合が稀にあります。
このような場合、OpenShiftの4.14のトップページに移動してから探しましょう。
あとがき
いかがでしたでしょうか。
製品ドキュメントはRed Hatに限らずさまざまなメーカーが提供している基本的な情報リソースです。
活用度合いが増すことで製品への理解も深まれば、問題の解決や環境の最適化などに大きく寄与します。
また、Red Hat認定資格試験では試験中に製品ドキュメントの閲覧ができることが公式にも謳われており、ドキュメントを理解することは合格率をぐんと上げてくれますので試験を受ける方にも必ず上記のスキルは身につけていただきたいです。
最後に、個人的な感想を付け足しておきますが、他社と比べても日本語の翻訳精度は高いと感じています。
特定のメーカーのお名前を挙げることはこの記事では差し控えますが、明らかにおかしい翻訳が見当たらなかったり、文字フォントも統一されていたりと一利用者としてはとても良い印象を持っています。
但し、書かれている技術的な内容そのものがそもそも難しいというところはあります(笑)
ドキュメントの品質については以下のように改善のためのフィードバックの窓口を設けています。
このためどなたであっても改善のために声を上げていただけますし、皆様のおかげで日々ドキュメントの質も向上しています。
ドキュメントの品質改善のためのフィードバック
https://docs.redhat.com/ja/documentation/red_hat_enterprise_linux/10/html-single/configuring_and_managing_networking/index#providing-feedback-on-red-hat-documentation
Jiraへのダイレクトリンク
https://issues.redhat.com/projects/RHELDOCS/issues
これはオープンソースのカルチャーの良い面が製品品質にバッチリ反映していることを意味すると言えます。
お読みいただくタイミングではひょっとすると求める情報がなかったり、求める品質でないこともあるかもしれませんが、ぜひそのようにお感じいただいた場合は、フィードバックを頂けると幸いです。