elastic / elastic/docs-tools

Validate doc changes (asciidoc formatting, cross-document links) for plugin doc source

Open
#42 5 comments 0 reactions 1 assignee Claimed by @mashhurs View on GitHub
LSR VPR
Dominant language
Ruby
Stars
4
Forks
12
PR merge metrics
No merged PRs in 30d

Description

The `logstash` and `logstash-docs` repos now have the ability to do a complete doc build and throw errors if there are asciidoc formatting errors, bad cross-document links, etc. Our plugin docs are spread out in repos throughout the `logstash-plugins` org. Any doc errors don't manifest until we generate and transform the plugin docs, and they land in `logstash-docs`.

Could we validate doc changes sooner?

This enhancement has been needed for a long time. See
[Create infrastructure for testing plugin docs for a single plugin #19](https://github.com/elastic/docs-tools/issues/19). It was closed due to inactivity, not because it was resolved.

UPDATED:
~This issue is especially painful because of a regression that passes a bad Logstash Versioned Plugin Reference to the elastic doc build and then crashes it: #51~ Thankfully, this issue has been resolved.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.