-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Validate doc changes (asciidoc formatting, cross-document links) for plugin doc source #42
Comments
@roaksoax Here's the issue you requested. Please feel free to add additional commentary. Thanks! |
@mashhurs Thank you for looking into this. This is an interesting one, and it will require some planning and design. When we generate plugin docs (for either the LSR or the VPR), those variables are populated with relevant info... plugin version, release date, etc. I need 1.) those values to be populated and 2.) the file to be pulled into the LSR framework before I can build and test. As a work-around, I make (or fake?) my own test harness. :-) My current workflow to test plugin doc changes locallyIMPORTANT: I am not proposing replicating this workflow in the solution. This info is here as an explanation of the workaround to achieve the necessary results.
Notes
|
@gtback from the infra team specializes in docs tooling work for elastic.co. Looping him in because he might have some ideas that can use some of our existing docs infrastructure to contribute to these goals. |
Thanks @karenzone . Happy to chat with @mashhurs about this any time. We can probably automate and set up a process for testing Logstash Plugin PRs before they get into the main docs build (and so you don't have to test them manually). I'm not sure if it will be worth the time invested given the migration to the new docs system, but we can figure that out 😉 . |
Update (new issue): |
The
logstash
andlogstash-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 thelogstash-plugins
org. Any doc errors don't manifest until we generate and transform the plugin docs, and they land inlogstash-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. 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: #51Thankfully, this issue has been resolved.The text was updated successfully, but these errors were encountered: