[
https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17070853#comment-17070853
]
Aashna Jena edited comment on CAMEL-13812 at 3/30/20, 10:12 AM:
----------------------------------------------------------------
Hi, here is how I am proceeding with it :
1) move the FAQ folder from `user-manual/modules/ROOT/pages` to
`user-manual/modules/`
2) remove all xref links to faq files from `user-manual/modules/ROOT/nav.adoc`
and add just the link to the new FAQ module
3) make a new nav.adoc in `user-manual/modules/FAQ` and add the xref links
here. Change the links according to the new relative location of files and add
`modules/FAQ/nav.adoc` in `user-manual/antora.yml`
Am I proceeding correctly? After this, I should check all files in FAQ module
to see where links need to be changed according to their new relative position.
I see there are two images in the `user-manual/modules/FAQ/pages/images` folder
now, but I'm not able to find where these images are being used. Can you help
me with this, and please tell me what else needs to be done?
was (Author: aashnajena):
Hi, here is how I am proceeding with it :
1) move the FAQ folder from `user-manual/modules/ROOT/pages` to
`user-manual/modules/`
2) remove all xref links to faq files from `user-manual/modules/ROOT/nav.adoc`
and add just the link to the new FAQ module
3) make a new nav.adoc in `user-manual/modules/FAQ` and add the xref links
here. Change the links according to the new relative location of files and add
`modules/FAQ/nav.adoc` in `user-manual/antora.yml`
Am I proceeding correctly? After this, I should check all files in FAQ module
to see where links need to be changed according to their new relative position.
I see there are two images in the `user-manual/modules/FAQ/pages/images` folder
now, but I'm not able to find where these images are being used. Can you help
me with this, and please tell me what else needs to be done?
> 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,
> getting-started-with-apache-camel.docx
>
> Time Spent: 10m
> 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)
