[ 
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17390644#comment-17390644
 ] 

Houston Putman commented on SOLR-15556:
---------------------------------------

I really like the idea of including the Solr Operator docs in that way.

And I think it would be best not to have the base code in the 
{{solr/solr-ref-guide}} directory. Maybe we could have a gradle task that 
copies the necessary files to a code antora module, and have it very clear in 
the documentation that the code antora module is auto-generated via that gradle 
task.

{{gradle check}} could even make sure the files are correct and fail in case 
they are not in-sync.

> 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

Reply via email to