Skip to content

Switch APM Server to Asciidoctor - #1083

Merged
bmorelli25 merged 1 commit into
elastic:masterfrom
bmorelli25:apm-server-asciidoctor
Aug 29, 2019
Merged

Switch APM Server to Asciidoctor#1083
bmorelli25 merged 1 commit into
elastic:masterfrom
bmorelli25:apm-server-asciidoctor

Conversation

@bmorelli25

@bmorelli25 bmorelli25 commented Aug 19, 2019

Copy link
Copy Markdown
Member

See elastic/apm-server#1965 for all updates.

📖⛷👨‍⚕

@bmorelli25
bmorelli25 requested a review from nrichers August 19, 2019 20:51
@bmorelli25 bmorelli25 self-assigned this Aug 19, 2019
@bmorelli25
bmorelli25 requested review from nik9000 and removed request for nrichers August 19, 2019 20:51
@bmorelli25

Copy link
Copy Markdown
Member Author

Sorry, tagged the wrong Nik initially.

@bmorelli25

Copy link
Copy Markdown
Member Author

Well, dang.

INFO:build_docs:/tmp/docsbuild/target_repo/html/en/apm/server/7.1/index.xml:1533: element xref: validity error : IDREF attribute linkend references an unknown ID "configuration-autodiscover-hints"

Which is here:
https://github.com/elastic/apm-server/blame/4e817c7da50b58e8a8ba9dbafed4902b3ad3a0b5/docs/copied-from-beats/shared-docker.asciidoc#L198-L217

The problem is that this shouldn't even be executed. The if should evaluate to false and not display at all.

@nik9000

nik9000 commented Aug 19, 2019 via email

Copy link
Copy Markdown
Member

@bmorelli25

Copy link
Copy Markdown
Member Author

@elasticmachine, run elasticsearch-ci/docs

@bmorelli25

bmorelli25 commented Aug 20, 2019

Copy link
Copy Markdown
Member Author

New errors below. Chatted with Nik. These are because asciidoctor and asciidoc handle links differently. One uses _ and the other uses _literal. I need to update these cross doc links to fix.

09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/apm/agent/js-base/4.x/getting-started.html:
09:33:28 INFO:build_docs:   - en/apm/server/current/configuration-rum.html#_literal_allow_origins_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/apm/agent/js-base/current/getting-started.html:
09:33:28 INFO:build_docs:   - en/apm/server/current/configuration-rum.html#_literal_allow_origins_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/apm/agent/js-base/master/getting-started.html:
09:33:28 INFO:build_docs:   - en/apm/server/current/configuration-rum.html#_literal_allow_origins_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/apm/agent/rum-js/4.x/getting-started.html:
09:33:28 INFO:build_docs:   - en/apm/server/current/configuration-rum.html#_literal_allow_origins_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/apm/agent/rum-js/current/getting-started.html:
09:33:28 INFO:build_docs:   - en/apm/server/current/configuration-rum.html#_literal_allow_origins_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/apm/agent/rum-js/master/getting-started.html:
09:33:28 INFO:build_docs:   - en/apm/server/current/configuration-rum.html#_literal_allow_origins_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud-heroku/current/ech-manage-apm-settings.html:
09:33:28 INFO:build_docs:   - en/apm/server/7.3/configuration-rum.html#_literal_library_pattern_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud-heroku/release-ms-25/ech-manage-apm-settings.html:
09:33:28 INFO:build_docs:   - en/apm/server/7.3/configuration-rum.html#_literal_library_pattern_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud/current/ec-manage-apm-settings.html:
09:33:28 INFO:build_docs:   - en/apm/server/7.3/configuration-rum.html#_literal_library_pattern_literal
09:33:28 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud/release-ms-25/ec-manage-apm-settings.html:
09:33:28 INFO:build_docs:   - en/apm/server/7.3/configuration-rum.html#_literal_library_pattern_literal

@bmorelli25

Copy link
Copy Markdown
Member Author

@elasticmachine, run elasticsearch-ci/docs

@bmorelli25

bmorelli25 commented Aug 20, 2019

Copy link
Copy Markdown
Member Author

Oooo exciting! elasticsearch-ci/docs passes! The diff is a bit crazy right now: http://docs_1083.docs-preview.app.elstc.co/diff.

Still a lot of PRs to merge that should hopefully reduce the changes.

Blocked by:

@bmorelli25

Copy link
Copy Markdown
Member Author

@elasticmachine, run elasticsearch-ci/docs

@bmorelli25

Copy link
Copy Markdown
Member Author

To consolidate things, I'm going to stop posting updates in this PR. All updates will now be in the meta issue: elastic/apm-server#1965.

@nik9000 nik9000 mentioned this pull request Aug 28, 2019
@bmorelli25

Copy link
Copy Markdown
Member Author

@elasticmachine, run elasticsearch-ci/docs

@nik9000 nik9000 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM any time!

@bmorelli25 bmorelli25 removed the WIP label Aug 29, 2019
@bmorelli25

bmorelli25 commented Aug 29, 2019

Copy link
Copy Markdown
Member Author

Everything looks ready 🤞.

@bmorelli25
bmorelli25 merged commit cff849a into elastic:master Aug 29, 2019
@bmorelli25
bmorelli25 deleted the apm-server-asciidoctor branch August 29, 2019 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants