honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-25 17:38:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Update doc build info in README

Browse Source 
Original commit: elastic/x-pack-elasticsearch@c93986436c
This commit is contained in:
Lisa Cawley 2017-06-20 11:49:15 -07:00 committed by GitHub
parent 1e7f61b4c8
commit fe0c5cd3dc
1 changed files with 9 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.asciidoc
View File

@ -97,36 +97,24 @@ gradle clean install
= Building documentation
From version 5.5 onward, the source files in this repository can be included in either the X-Pack Reference or the Elasticsearch Reference.
The source files in this repository can be included in either the X-Pack Reference or the Elasticsearch Reference.
To build the X-Pack Reference (5.4 and later) on your local machine:
NOTE: In 5.5 and later, the Elasticsearch Reference includes X-Pack-specific content when it is built from this repo.
* Use the `index.asciidoc` file in the x-pack/docs/en repository.
* Specify the locations of the `x-pack-kibana/docs` and
`elasticsearch-extra/x-pack-exlasticsearch/docs` directories with
the `--resource` option when you run `build_docs.pl`.
To build the Elasticsearch Reference on your local machine:
* Use the `index.asciidoc` file in the docs/en directory.
* Specify the location of the `elasticsearch/docs` directory with the `--resource` option when you run `build_docs.pl`.
For example:
[source, txt]
-----
docs/build_docs.pl --doc x-pack/docs/en/index.asciidoc
--resource=x-pack-kibana/docs/ --resource=elasticsearch-extra/x-pack-elasticsearch/docs/
./docs/build_docs.pl --doc elasticsearch-extra/x-pack-elasticsearch/docs/en/index.asciidoc
--resource=elasticsearch/docs --chunk 1
-----
To build the Elasticsearch Reference (5.5 and later) on your local machine and include the X-Pack content:
* Use the `index-all.asciidoc` file in the elasticsearch/docs/reference repository.
* Specify the location of the `elasticsearch-extra/x-pack-exlasticsearch/docs` directory with
the `--resource` option when you run `build_docs.pl`.
For example:
[source, txt]
-----
docs/build_docs.pl --doc elasticsearch/docs/reference/index-all.asciidoc
--resource=elasticsearch-extra/x-pack-elasticsearch/docs/
-----
For information about building the X-Pack Reference, see the README in the x-pack repo.
== Adding Images