[
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17484976#comment-17484976
]
Houston Putman commented on SOLR-15556:
---------------------------------------
I've pushed some changes now.
* {{antora.yml}} is now auto-generated from {{{}antora.yml.template{}}}, with
all of the variables we need hardcoded for the branch. This is done whenever
{{./gradle antora}} is invoked.
* I've also updated the ui-bundle.zip to have a correct url for the Solr
Javadocs.
* Merged with changes from {{main}} after a lot of refactoring upstream
One large thing we need to fix is that there are links to section pages from
the homepage, and 1/6 of them exists. We either need to find new pages to link
to, or write those pages from scratch.
Next things to work on:
* Have a better workflow for local development & release building. There
should be no need to manually edit the playbook in order to test things out
* We need to mimick the build trickery that allowed the link-checker to
resolve solr javadocs links to a local folder instead of the solr webpage
(because the docs won't live at that location yet), otherwise a link checker
will always fail for the Solr javadocs.
> 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: [email protected]
For additional commands, e-mail: [email protected]
