From b5e15ed6dac42a33e3c7fb5c7fd3d1fa04a97a61 Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Mon, 18 Mar 2019 12:59:47 -0400 Subject: [PATCH 1/2] Switch APM Overview to Asciidoctor Switches the core of the docs build for the APM overview from the unmaintained AsciiDoc to the actively maintained AsciiDoctor project. It is marginally faster to build as well. The HTML output is the same modulo some spacing differences and one real change to the tables on the `install-and-run` page. The first element on the table gets the "heading" formatting. Like this: ``` - - Introduction - + + + + Introduction + + + ``` This is worth looking into. It isn't what we want but I can see *why* Asciidoctor does it. --- conf.yaml | 1 + doc_build_aliases.sh | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index 31346f13b9f10..f1f2050bf7801 100644 --- a/conf.yaml +++ b/conf.yaml @@ -838,6 +838,7 @@ contents: chunk: 1 tags: APM Server/Reference subject: APM + asciidoctor: true sources: - repo: apm-server diff --git a/doc_build_aliases.sh b/doc_build_aliases.sh index 6b048065b5f49..dbdfe61aa79e3 100644 --- a/doc_build_aliases.sh +++ b/doc_build_aliases.sh @@ -78,7 +78,7 @@ alias docbldab='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/beats/auditbeat/doc alias docbldabx='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/beats/auditbeat/docs/index.asciidoc --resource=$GIT_HOME/beats/x-pack/auditbeat --chunk 1' # APM -alias docbldamg='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/apm-server/docs/guide/index.asciidoc --chunk 1' +alias docbldamg='$GIT_HOME/docs/build_docs --asciidoc --doc $GIT_HOME/apm-server/docs/guide/index.asciidoc --chunk 1' alias docbldamr='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/apm-server/docs/index.asciidoc --chunk 1' From 0bc898d9842531568289bf246733008dcf2d1b18 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 20 Mar 2019 12:40:30 -0400 Subject: [PATCH 2/2] Update doc_build_aliases.sh Co-Authored-By: nik9000 --- doc_build_aliases.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_build_aliases.sh b/doc_build_aliases.sh index dbdfe61aa79e3..103ba7982faf4 100644 --- a/doc_build_aliases.sh +++ b/doc_build_aliases.sh @@ -78,7 +78,7 @@ alias docbldab='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/beats/auditbeat/doc alias docbldabx='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/beats/auditbeat/docs/index.asciidoc --resource=$GIT_HOME/beats/x-pack/auditbeat --chunk 1' # APM -alias docbldamg='$GIT_HOME/docs/build_docs --asciidoc --doc $GIT_HOME/apm-server/docs/guide/index.asciidoc --chunk 1' +alias docbldamg='$GIT_HOME/docs/build_docs --asciidoctor --doc $GIT_HOME/apm-server/docs/guide/index.asciidoc --chunk 1' alias docbldamr='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/apm-server/docs/index.asciidoc --chunk 1'