[
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17479632#comment-17479632
]
Cassandra Targett commented on SOLR-15556:
------------------------------------------
Glad you worked around the build issues, Mike. Sorry I wasn't prepared to talk
about the Ref Guide today until a few minutes before the meeting and wasn't
anticipating people would want to play with the branch.
I have not made a PR yet and don't entirely feel ready at the moment.
The URL structure in nightlies is a consequence of an experiment I was trying
to have the version parsed from the branch name so it didn't need to be
manually edited (there's a comment about this here:
https://github.com/apache/solr/blob/jira/solr-15556-antora/solr/solr-ref-guide/antora.yml#L2).
It works locally, but not on Jenkins which seems to ignore branch names and
just uses HEAD and the Jenkins job is what pushed those files there so that's
how the URL got constructed. I was trying to fix that after leaving it for a
few days, and that's how I found the build bug with the Gradle-Antora plugin.
Of course it should be like our current structure; if I thought it should be
HEAD you should take me to a doctor.
In terms of older versions, since they are known and won't change going
forward, there's no problem just making some sort of static pull-down in the
UI. I was going to look at this today. There are ~20 versions before 9.0, so
it's going to be a long list, FYI.
> 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: Blocker
> Fix For: 9.0
>
>
> 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.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
