aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--readmes/README_ja_JP.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md
index 201092f..b0e3b4c 100644
--- a/readmes/README_ja_JP.md
+++ b/readmes/README_ja_JP.md
@@ -6,22 +6,26 @@
1. [説明](#description)
2. [セットアップ - augeas_core導入の基本](#setup)
* [セットアップ要件](#setup-requirements)
- * [augeas_coreモジュールの利用方法](#beginning-with-augeas_core)
+ * [augeas_coreモジュールの利用方法](#beginning-with-augeas)
3. [使用 - 設定オプションと追加機能](#usage)
4. [参考 - モジュールの機能と動作について](#reference)
5. [制約 - OS互換性など](#limitations)
6. [開発 - モジュール貢献についてのガイド](#development)
+<a id="description"></a>
## 説明
`augeas_core`モジュールは、Augeasを用いた設定の管理に使用されます。このモジュールは、AugeasライブラリとRubyバインディングが存在するホストに適しています。
+<a id="setup"></a>
## セットアップ
+<a id="setup-requirements"></a>
### セットアップ要件
このモジュールを使用するには、AugeasライブラリとRubyバインディングをインストールする必要があります。`puppet-agent`パッケージを使用している場合は、ほとんどのプラットフォームでこの前提条件は満たされています。
+<a id="beginning-with-augeas"></a>
### augeas_coreモジュールの利用方法
`augeas`を用いて設定ファイルを管理するには、以下のコードを使用します。
@@ -40,10 +44,12 @@ augeas { 'add_services_entry':
}
```
+<a id="usage"></a>
## 使用
利用方法の詳細については、[augeas puppetドキュメント](https://puppet.com/docs/puppet/latest/types/augeas.html)および[例](https://puppet.com/docs/puppet/latest/resources_augeas.html)を参照してください。
+<a id="reference"></a>
## リファレンス
リファレンス文書については、REFERENCE.mdを参照してください。
@@ -59,10 +65,12 @@ bundle exec puppet strings generate ./lib/**/*.rb
```
このコマンドにより、閲覧可能な`_index.html`ファイルが`doc`ディレクトリに作成されます。ここで利用可能なリファレンスはすべて、コードベースに埋め込まれたYARD形式のコメントから生成されます。このモジュールに関して何らかの開発をする場合は、影響を受ける文書も更新する必要があります。
+<a id="limitations"></a>
## 制約
このモジュールは、AugeasライブラリおよびRubyバインディングがインストールされたプラットフォームでのみ使用できます。
+<a id="development"></a>
## 開発
Puppet ForgeのPuppet Labsモジュールは、オープンプロジェクトです。プロジェクトをさらに発展させるには、コミュニティへの貢献が不可欠です。Puppetが役立つ可能性のある膨大な数のプラットフォーム、無数のハードウェア、ソフトウェア、デプロイメント構成に我々がアクセスすることはできません。