[
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17488847#comment-17488847
]
Cassandra Targett commented on SOLR-15556:
------------------------------------------
I'm really sorry for my silence reviewing the hard work you've been doing here
[~houston]. I started to look at it on Sunday and got called away.
In terms of To Do items left, these two can be done anytime IMO:
* Remove all of the old jekyll build files. (jekyll is completely removed from
the gradle build already)
* Find locations for the content in src/old-pages, if we want to keep it around.
Those old `src/old-pages` were just me keeping them around in case anyone
didn't like that I'd removed them or if I changed my o wn mind about removing
them.
I still hope I can get to this item:
* Fixup the landing page, including the links that are currently broken.
If I can't by the end of this week I will speak up about it.
And for this item:
* Add documentation around building locally
There are also a few READMEs and other docs in `dev-docs/ref-guide` which need
to be updated. Some of that can wait, but we should probably excise everything
about build dependencies and Jekyll before merging in case other committers
want to check this work out and get confused expecting those files to be
correct. If the release wizard gets updated then the "how to publish" docs
should reflect that workflow (which I confess I have not been paying close
attention to).
Thank you for adding the antora-lunr plugin - I kept getting completely
distracted trying to figure out how to add that. It's awesome to finally have
any search, although I feel a pang it's not Solr. It's worth it though.
> 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]
