From 588922b9a8713ea77d128b2ea1b72ebedf0415d7 Mon Sep 17 00:00:00 2001 From: Nugusbayev Kanagat Date: Fri, 1 Dec 2023 01:40:06 +0600 Subject: [PATCH] updated contributing.md --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8707aee2de..7b3eb809be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -265,8 +265,9 @@ See [`apm-agent-plugins/README.md`](apm-agent-plugins/README.md) HTML Documentation is generated from text files stored in `docs` folder using [AsciiDoc](http://asciidoc.org/) format. The `configuration.asciidoc` file is generated from running `co.elastic.apm.agent.configuration.ConfigurationExporter` -(e.g. via `./mvnw -Dsurefire.failIfNoTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test`). All the other asciidoc text files -are written manually. +(e.g. via `./mvnw -Dsurefire.failIfNoTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test` +or on Windows `./mvnw '-Dsurefire.failIfNoTests=false' '-Dsurefire.failIfNoSpecifiedTests=false' -Dtest=ConfigurationExporterTest -pl apm-agent-builds/apm-agent -am clean test`). +All the other asciidoc text files are written manually. A preview of the documentation is generated for each pull-request. Click on the build `Details` of the `elasticsearch-ci/docs` job and go to the bottom of the `Console Output` to see the link.