GH: Add action to build 9.x series plugin docs #1826
Closed
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
karenzone
commented
Mar 19, 2025
| bundle exec ruby plugindocs.rb --skip-existing --output-path ../logstash-docs ../logstash/plugins_version_docs.json | ||
| - name: Build docs | ||
| working-directory: ./logstash | ||
| run: ../docs/build_docs --asciidoctor --respect_edit_url_overrides --doc docs/index.asciidoc --resource=../logstash-docs/docs/ --chunk 1 # sub in new V3 build command |
There was a problem hiding this comment.
Sub in new V3 build command
There was a problem hiding this comment.
We're still building this repo in ADOC, so this shouldn't be a V3 command.
Tweaked in latest commit.
|
@bmorelli25 For evaluation/consideration. |
|
@jsvd This is the idea I mentioned in our 1:1. Will you please take a look and see if there's potential here? |
karenzone
commented
Mar 31, 2025
| bundle exec ruby plugindocs.rb --skip-existing --output-path ../logstash-docs ../logstash/plugins_version_docs.json | ||
| - name: Build docs | ||
| working-directory: ./logstash-docs | ||
| run: ../docs/build_docs --asciidoctor --respect_edit_url_overrides --doc docs/index.asciidoc --chunk 1 |
There was a problem hiding this comment.
@karenzone Bet this path needs adjusting (/lsr/)
karenzone
commented
Mar 31, 2025
| bundle exec ruby plugindocs.rb --skip-existing --output-path ../logstash-docs ../logstash/plugins_version_docs.json | ||
| - name: Build docs | ||
| working-directory: ./logstash-docs | ||
| run: ../docs/build_docs --asciidoctor --respect_edit_url_overrides --doc docs/index.asciidoc --chunk 1 |
There was a problem hiding this comment.
Suggested change
| run: ../docs/build_docs --asciidoctor --respect_edit_url_overrides --doc docs/index.asciidoc --chunk 1 | |
| run: ../docs/build_docs --asciidoctor --respect_edit_url_overrides --doc docs/lsr/index.asciidoc --chunk 1 |
|
Can we backport #1817 to 9.0? |
|
WRT backport: |
|
Closing to avoid confusion. |
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.
Related: elastic/docs-tools#110
Heavy lifting for plugin generation is handled by plugindocs.rb. The GitHub action is where we reach out to the
logstashrepo looking for LSR doc files.Backstory
Until recently, the generated Logstash plugins docs were pulled in with
:include:statements and built as part of the Logstash Reference (logstashrepo). File format = asciidoc.With the introduction of the new Elastic doc build system, we converted the Logstash Reference docs source to MD. This change breaks our ability to generate Logstash plugin docs for
9.xandmain.This PR preserves existing GitHub action behavior for 8.x and earlier doc generation, and adds a new GitHub action to generate docs for
9.xand.main.New: "Plugin docgen for specified 9.0 and later"
Renamed: "Plugin docgen for specified 8.x and earlier"
Note: Both GitHub actions still generate output in ADOC format. For
9.0and later, the migration to MD will be a subsequent process. Check out [Research] Use a GitHub action as a wrapper for migration tooling #10 for an idea.