[
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17486735#comment-17486735
]
Houston Putman commented on SOLR-15556:
---------------------------------------
Ok you can now build a custom ui bundle with {{gradle buildUIBundle}}, and you
can build the site with a custom bundle via {{gradle buildSite
-Prefguide.buildLocalUI}}. The {{ui-bundle.zip}} will be deposited under
{{solr-ref-guide/build/dist/}}.
I have also eliminated most of the code under {{{}solr-ref-guide/ui{}}}, since
it's basically a fork of [https://gitlab.com/antora/antora-ui-default]. Instead
I have moved non-identical files to {{solr-ref-guide/ui-src}}, which merely
over-writes the latest checkout of
[https://gitlab.com/antora/antora-ui-default] when building. I have also gone
through and noted all Solr-changes that have been made to these files that we
are overwriting. That way it will be easier to fast-forward the files they are
based on when changes to [https://gitlab.com/antora/antora-ui-default] are
made. We should make sure that all future changes to these files use these
annotations as well.
Much like the build of the actual site, all NPM business is done in gradle
directories. However unlike the site-build, the {{buildUIBundle}} task requires
the NPM tasks to use the {{build/ui}} directory. So it will take a minute or so
to complete after doing a {{gradle clean}}. This isn't an issue though since
the vast majority of devs will never have to touch this stuff.
Note: The local UI build uses the latest version of the anota-ui-default it can
find. Hopefully they start version controlling the repo in the future and we
can explicitly upgrade. In the meantime we can use commit hashes to ensure we
aren't upgrading when we don't want to.
Now that we have a nifty task to build this UI Bundle, we should probably make
a jenkins task to build it and upload it to the official location. Should be
pretty easy, but no need to necessarily do it now.
> 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]
