Hey everyone. The new ref guide is officially merged into all relevant
branches (down to branches_9_0). Luckily, there shouldn't be much change to
your workflow!

*Building*
In order to build a local site, use: "gradlew buildLocalSite", or just
"gradlew assemble".
The output will be in "solr/solr-ref-guide/build/site/index.html", but this
is also output when the task is run.

*Page source*
The source for the pages is now found under the
"solr/solr-ref-guide/modules" directory. At first it might be hard to find
files, but they are pretty logically separated out.

The syntax is still asciidoctor, but there is a large change in how you
link between pages in the ref guide. You can find lots of examples
throughout the existing pages, but it is documented here:
https://github.com/apache/solr/blob/main/dev-docs/ref-guide/asciidoc-syntax.adoc#link-to-other-pagessections-of-the-guide

Please make sure that the merge goes cleanly for the PRs you have already
created, before the new ref-guide was committed. The only real issue you
should see is the new link syntax, mentioned above, but there is a
possibility there will be worse problems. I'm happy to help with any merge
issues you run into so please reach out.

*Check it out*
You can check out the local build here:
https://nightlies.apache.org/solr/draft-guides/solr-reference-guide-antora/solr/10_0/

That link is up-to-date as of yesterday. Soon we will have it up to date
with all current versions (9.0, 9.1 and 10.0), hopefully tomorrow at some
point. (I will also go through and make sure we didn't backport things from
10 and 9.1 to 9.0 that shouldn't have been included...)


Thanks to Cassandra for doing the heavy lifting here (and Mike as well)!
This is a major improvement for our docs, and I'm really excited to have it
out there soon!

- Houston

Reply via email to