[
https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17059849#comment-17059849
]
Patrícia Feio commented on CAMEL-13812:
---------------------------------------
[~zregvart] I went through the User Manual and I have some questions and some
split suggestions. Regarding the splitting suggestions was this structure what
you had in mind? I don't have any suggestion about splitting the Architecture
section.
In [https://camel.apache.org/manual/latest/]:
In +Overview+ (after Summary) I would suggest:
* Getting started with Apache Camel
* FAQ
* Legal Notice
I suggest changing +Getting started+ for +Getting started with Apache Camel+
and deleting +Longer Getting Started Guide+.
In +Documentation+ (after +Summary+ and +Overview+) I would suggest the
following order:
* User Guide
* Books
* Examples
* Architecture
* DSL (why is also a DSL entry in Architecture?)
* Enterprise Integration Patterns
* Component
* Data Formats
* Language
In +User Guide+ what was the criterion for the chosen links? There are link
from the +Faq+, others from +Architecture+. For example, when I click on
“Apache Karak Support” the breadcrumb is “User Manual / Apache Karak Support”,
so shouldn’t this page also appear in the +User manual+ in the sidebar?
In +Architecture+ I suggest a link to the section +Architecture+ on the same
page and not the link that exists now; this way the user will be guided to the
other links in the +Architecture+ section. Also, not all the links are the same
as the ones in the +User Manual+ in the sidebar. Same as in +DSL+. Is this
intentional?
In the +User Manual+ (sidebar) I suggest (the split part):
* +Getting started with Apache Camel+ (change name from Getting started)
** Working with CamelContexts and RouteBuilders
** Working with Spring
** What are the dependencies?
** The Enterprise Integration Patterns (EIP) book
** Online documentation for Camel
** Online Javadoc documentation
** Concepts and terminology fundamental to Camel
** Other resources
* +Architecture+ (no idea how to split this section)
* +Frequently asked questions+
General questions
* Can I get commercial support? (...)
Using Camel Questions
* Classloader issue of servicemix-camel component (...)
Logging questions
* How do I enable debug logging? (...)
Camel Endpoint questions
* How do I invoke Camel routes from JBI? (...)
Component questions
* Why does my JMS route only consume one message at once?
Common problems
* Exception – BeanDefinitionStoreException (...)
+Getting started with Apache Camel+ would be a mix between +Getting started+,
+Getting started with Apache Camel+ and +What are the dependencies?+
Clicking in +Getting started with Apache Camel+ would open an index page and
from there we would go to the several links presented in the sidebar menu (see
attachment with all the pages; changes are highlighted in orange)
[^getting-started-with-apache-camel.docx].
The breadcrumb mentioned in “A useful tip for navigating the online
documentation” (+Getting started with Apache Camel+ page) doesn’t exist, or at
least I wasn’t able to find it: Apache Camel / Documentation / Architecture /
Languages, if we are in Languages we find the breadcrumb to be User Manual /
Frequently asked questions / What languages are supported?
For the +FAQ+ see the next attachment. There we would have an intro text and
several links for all the topics (different pages for all of them), also with
intro texts. [^FAQ landing-page.docx]
[~aashnajena] and [~Bob160] what is you opinion? Have thought in a similar way?
> 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, getting-started-with-apache-camel.docx
>
>
> 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)
