TEST crossdoc links for output-elasticsearch #1775
Closed
Conversation
This file contains 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
|
Test complete. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
TEST: DO NOT MERGE
Related: elastic/docs-tools#42
I've tested docs locally for logstash-plugins/logstash-output-elasticsearch#1197.
A local test can catch:
Example: Using the same anchor text in more than one place.
includeor referenced files or bad links (within the plugin doc or from the Logstash Reference)After we get a successful build, we can PREVIEW the doc to spot other formatting errors--not bad enough to fail, but ugly.
Example: Tables or bulleted lists not rendering properly.
A full doc build against all of elastic.co docs is the best way to be sure that we don't have any hidden cross-doc links coming from other docs. Example: Elasticsearch Reference linking to the elasticsearch output plugin. Fortunately, CI can handle this test case, hence this PR.
Obviously, if we have bad links coming from other docs, those links will need to be updated in the other doc(s).
Note to self @karenzone: Remind people that this ad hoc build strategy doesn't fully test docs generated with VPR builds. That is, even with this testing, we could still have introduced potential failures.
About this test
This PR is a result of manually copying the body of the plugin doc from logstash-plugins/logstash-output-elasticsearch#1197, and pasting it into the existing generated output in
logstash-docs. Then I let CI do the testing against our full Elastic.co doc set.