尝试构建Elasticsearch文档

动机

目前,Elasticsearch文档只有5.4版本的日本语翻译。最新版本是7.5。
5.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。

スクリーンショット 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.03.57.png

5. 翻译

我试着完成了这次的主要目标——翻译。我用翻译后的文件(本次使用的是 getting-started.asciidoc)替换并执行相同的构建命令。

 ./build_docs --doc ../elasticsearch/docs/reference/getting-started.asciidoc --lenient --open
スクリーンショット 2019-12-17 22.11.18.png

最后

实际上,我已经向Elasticsearch提交了上述翻译的Pull Request,但可惜被拒绝了。请参考以下链接:
https://github.com/elastic/elasticsearch/pull/49958
不幸的是,目前似乎不接受文档翻译方面的提交…
但是,为了学习的目的,我打算继续进行一些翻译。

尽管超过了Advent Calender的计划日期才发表,但内容变得空洞无物。
这一次,我试图构建单个页面,但将来也会尝试构建整个参考资料。

以上。

bannerAds