Skip to content

Commit a544d21

Browse files
utenmikibrixen
authored andcommitted
translate write-documentation.markdown into Japanese
1 parent 8ee9afd commit a544d21

File tree

1 file changed

+40
-41
lines changed

1 file changed

+40
-41
lines changed

doc/ja/how-to/write-documentation.markdown

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,20 @@ next_url: how-to/translate-documentation
88
translated: true
99
---
1010

11-
Rubiniusのドキュメントは、Webサイトやブログに統合されています。これは、使用して
12-
Jekyllは単に他のコンポーネントと同様に。
11+
Rubiniusのドキュメントは、Webサイトとブログで構成されています。他の部分と同じくJekyllを使用しています。
1312

14-
開始するには`kramdown`は、インストール`jekyll`宝石を持っていることを確認します
13+
始めに`kramdown``jekyll`がインストールされていることを確かめてください
1514

1615
rbx gem install jekyll kramdown
1716

18-
ドキュメントのソースは、`web/doc`のディレクトリの下にあります。があります。
19-
各言語のサブディレクトリは、ドキュメントがされていると
20-
(例:`en`は、`ja`を、など)が翻訳されています。
17+
ドキュメントは、`web/doc`のディレクトリにあります。
18+
各言語のサブディレクトリには、翻訳されたドキュメントががあります。(例えば、`en``es`など)
2119

22-
目次は、例えば各翻訳(のためにそこにいる
23-
`/web/doc/ja/index.markdown`に)。ドキュメントの残りの部分は、構成されています
24-
YAMLはドキュメントがどのように指定する属性を持つ単一のファイル
25-
接続されています。基本的には、マニュアルのように表示することができます二重にリンクされている
26-
を指して、各ドキュメントとドキュメントのリストを前と次の
27-
ドキュメント。内容文書の表は、完全な構造を示しています。
20+
翻訳毎に目次があります。(例えば、`/web/doc/ja/index.markdown`)。
21+
ドキュメントののこちの部分は、どのように他のドキュメントとリンクが張ってあるかというYAMLの属性から成る単一のファイルです。
22+
基本的に、ドキュメントは前後のドキュメントにリンクが張ってある双方向リストとみなせます。
2823

29-
YAMLは次のようなドキュメントを見ての属性:
24+
ドキュメントのYAMLの属性は下記の通りです。
3025

3126
---
3227
layout: doc_en
@@ -37,41 +32,45 @@ YAMLは次のようなドキュメントを見ての属性:
3732
next_url: how-to/translate-documentation
3833
---
3934

40-
_layout_の書式設定時に使用するジキルのレイアウトを指定する
41-
ドキュメント。 _layout_は`doc_LANGする必要があります、_LANG_は、ISO- 639- 2です
42-
言語のコード。
35+
_layout_は、どのレイアウトをjekyllが使用するか指定します。
36+
_layout_の_LANG_は、ISO-639-2の`doc_LANGにしなければいけません。
4337

44-
_title_の上部に表示されている文書のタイトルを指定します。
45-
ページを表示します。
38+
_title_は、ページの上部に表示されるドキュメントのタイトルを指定します。
4639

47-
_previous_と_previous\_url_属性は、タイトルとリンクを与える
48-
以前のドキュメント。同様に、_next_と_next\_url_属性を与える
49-
タイトルと、次のドキュメントのリンクをクリックします。これらは、閲覧を強化するために使用されている
50-
ドキュメントや作業量を再注文部品の必要な制限
51-
マニュアルを参照してください
40+
_previous_と_previous\_url_属性で、前のドキュメントのタイトルとリンクを指定します。
41+
同様に、_next_と_next\_url_属性で、後のドキュメントのタイトルとリンクを指定します。
5242

43+
これらはドキュメントの閲覧を便利にする、再度ドキュメントを書くときに必要な作業量を削減するためです。
5344

54-
### 編集既存のドキュメントを
45+
RubiniusのリポジトリにJekyllで生成したドキュメントとファイルがコミットされます。リポジトリをクローンしたら、Rubiniusをインストールする前かRubiniusのビルドに問題があるとき
46+
`rake docs`でドキュメントを閲覧することができます。
5547

56-
ドキュメントの最初のアウトラインが作成されています。たくさんいる
57-
単に必要なトピックでは、それらのために書かれたドキュメントを持っている。
48+
### 既存ドキュメントの編集
5849

59-
既存のトピックのドキュメントを追加する、または既存のドキュメントを修正する
60-
`web/doc/LANG`は下のトピックのファイルを開いて、追加または改善
61-
マニュアルを参照してください
50+
ドキュメントの最初のアウトラインが作成されています。
51+
ドキュメントを書く必要がある話題がたくさんあります。
6252

53+
既に存在している話題にドキュメントを追加するかドキュメントを修正する場合:
6354

64-
### 新しいドキュメントを追加する
55+
1. `web/doc/LANG`の下のファイルを開く。
56+
1. ドキュメントの追加または改善を行う。
57+
1. 作業中のドキュメントのアップデートを見る。
58+
`web/`ディレクトリで`rbx -S jekyll serve --watch`を実行する。
59+
1. ドキュメントの追加または編集が終了したら、ソースコードの変更をコミットする。
60+
1. `web/`ディレクトリで`rbx -S jekyll build`を実行し、`web/_site`の全てのファイルを強制的にアップデートする。
61+
1. 生成したファイルをコミットする。変更が少ない場合、ドキュメントのソースコードと生成したファイルをコミットしてください。
62+
変更が多い場合、レビューでの変更が単純になるように生成したファイルを個別にコミットしてください。
6563

66-
既存のトピックでは、存在するのドキュメントを追加するには:
64+
### 新しいドキュメントの追加
6765

68-
1. Create a new file with the .markdown extension under `web/doc/LANG`.
69-
1. Set up the attributes to link the new file into the existing files. This
70-
will require editing the _previous_ and _next_ attributes of the existing
71-
files to insert the new file, as well as adding an entry to
72-
`index.markdown`.
73-
1. To view your updates while you are working on them, run
74-
`rbx -S jekyll serve --watch`
75-
1. Edit the new file using Markdown syntax.
76-
1. In the `web/` directory, run `rbx -S jekyll build`.
77-
1. Commit all the changes in the `web/` directory.
66+
存在してない話題をのドキュメントを追加する場合:
67+
68+
1. `web/doc/LANG`に.markdown拡張子のファイルを作成する。
69+
1. 既に存在してるファイルから新しいファイルにリンクを張るために属性を記述する。
70+
`index.markdown`と既に存在しているファイルの_previous__next_ attributesに新しいファイルへのリンクを記述することが必要です。
71+
1. 作業中にアップデートしたドキュメントを見るには、`rbx -S jekyll serve --watch`を実行します。
72+
1. マークダウン記法で新しいファイルを編集します。
73+
1. ドキュメントの追加または編集が終わったら、変更をコミットしてください。
74+
1. `rbx -S jekyll build` in the `web/` を実行し、`web/_site`で生成されているファイルを強制的にアップデートしてください。
75+
1. 生成したファイルをコミットする。変更が少ない場合、ドキュメントのソースコードと生成したファイルをコミットしてください。
76+
変更が多い場合、レビューでの変更が単純になるように生成したファイルを個別にコミットしてください。

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy