You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "Cassandra Targett (Jira)" <ji...@apache.org> on 2021/09/24 21:00:06 UTC

[jira] [Commented] (SOLR-15556) Ref Guide Redesign Phase 3: Replace Jekyll

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

Cassandra Targett commented on SOLR-15556:
------------------------------------------

I've updated my branch up to the latest Antora v3 alpha (alpha-9 by this point) but haven't done much more in about a month. The reason is because it requires some significant investment, and I haven't wanted to make that investment without being sure we're going to really try to do this.

I've updated the wiki page I started for this with some of the Go-No Go decisions we should make, and listed some major remaining TODOs. https://cwiki.apache.org/confluence/display/SOLR/Antora+Migration+Notes

I'm not entirely sure how to move forward from this point - a mailing list thread, I guess?

> 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-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org