[
https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17070555#comment-17070555
]
David Jencks commented on CAMEL-13812:
--------------------------------------
What I do to look at my local changes is have what is often referred to as an
"author workspace" antora playbook. I replace the remote git urls with paths
to the local checkouts of the git repo, and the branch name of the branch I'm
working on with "HEAD". For example,
{noformat}
- url: [email protected]:apache/camel.git
branches: master
start_path: docs/user-manual
{noformat}
becomes
{noformat}
- url: ./../camel
branches: HEAD
start_path: docs/user-manual
{noformat}
I have camel and camel-website next to one another; if you have a different
arrangement you'll have to adjust the url. Be sure it starts with ./
If you modify your antora-playbook.yml, you can preview with yarn run
build:antora or yarn run build.
> 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)
