Help us understand the problem. What is going on with this article?

Elasticsearch docsをビルドしてみた

動機

現在、Elasticsearchのドキュメントは日本語翻訳版がv5.4のものしかありません。最新リリースはv7.5。
v5.4リファレンス
Elasticドキュメント
そこで、社内の成果発表ネタの意味も兼ねて、最新版の翻訳に貢献しようと思ったのが本記事の動機です。
ElasticsearchのドキュメントはAsciidocで書かれていて、以下にビルドツールも公開されていますので、
今回はそれを使ったビルドを試してみました。
https://github.com/elastic/docs

手順

1. ドキュメントビルドツールのソースのクローン

git clone https://github.com/elastic/docs.git

2. ビルド&実行

cd docs/
./build_docs --doc README.asciidoc --open

※dockerをインストールしている必要があります。

ビルドが終わると、ブラウザが立ち上がり以下のようなページが開きます。
--doc にビルド対象を指定、また、--openオプションを指定することでビルド後に自動的にブラウザを立ち上げ、ページを表示します。
スクリーンショット 2019-12-17 19.58.16.png

3. Elasticsearchソースのクローン

上でビルドしたのは本ビルドツールのチュートリアル用ページといった感じで、Elasticsearchやその他Elastic製品のドキュメントとは異なります。
次はElasticsearchのドキュメントをビルドしてみます。
ドキュメント全体のビルドなど後々のために、ドキュメントビルドツールのディレクトリ(docs)と同じ場所にクローンするのが良さそうです。

git clone https://github.com/elastic/elasticsearch.git

4. ビルド

今回はひとまず単一のページをビルドしてみます。

 ./build_docs --doc ../elasticsearch/docs/reference/getting-started.asciidoc --lenient --open

--lenient オプションを指定すると、別ファイルとの依存関係等によるエラーを無視して実行することができます。

以下のようなページが作成されました。
スクリーンショット 2019-12-17 22.02.29.png
スクリーンショット 2019-12-17 22.03.57.png

5. 翻訳

今回の主目的である翻訳をしてみました。
翻訳後のファイル(今回は getting-started.asciidoc)を差し替えて同様のビルドコマンドを実行。

 ./build_docs --doc ../elasticsearch/docs/reference/getting-started.asciidoc --lenient --open

翻訳後のページを作成できました。
スクリーンショット 2019-12-17 22.11.01.png
スクリーンショット 2019-12-17 22.11.18.png

おわりに

実のところ、Elasticsearchに上記翻訳のプルリクを投げたのですが、見事に弾かれました。下記参照。
https://github.com/elastic/elasticsearch/pull/49958
悲しいことに、現在ドキュメント翻訳のコミットは受け付けていない様子。。
ですが、勉強も兼ねてもう少し翻訳は続けていこうと思っています。

Advent Calenderの予定日を過ぎて投稿しているにも関わらずの薄い内容になってしまいました。:bow_tone1:
今回はページ単体のビルドを試しましたが、今後リファレンス全体のビルドも試すつもりです。

以上。

u_hato
掲載内容は私個人の見解であり、所属する組織の公式見解ではありません。
fujitsu
富士通グループのソフトウェア技術者有志により運営しているコミュニティです。
http://www.fujitsu.com/jp
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした