[
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17491611#comment-17491611
]
Uwe Schindler edited comment on SOLR-15556 at 2/13/22, 5:03 PM:
----------------------------------------------------------------
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:
{code:groovy}
// 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("'","''")]}
{code}
This is the better way to do this and NOT use double quotes in YAML files. See
https://yaml.org/spec/1.2.2/#732-single-quoted-style 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.
was (Author: thetaphi):
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:
{code:groovy}
// 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("'","''")]}
{code}
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.
> 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]
