[
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17390630#comment-17390630
]
Cassandra Targett commented on SOLR-15556:
------------------------------------------
Here are my notes from a first pass at switching us over to Antora:
https://cwiki.apache.org/confluence/display/SOLR/Antora+Migration+Notes
The biggest current obstacle IMO is really that we are currently able to
include parts of files from other places in our source tree, and we do this for
code examples that we pull from existing tests. It's very nice to have code
examples which are kept up to date and get tested, but Antora demands that
these only exist inside the documentation directory structure. It makes sense
why Antora requires this, but it's kind of a problem for us...although not
being an active coder in Solr I'm not sure how big of a problem (if we moved
the tests so they lived in {{solr/solr-ref-guide/}} would they still get tested
right? Would devs still be able to find and update them easily?).
> Ref Guide Redesign Phase 3: Replace Jekyll
> ------------------------------------------
>
> Key: SOLR-15556
> URL: https://issues.apache.org/jira/browse/SOLR-15556
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Major
>
> The final step of my grand vision for redesigning the Ref Guide is to look at
> replacing Jekyll with a different static site generator.
> The primary reason why is because Jekyll is designed for blog posts, not for
> sites with hundreds of static pages like ours. Back in 2017 when I chose it,
> it was relatively straightforward to implement, a lot of information was
> available in Jekyll docs and the internet in general to customize it, and it
> was one of the few that supported Asciidoc format.
> However now there are a lot more options, including some which are
> specifically designed for large multi-version documentation sites like the
> Ref Guide.
> Included with this will be reorganizing the on-disk organization of the ref
> guide files themselves.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
