Skip to content

Commit

Permalink
updated contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
videnkz committed Nov 30, 2023
1 parent 7967f35 commit 588922b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 588922b

Please sign in to comment.