-
Notifications
You must be signed in to change notification settings - Fork 62
Build LSR Plugin docs from this repo #1817
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
Conversation
Signed-off-by: bmorelli25 <brandon.morelli@elastic.co>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this work, Brandon. Is there any value to my generating updated docs for main so that we have the latest content in this PR?
Any updated plugin docs for main and 9.0 will need to have include_path: updated in the generated output PR (because that value is set in the logstash-plugins source doc.
For example: https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/main/docs/index.asciidoc?plain=1#L11)
Another candidate for docs tooling later, and an easy manual fix for now.
|
FYI @bmorelli25: Please don't backport to Does it make sense for us to generate and merge |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
We're already in a place where we can't build stack-versioned plugin docs for main and 9.0 due to file changes/dependencies in logstash repo, so no worries about breaking capabilities.
IMPORTANT: DO NOT BACKPORT to 9.0 (related to gemlock file dependencies). Let's discuss.
Why
As a part of our migration to Elastic Docs V3, we need to single-source the LSR docs from this repo. Currently, in the asciidoc system, the LSR docs are built from the logstash repo with this repo set up as a dependency. This PR moves the relevant documentation required to build the LSR docs from the logstash repo to this repo.
What this PR does
Copies the
docs/includedir from elastic/logstash to this repo underdocs/plugins/. The final dirpath isdocs/plugins/include.Copies the
docs/static/core-plugins dirfrom elastic/logstash to this repo underdocs/plugins. The final dirpath isdocs/plugins/static/core-plugins/.Finds and replaces:
Find:
../../../../logstash/docs/includeReplace:
../includeFinds and replaces:
Find:
../../../logstash/docs/static/Replace:
./static/Finds and replaces:
Find:
../../includeReplace:
../../../includeRun with Asciidoc
Run with adoc-to-md
run.shto: