Thanks for taking care of that Uwe. On Sun, Feb 13, 2022 at 12:04 PM Uwe Schindler <[email protected]> wrote:
> Here is the PR to fix: https://github.com/apache/solr/pull/631 > > > > ----- > > Uwe Schindler > > Achterdiek 19, D-28357 Bremen > > https://www.thetaphi.de > > eMail: [email protected] > > > > *From:* Uwe Schindler <[email protected]> > *Sent:* Sunday, February 13, 2022 5:36 PM > *To:* '[email protected]' <[email protected]> > *Subject:* RE: Warning - Ref Guide has been migrated to Antora > > > > Hi, > > > > I figured out what the problem is: The new build again produces YAML files > (like we did before) that are using the serach/replace templating of > Gradle. When the templating replaces some variables in YAML templates, it > does not correctly escape the replaced string. > > > > I implemented the correct templating in the previous build, but for > example the following was removed: > > > > // Escape all the properties, so they can be inserted into YAML > templates (this requires all strings in YAML to be single-quoted). > > final def escapedProps = props.collectEntries{k, v -> [k, > v.replace("'","''")]} > > > > This is the better way to do this and NOT use double quotes in YAML files. > See http://yaml.org/spec/1.2-old/spec.html#id2788097 for spec. > > > > I will open and merge a pull request that does the following: > > - Readd the above code to escape YAML strings by duplicating single > quotes > - Replace all double quoted in the YAML files by single quotes. > > > > Uwe > > > > ----- > > Uwe Schindler > > Achterdiek 19, D-28357 Bremen > > https://www.thetaphi.de > > eMail: [email protected] > > > > *From:* Uwe Schindler <[email protected]> > *Sent:* Sunday, February 13, 2022 4:50 PM > *To:* '[email protected]' <[email protected]> > *Subject:* RE: Warning - Ref Guide has been migrated to Antora > > > > Hi, > > > > On Windows it brings a strange error message (not related to Windows or > whitespace in my path name), looks like some external link problem (“FATAL > (antora): expected hexadecimal character (18:15)”): > > > > > Task :solr:solr-ref-guide:buildLocalAntoraSite FAILED > > [16:12:29.560] FATAL (antora): expected hexadecimal character (18:15) in > C:\Users\Uwe > Schindler\Projects\lucene\solr\solr\solr-ref-guide\build\site-staging\playbook.yml > (playbook: C:\\Users\\Uwe > Schindler\\Projects\\lucene\\solr\\solr\\solr-ref-guide\\build/site-staging/playbook.yml) > > > > 15 | # The URL for "Edit this page" links will a ... > > 16 | edit_url: '{web_url}/tree/main/{path}' > > 17 | sources: > > 18 | - url: "C:\Users\Uwe Schindler\Projects\luc ... > > --------------------^ > > 19 | branches: HEAD > > 20 | start_path: "solr/solr-ref-guide/build/si ... > > Add the --stacktrace option to see the cause of the error. > > > > FAILURE: Build failed with an exception. > > > > But Linux builds pass, so not sure how this comes. Whitespace in path name > is not the problem as the same happens on Windows Jenkins! > > > > Uwe > > > > ----- > > Uwe Schindler > > Achterdiek 19, D-28357 Bremen > > https://www.thetaphi.de > > eMail: [email protected] > > > > *From:* Mike Drob <[email protected]> > *Sent:* Friday, February 11, 2022 2:21 AM > *To:* [email protected] > *Subject:* Re: Warning - Ref Guide has been migrated to Antora > > > > I just went through the process of merging up an older PR and the ref > guide link checker helpfully alerted me to my old broken links! Took me a > few minutes to find the right page, but overall the speedbump was very very > minor. > > > > Thanks for taking this across the finish line, Houston! > > > > On Thu, Feb 10, 2022 at 2:31 PM Houston Putman <[email protected]> wrote: > > Ok, created a different folder in the nightlies for the new nightly > ref-guide build: > > > > > https://nightlies.apache.org/solr/draft-guides/solr-reference-guide-nightly/solr/9_0/index.html > > > > Note: The nightly builds will include all branches (including main and > branch_*x), whereas the release build will only include release branches > (branch_*_*). > > So when you go the the nightlies site linked above you can check out 10.0, > 9.1 and 9.0, however when 9.0.0 is released, it will only show 9.0 > > > > - Houston > > > > On Thu, Feb 10, 2022 at 1:58 PM Houston Putman <[email protected]> wrote: > > Right?? By far makes this whole thing worth it, besides the other > wonderful goodies we get (like changing solr versions). > > > > Basically it works by adding this line: (along with gradle build stuff of > downloading that extension and putting stuff in the right place) > > > https://github.com/apache/solr/blob/main/solr/solr-ref-guide/playbook.template.yml#L40 > > > > Antora handles the rest. > > You can find the extension here: > https://gitlab.com/antora/antora-lunr-extension > > > > Sadly it doesn't use Solr, but it is a small price to pay so that we, a > search engine, finally have search enabled for our docs... > > > > - Houston > > > > On Thu, Feb 10, 2022 at 1:42 PM Gus Heck <[email protected]> wrote: > > :) nice. highlighting of search terms too! > > > > On Thu, Feb 10, 2022 at 1:38 PM David Smiley <[email protected]> wrote: > > OMG I see we have search now -- good search with snippets too! How does > it work? > > > ~ David Smiley > > Apache Lucene/Solr Search Developer > > http://www.linkedin.com/in/davidwsmiley > > > > > > On Thu, Feb 10, 2022 at 1:09 PM David Smiley <[email protected]> wrote: > > This is a nice fresh look; thanks Cassandra, Houston, and Mike! > > > ~ David Smiley > > Apache Lucene/Solr Search Developer > > http://www.linkedin.com/in/davidwsmiley > > > > > > On Thu, Feb 10, 2022 at 12:47 PM Houston Putman <[email protected]> > wrote: > > 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 > > > > > -- > > http://www.needhamsoftware.com (work) > > http://www.the111shift.com (play) > >
