Asciidoctor support - #688
Conversation
This fixes a few Asciidoctor specific issues with the docs, specifically removing an `and` from an `ifeval` which is not supported by AsciiDoc and adding some substitutions that are not the default for Asciidoctor.
|
@nik9000 I can get this to build successfully with both docker/asciidoc and docker/asciidoctor! Fantastic progress. I noticed that with --asciidoctor, all of the versions of a single plugin appear on one page. Is that something we should address now or resolve in a later iteration? @jsvd FYI |
Hmmmm. I think we should grab it in a follow up change. This is progress and progress is good. |
There was a problem hiding this comment.
I can get this to build successfully with both docker/asciidoc and docker/asciidoctor! I/we can further investigate the pagination issue (mentioned in earlier comments) as a separate PR.
Update: Pagination works as expected with: ./build_docs --doc ../logstash-docs/docs/versioned-plugins/index.asciidoc --asciidoctor --chunk 1 --open
dedemorton
left a comment
dedemorton
left a comment
There was a problem hiding this comment.
LGTM. Just a couple of comment about updates required in logstash, too (which you're probably doing anyhow, but wanted to raise awareness).
I do not see the problem with the chunk level that Karen describes when --chunk 1 is specified.
| [id="{type}-{plugin}-index"] | ||
|
|
||
| == Versioned {plugin} {type} plugin docs | ||
| [subs="attributes"] |
There was a problem hiding this comment.
Same comment as before. This file also exists here: https://github.com/elastic/logstash/blob/master/docs/include/version-list-intro.asciidoc manually.
| @@ -1,6 +1,7 @@ | |||
| [id="{type}-{plugin}-index"] | |||
There was a problem hiding this comment.
ditto. this is copied from the logstash repo. Make sure you also apply the changes to the file in the logstash repo, too.
| @@ -1,9 +1,11 @@ | |||
| ifeval::["{versioned_docs}"!="true"] | |||
| [subs="attributes"] | |||
There was a problem hiding this comment.
Note that this file is a manual copy of https://github.com/elastic/logstash/blob/master/docs/include/plugin_header.asciidoc. Make sure you also apply the changes to the file in the logstash repo. Someday the plugin script will copy the file automatically (gotta dream big), but for now, we have to keep the file in sync manually.
|
Awesome! I'll merge this today and see about opening the changes to the logstash repo too! |
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
|
I've opened elastic/logstash#10730 . |
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite work on this repo, but it comes closer with these changes.
3 participants
This fixes a few Asciidoctor specific issues with the docs, specifically
removing an
andfrom anifevalwhich is not supported by AsciiDocand adding some substitutions that are not the default for Asciidoctor.