[jira] [Reopened] (SOLR-15556) Ref Guide Redesign Phase 3: Replace Jekyll

["Uwe Schindler (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Uwe Schindler reopened SOLR-15556:
----------------------------------

Hi,
on Jenkins (Windows) and on my local windows machine, the ANtora Build fails for some reason not realted to windows specifically or some NPN vs Windows issues. All is setup perfectly, just {{:solr:solr-ref-guide:buildLocalAntoraSite}} fails with some strange non-informative error message (it is shortened with elipsis):

{noformat}
> 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.

* What went wrong:
Execution failed for task ':solr:solr-ref-guide:buildLocalAntoraSite'.
> Process 'command 'C:\Users\Uwe Schindler\Projects\lucene\solr\.gradle\node\nodejs\node-v16.13.2-win-x64\npx.cmd'' finished with non-zero exit value 1
{noformat}

It has nothing to do with the whitespace in the path name, it also happens on Jenkins Windows (see buil #630 and later, https://jenkins.thetaphi.de/job/Solr-main-Windows/630/consoleText):

{noformat}
> Task :solr:solr-ref-guide:buildLocalAntoraSite FAILED
[10:50:37.287] FATAL (antora): expected hexadecimal character (18:15) in C:\Users\jenkins\workspace\Solr-main-Windows\solr\solr-ref-guide\build\site-staging\playbook.yml (playbook: C:\\Users\\jenkins\\workspace\\Solr-main-Windows\\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\jenkins\workspace\Solr-mai ...
--------------------^
 19 |     branches: HEAD
 20 |     start_path: "solr/solr-ref-guide/build/si ...
Add the --stacktrace option to see the cause of the error.
{noformat}

Previous builds were failing for other reason (borken Gradle caches).

> 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: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org