[
https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17071062#comment-17071062
]
David Jencks commented on CAMEL-13812:
--------------------------------------
This basically looks good to me.
I think your arrangement of nav files is fine.
I would name the module 'faq' rather than 'FAQ'. 'ROOT' is uppercased because
it is special in that the module name is removed from the final path: all other
module names are normally lowercase as they do appear in the url. The effect
of this is that the path for faq pages won't change.
A full xref to a faq page used to look like:
{noformat}
xref:latest@manual::faq/faqpage.adoc[title]
{noformat}
Depending on the location, the 'latest@manual' might be omitted.
These will need to be located and converted to
{noformat}
xref:latest@manual:faq:faqpage.adoc[title]
{noformat}
xrefs from one faq page to another should not need updating, unless they have
more in them than needed.
I'm pretty sure, although I didn't look, that there are such xrefs in the rest
of the user manual and in component pages in every version. If this is
correct, you'll need PRs for master, 2.x, and 3.0.x.
Asciidoc supports quite a few xref formats although I always use `xref:...`
There may be `<<...>>` and possibly some sort of `[...]` format as well. I've
generally been converting alternate formats to `xref:` for interpage links when
I find them. I think these may be leftover from conversion to asciidoc.
> Split up user manual
> --------------------
>
> Key: CAMEL-13812
> URL: https://issues.apache.org/jira/browse/CAMEL-13812
> Project: Camel
> Issue Type: Sub-task
> Components: documentation, website
> Reporter: Zoran Regvart
> Priority: Major
> Labels: help-wanted
> Fix For: 3.x
>
> Attachments: FAQ landing-page.docx, faq-module.png,
> getting-started-with-apache-camel.docx
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> I think we would benefit from splitting up the user manual into even smaller
> Antora modules:
> * FAQ
> * Getting started
> * User manual
> Perhaps (not sure), Architecture. I think grouping of pages would help as we
> could have a landing (index) page for each module.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
