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/10/24 22:11:00 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=17433516#comment-17433516 ] 

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

I moved the Antora migration work from my fork to a branch {{jira/solr-15556-antora}} in the main repo: https://github.com/apache/solr/tree/jira/solr-15556-antora/

I built the UI bundle on my machine locally and put it on the nightlies server, and updated the Antora playbook.yml to use the bundle from that location: https://nightlies.apache.org/solr/draft-guides/ui-bundle.zip. We should maybe get a Jenkins job going to automate this, but it's not as simple as the overall Antora build so I haven't done it for now.

I was then able to set up a Jenkins job to test how Antora would build: https://ci-builds.apache.org/job/Solr/job/solr-reference-guide-antora/

It just worked, the resulting build is now in: https://nightlies.apache.org/solr/draft-guides/solr-reference-guide-antora

So that's one blocking question answered. I did not end up asking the Infra team, as there are other projects also using Antora as a central part of their docs process, and it's very self-contained with the antora-gradle plugin, so I can't see it going away any time soon.

> Ref Guide Redesign Phase 3: Replace Jekyll
> ------------------------------------------
>
>                 Key: SOLR-15556
>                 URL: https://issues.apache.org/jira/browse/SOLR-15556
>             Project: Solr
>          Issue Type: Improvement
>          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