Switch Python APM Agent docs to Asciidoctor #723
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Switches the core of the docs generation pipeline from the no-longer-maintained AsciiDoc project to the actively-maintained Asciidoctor project. The HTML that it produces isn't 100% the same but it looks to only differ in three ways: 1. Spacing that the browser will ignore anyway. 2. AsciiDoc was producing `<p></p>` inside of empty table cells. Asciidoctor does not. 3. In the 1.x docs there are some attribute references that do not resolve and they are rendered differently by Asciidoctor. Either way, they should probably be fixed in the 1.x branch of the docs.
|
Here is the diff: https://gist.github.com/nik9000/9b67d9c8732de19d5db34185181586b8 |
7 tasks
Closed
beniwohli
approved these changes
Mar 18, 2019
There was a problem hiding this comment.
Awesome stuff, LGTM! I made an issue in the agent repo for the bad references in the 1.x branch (elastic/apm-agent-python#423)
|
Thanks @beniwohli ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Switches the core of the docs generation pipeline from the
no-longer-maintained AsciiDoc project to the actively-maintained
Asciidoctor project. The HTML that it produces isn't 100% the same but
it looks to only differ in three ways:
<p></p>inside of empty table cells.Asciidoctor does not.
resolve and they are rendered differently by Asciidoctor. Either way,
they should probably be fixed in the 1.x branch of the docs.