前書き #Edit source
1 利用可能なドキュメンテーション #Edit source
- オンラインドキュメンテーション
ドキュメンテーションは https://doc.opensuse.org で公開されています。ここから直接読むこともできますし、様々な形式でダウンロードを行うこともできます。
注記: 最新の更新について
ドキュメンテーションの最新版は通常、英語版が先に作成されます。
- SUSE ナレッジベース
何らかの問題に直面した場合は、 https://www.suse.com/support/kb/ からアクセスできる技術情報文書 (TID) をご確認ください。ここからお客様からの問い合わせで発生した、様々な SUSE 社の知識情報が検索できます。
- お使いのシステム内
オフライン環境での利用を想定して、お使いのシステム内の
/usr/share/doc/release-notesディレクトリにはリリースノートが保存されているほか、各パッケージに対するドキュメンテーションが/usr/share/doc内に存在しています。また、多くのコマンドに対して、 マニュアルページ も用意されています。マニュアルページは
manコマンドで表示することができます。このコマンドの後ろに参照したいコマンド名を指定してください。なお、manコマンドがインストールされていない場合は、sudo zypper install manを実行してインストールしてください。
2 ドキュメンテーションの改善 #Edit source
このドキュメンテーションに対するご意見だけでなく、改善や追記などの貢献をいただければ幸いです。それぞれ下記のチャンネル経由でお送りいただくことができます:
- バグ報告
ドキュメンテーション内に誤記などを見つけた場合は、 https://bugzilla.opensuse.org/ で問題を報告してください。
なお、この文書の HTML 版の各章には、問題を報告するための というアイコンが用意されていますので、こちらをお使いのうえ報告をお願いいたします。これにより、 Bugzilla で対象の製品や分類、そしてリンク先などをそれぞれ自動で設定するようになっています。あとは問題点の説明を記述するだけです。
なお、報告には Bugzilla のアカウントが必要となるほか、 英語でのやり取りが必要となりますので、あらかじめご了承ください。
- 貢献
このドキュメンテーションに対して追記もしくは更新すべき具体的な内容をお持ちの場合は、この文書の HTML 版の各章に用意されている のリンクをお使いください。これにより、 GitHub 内にある 英語版原文の ソースコードを表示し編集することができますので、作業が終わり次第 pull request を送信してください。
なお、 GitHub のアカウントが必要となります。
注記: は英語版のみに提供される件について
のリンクは各文書の英語版原文を編集する目的でのみご利用いただけます。その他の言語については でお知らせください。
なお、本文書で使用しているドキュメンテーション環境の情報については、リポジトリ内の README をお読みください。
- 電子メール
本製品のドキュメンテーションに対するフィードバックは、 <doc-team@suse.com> でも受け付けております。なお、文書のタイトルと製品のバージョン、およびドキュメンテーションの発行日付をそれぞれご記入ください。また、問題点の報告や記述の追加に関するご提案は、それぞれ概要と対応するセクション番号、およびページ (もしくは URL) をご記入ください。
- ヘルプ
openSUSE Leap に対するさらなる支援をご希望の場合は、 https://ja.opensuse.org/Portal:Support をご覧ください。
3 文書規約 #Edit source
この文書内では、下記のような記述ルールを使用しています:
/etc/passwd: ディレクトリ名やファイル名を示していますPLACEHOLDER : PLACEHOLDER の箇所は、実際の値に置き換えるべきものであることを示しています
PATH: 環境変数であることを示していますls,--help: コマンドやオプション、パラメータであることを示していますuser: ユーザ名やグループ名であることを示していますパッケージ名 : ソフトウエアのパッケージ名を示しています
Alt , Alt–F1 : キー入力や組み合わせキー入力を示しています; キーはキーボードに書かれているとおりに大文字で示されます
, › : メニュー項目やボタンなどを示しています
第1章「章のタイトル」 : 本ガイド内の他の箇所への参照を示しています。
下記は
rootユーザの権限で実行しなければならないコマンドを示しています。一般ユーザから実行する場合は、これらのコマンドの前にsudoを付けることで、rootで実行できるようになります:#コマンド>sudoコマンド下記は一般ユーザで実行できるコマンドを示しています:
>コマンドまた、行末にバックスラッシュ文字 (
\) を付けることで、コマンドを複数行に分けて記述している場合もあります。バックスラッシュ文字は、シェルに対して、これ以降にもコマンドが続くことを示す文字になります:>echoa b \ c dこのほか、行頭にプロンプトが書かれたコマンド行に続いて、そのコマンドを実行した場合の出力例を示す場合もあります:
>コマンド出力各種の情報について
警告: 警告
実際に実施したりする前に、注意しておかなければならない、きわめて重要な情報を記述しています。セキュリティ面の問題のほか、データを失ってしまう可能性への告知、ハードウエアの損傷の可能性や物理的な障害が発生する可能性を示しています。
重要: 重要な情報
実際に実施する前に注意すべき点を説明しています。
注記: 一般的な情報
一般的な補足情報を示しています。たとえばソフトウエアバージョン間での違いなどを説明しています。
ヒント: その他のヒント
ガイドラインや実践的なアドバイスなど、ヒントとなる情報を示しています。
簡潔な補足情報
一般的な補足情報を示しています。たとえばソフトウエアバージョン間での違いなどを説明しています。
ガイドラインや実践的なアドバイスなど、ヒントとなる情報を示しています。