[
https://issues.apache.org/jira/browse/SOLR-15556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17399953#comment-17399953
]
Cassandra Targett commented on SOLR-15556:
------------------------------------------
Thanks Houston!
bq. For the path corrections, we should be able to have automatic redirects...
I think you're talking about the 1200 inter-page links that need to be checked
that I mentioned? If so, we won't need to redirect. These are links between
pages, like pageA.adoc has a link to pageB.adoc. Currently we define these
links with brackets, like {{<< >>}}, but when the pages are in different
components, they need to be defined with an {{xref}} instead. This doesn't
change anything about the pages themselves - the "path corrections" are only in
the references to the pages.
(However, the URLs _will_ change for Antora generally to include the component
name, and for that perhaps we try to do a redirect of some kind, but it could
be complex.)
bq. Is it possible to get rid of the duplication of category names?
Yes, for sure - that's what I meant at the end of my comment when I said we'd
be able to get rid of ~20 pages. The duplication is coming because we have a
section name which is a link, and in our site today we have an actual HTML page
for that. But we would be able to drop that convention if we want to.
I took a little break from this, and the alpha-8 release of Antora 3.0.0 has
been released. I'll update my branch to use that, but at some point I probably
need to make a list of what we need to figure out still. And I'm not sure if
I'm truly suggesting yes, let's use this instead yet or not.
> Ref Guide Redesign Phase 3: Replace Jekyll
> ------------------------------------------
>
> Key: SOLR-15556
> URL: https://issues.apache.org/jira/browse/SOLR-15556
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Major
>
> 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.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
