[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17071079#comment-17071079 ] Aashna Jena commented on CAMEL-13812: - Hey, thanks for the detailed response! I believe I have already made all the xref changes you mentioned in my Pull Request. There are files outside docs/ also with xref links to FAQ, I have changed those as well. And yes, I checked for alternate formats as well. Basically, I checked for anything with a "faq/" in the URL. I have put a PR for master right now, once you get the time to review it and suggest changes, I'll be happy to do the same for other branches :) > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[
https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17070903#comment-17070903 ] Aashna Jena commented on CAMEL-13812: - Is this how you expect the menu to look like? !faq-module.png! Right now, I have split FAQ into a separate module. To achieve this order in the menu, I split ROOT/nav.adoc into ROOT/nav.adoc and ROOT/references.adoc and the user-manual/antora.yml file has order : ROOT/nav.adoc FAQ/nav.adoc ROOT/references.adoc Since antora.yml is a component descriptor file as given in the [documentation|https://docs.antora.org/antora/2.0/component-descriptor/], I don't think we can have an independent menu for a module. Is this way okay for you? > 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: 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17070853#comment-17070853 ] Aashna Jena commented on CAMEL-13812: - 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17070812#comment-17070812 ] Aashna Jena commented on CAMEL-13812: - I see. Yes this is exactly how I was testing the changes on the website, thank you for confirming :) Please allow me to make FAQ into a separate module and improve on my quality of commits. Thanks for elaborating! > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[
https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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: g...@github.com: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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17070554#comment-17070554 ] David Jencks commented on CAMEL-13812: -- To move FAQs into a separate module, create a docs/user-manual/modules/faq/pages directory and move the faq pages into it. You don't need a separate source tree or antora.yml. Having a separate nav.adoc for faq would be a good idea IMO. List all the user manual nav files in the antora.yml, in order. > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17070553#comment-17070553 ] David Jencks commented on CAMEL-13812: -- I'm sorry I missed this issue when it was filed. I strongly object to splitting the user manual content into additional components. I think the result will be too fractured and hard to use. I think it is a good idea to split the user manual content into modules inside the user manual component, in fact I considered doing it. The comment 2 ago indicates that splitting into a separate module was planned, but the previous comment and changes appear to split into a separate component. The comments on the commits don't appear to relate to the changes: they claim they are introducing a new module but are introducing a new component. I agree the FAQ would benefit from a quick lookup. The PRs are very difficult to understand: they should be squashed into a minimal number of commits. > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17070521#comment-17070521 ] Aashna Jena commented on CAMEL-13812: - Hi, I have made this pull request for splitting FAQ into a separate component. Here is the PR for [Camel Repository|https://github.com/apache/camel/pull/3691] and for [Camel-Website|https://github.com/apache/camel-website/pull/289] > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17070349#comment-17070349 ] Aashna Jena commented on CAMEL-13812: - Hi, I want to split the FAQ part into a separate module. What I'm thinking in that User Manual should have a menu-item called FAQ, which should open a page with (1) FAQ introduction, (2) How to find your query and (3) list of all FAQs. I want this to be a separate module, with a nav-faq.adoc of its own. I also think it makes sense to have a quick look-up search box here, similar to components page. If I understand correctly, I'm going to have to make changes to the current [nav.adoc|https://github.com/apache/camel/blob/master/docs/user-manual/modules/ROOT/nav.adoc] and create a new nav-faq.adoc and migrate the xref links. These changes will get made in the camel repo, how do I test it on the website? > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[
https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17064708#comment-17064708
]
Zoran Regvart commented on CAMEL-13812:
---
{quote}I suggest changing Getting started for Getting started with Apache Camel
and deleting Longer Getting Started Guide.{quote}
Not sure about renaming, "Getting started" to "Getting started with Apache
Camel", and about deleting the "Longer Getting Started Guide", what's the value
in that?
{quote}In Documentation (after Summary and Overview) I would suggest the
following order:{quote}
I don't think it makes much sense to keep any of that, the navigation on the
left should be used to access content. We have an issue on making sure that the
linked pages are also available on the navigation (CAMEL-13780).
I like the direction this is heading, especially with the splitting of FAQ into
a separate component/module. Make sure to read Antora documentation on that,
and that you're aware of the {{xref}} link changes that need to be made when
the split is 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
>
>
> 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17063879#comment-17063879 ] Aemie commented on CAMEL-13812: --- I really think the proposal of the entire layout is pretty good. I would love to help you people out in this. > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17063836#comment-17063836 ] Aashna Jena commented on CAMEL-13812: - I like the idea. Shall we start working on this? > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17060271#comment-17060271 ] Efio-esien Efiom commented on CAMEL-13812: -- [~Patricia Feio]this is a job well-done. I think this proposal will work just fine! [~zregvart]what do you think? Can we proceed? Thanks > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17059479#comment-17059479 ] Aashna Jena commented on CAMEL-13812: - Hey [~zregvart] can I start working on this? I think this is going to be a big task - given how much content the user manual has. I'll post a draft solution here asap! > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17058818#comment-17058818 ] Patrícia Feio commented on CAMEL-13812: --- [~Bob160] I replied you just now > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17058694#comment-17058694 ] Efio-esien Efiom commented on CAMEL-13812: -- [~Patricia Feio]kindly check your gitter messages. Thanks > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17058313#comment-17058313 ] Patrícia Feio commented on CAMEL-13812: --- Hi [~Bob160] did you try to run the project locally? I'm still stuck with Hugo. I'm gonna ask for help on Gitter. > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17057837#comment-17057837 ] Zoran Regvart commented on CAMEL-13812: --- [~Transcendence09] we have a list of issues that we [ask help with|https://issues.apache.org/jira/issues/?filter=12348381], if you see folk discussing on an issue try to reach out as others have here to them and try to collaborate on the work together. It's much easier for us if you try to self-organize. > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17057743#comment-17057743 ] Efio-esien Efiom commented on CAMEL-13812: -- It's ok [~Patricia Feio] . Nice job with setting up the project locally! How do I get to do the same. Kindly assist please. Thanks > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17057688#comment-17057688 ] Chibueze Ughanze commented on CAMEL-13812: -- how do I know a task that is left unassigned to work with? or do i just pick any and begin working on it? Please help me out so i can make precise contributions to this project. Thank you > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17057678#comment-17057678 ] Patrícia Feio commented on CAMEL-13812: --- Efio-esien Efiom I'm really sorry for not replying you. I got stuck on setting up the projecto locally that I forgot to see Gitter messages. I'm not sure if I'll be able to reply during the morning, so is it ok if I reply after lunch time? Thank you > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17057407#comment-17057407 ] Efio-esien Efiom commented on CAMEL-13812: -- [~Patricia Feio] kindly check your Gitter messages. Sent you a message so we can collaborate and sort this out. Thanks > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17057123#comment-17057123 ] Patrícia Feio commented on CAMEL-13812: --- Great idea, [~zregvart] and [~Bob160]. [~Bob160] on Gitter my username is @PatriciaFeio. > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17056966#comment-17056966 ] Zoran Regvart commented on CAMEL-13812: --- [~Bob160] yes, please coordinate with [~Patricia Feio] (perhaps on Gitter chat) to divide the work, there's plenty of work that needs to be done for this. I would suggest that you go through the documentation and draft plan on this first. > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17056933#comment-17056933 ] Efio-esien Efiom commented on CAMEL-13812: -- [~zregvart] I was hoping I could also work with [~Patricia Feio] on this whole issue. We could split it between ourselves. What do you think? [~Patricia Feio] what's your thought? Thanks > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17056174#comment-17056174 ] Patrícia Feio commented on CAMEL-13812: --- Thank you, [~zregvart] . I'll see what I'm able to accomplish. > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17054905#comment-17054905 ] Zoran Regvart commented on CAMEL-13812: --- [~Patricia Feio] feel free to contribute, it's probably quite a large task to take on though. Should not be too difficult but I think it will be labour intensive. > 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 > > > 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)
[jira] [Commented] (CAMEL-13812) Split up user manual
[ https://issues.apache.org/jira/browse/CAMEL-13812?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17053893#comment-17053893 ] Patrícia Feio commented on CAMEL-13812: --- Hi, I'm Patricia, I'm an Outreachy applicant. Can I work on this issue? > 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 > > > 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)
