diff --git a/README.md b/README.md index 272db281f..3477f9147 100644 --- a/README.md +++ b/README.md @@ -122,13 +122,14 @@ Example: Drip does not work with STDIN. You cannot use drip for running configs which use the stdin plugin. -## Building Logstash documentation +## Building Logstash Documentation -To build the Logstash Reference on your local machine, clone the following repos: +To build the Logstash Reference (open source content only) on your local +machine, clone the following repos: -[logstash]https://github.com/elastic/logstash - contains main docs about core features -[logstash-docs]https://github.com/elastic/logstash-docs - contains generated plugin docs -[docs]https://github.com/elastic/docs - contains doc build files +[logstash](https://github.com/elastic/logstash) - contains main docs about core features +[logstash-docs](https://github.com/elastic/logstash-docs) - contains generated plugin docs +[docs](https://github.com/elastic/docs) - contains doc build files Make sure you have the same branch checked out in `logstash` and `logstash-docs`. Check out `master` in the `docs` repo. @@ -139,9 +140,6 @@ Run the doc build script from within the `docs` repo. For example: ./build_docs.pl --doc ../logstash/docs/index.asciidoc --chunk=1 -open ``` -To build the Logstash Reference with X-Pack content, see -the [x-pack-logstash readme]https://github.com/elastic/x-pack-logstash#building-documentation. - ## Testing Most of the unit tests in Logstash are written using [rspec](http://rspec.info/) for the Ruby parts. For the Java parts, we use junit. For testing you can use the *test* `rake` tasks and the `bin/rspec` command, see instructions below: