[jira] [Commented] (CAMEL-12417) Camel documentation
[ https://issues.apache.org/jira/browse/CAMEL-12417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16442084#comment-16442084 ] Claus Ibsen commented on CAMEL-12417: - Terrien please hold on this as explained we are in the effort of migrating the docs to ascii docs. If you want to help then wait a bit until we have setup a new TOC and have page links et all setup. We will post on the Camel @dev mailing list and other places when this work is set in motion again - the current timeframe is middle of May leading up to the Camel 2.22 release (june). At this point I am closing this ticket and then we pickup this again later. > Camel documentation > --- > > Key: CAMEL-12417 > URL: https://issues.apache.org/jira/browse/CAMEL-12417 > Project: Camel > Issue Type: Improvement >Affects Versions: 2.21.0 >Reporter: Terrien Jean-Yves >Priority: Major > > I am rewriting the doc to fit github. > [https://github.com/jyterrien/camel/blob/master/readme.adoc] > I replaced .md files with .adoc > I started correcting the links in readme.adoc contributing.adoc > and in camel-core. (in alphabetic order from bean-component to file-component) > I did not find, on github, docs like > https://camel.apache.org/data-format.html > [https://camel.apache.org/enterprise-integration-patterns.html] > > in every page I've changed the definition > = title page > I'e added > :toc: left > and I corrected the links <> link:doc.adoc[Doc] > I also when I found the target corrected the relative links like : > === See Also > * link:file-language.adoc[File Language] > * link:../../../../components/camel-ftp/src/main/docs/ftp-component.adoc[FTP] > * Polling Consumer > as soon as I corrected all camel-core I think to make a pull-request -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (CAMEL-12417) Camel documentation
[ https://issues.apache.org/jira/browse/CAMEL-12417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16430271#comment-16430271 ] Andrea Cosentino commented on CAMEL-12417: -- There is a long-term work on the new website and we are working on it, probably it would be in third quarter of 2018, but we can ask to [~davsclaus] to confirm > Camel documentation > --- > > Key: CAMEL-12417 > URL: https://issues.apache.org/jira/browse/CAMEL-12417 > Project: Camel > Issue Type: Improvement >Affects Versions: 2.21.0 >Reporter: Terrien Jean-Yves >Priority: Major > > I am rewriting the doc to fit github. > [https://github.com/jyterrien/camel/blob/master/readme.adoc] > I replaced .md files with .adoc > I started correcting the links in readme.adoc contributing.adoc > and in camel-core. (in alphabetic order from bean-component to file-component) > I did not find, on github, docs like > https://camel.apache.org/data-format.html > [https://camel.apache.org/enterprise-integration-patterns.html] > > in every page I've changed the definition > = title page > I'e added > :toc: left > and I corrected the links <> link:doc.adoc[Doc] > I also when I found the target corrected the relative links like : > === See Also > * link:file-language.adoc[File Language] > * link:../../../../components/camel-ftp/src/main/docs/ftp-component.adoc[FTP] > * Polling Consumer > as soon as I corrected all camel-core I think to make a pull-request -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (CAMEL-12417) Camel documentation
[ https://issues.apache.org/jira/browse/CAMEL-12417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16430270#comment-16430270 ] Claus Ibsen commented on CAMEL-12417: - See this link http://camel.apache.org/2018/04/04/status-update-on-the-apache-camel-website-and-documentation.html > Camel documentation > --- > > Key: CAMEL-12417 > URL: https://issues.apache.org/jira/browse/CAMEL-12417 > Project: Camel > Issue Type: Improvement >Affects Versions: 2.21.0 >Reporter: Terrien Jean-Yves >Priority: Major > > I am rewriting the doc to fit github. > [https://github.com/jyterrien/camel/blob/master/readme.adoc] > I replaced .md files with .adoc > I started correcting the links in readme.adoc contributing.adoc > and in camel-core. (in alphabetic order from bean-component to file-component) > I did not find, on github, docs like > https://camel.apache.org/data-format.html > [https://camel.apache.org/enterprise-integration-patterns.html] > > in every page I've changed the definition > = title page > I'e added > :toc: left > and I corrected the links <> link:doc.adoc[Doc] > I also when I found the target corrected the relative links like : > === See Also > * link:file-language.adoc[File Language] > * link:../../../../components/camel-ftp/src/main/docs/ftp-component.adoc[FTP] > * Polling Consumer > as soon as I corrected all camel-core I think to make a pull-request -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (CAMEL-12417) Camel documentation
[ https://issues.apache.org/jira/browse/CAMEL-12417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16430263#comment-16430263 ] Fintan Bolton commented on CAMEL-12417: --- Yes, you are right that the doc on camel.apache.org (Wiki doc) is now out of date and the primary source of the Camel docs is on GitHub. I think the plan, ultimately, is to generate docs from the AsciiDoc source on GitHub and publish it on the Camel Web site. But I do not know the details. [~ancosen], do you know what the long-term plan is for publishing the new Camel docs on the camel.apache.org site? > Camel documentation > --- > > Key: CAMEL-12417 > URL: https://issues.apache.org/jira/browse/CAMEL-12417 > Project: Camel > Issue Type: Improvement >Affects Versions: 2.21.0 >Reporter: Terrien Jean-Yves >Priority: Major > > I am rewriting the doc to fit github. > [https://github.com/jyterrien/camel/blob/master/readme.adoc] > I replaced .md files with .adoc > I started correcting the links in readme.adoc contributing.adoc > and in camel-core. (in alphabetic order from bean-component to file-component) > I did not find, on github, docs like > https://camel.apache.org/data-format.html > [https://camel.apache.org/enterprise-integration-patterns.html] > > in every page I've changed the definition > = title page > I'e added > :toc: left > and I corrected the links <> link:doc.adoc[Doc] > I also when I found the target corrected the relative links like : > === See Also > * link:file-language.adoc[File Language] > * link:../../../../components/camel-ftp/src/main/docs/ftp-component.adoc[FTP] > * Polling Consumer > as soon as I corrected all camel-core I think to make a pull-request -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (CAMEL-12417) Camel documentation
[ https://issues.apache.org/jira/browse/CAMEL-12417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16429284#comment-16429284 ] Terrien Jean-Yves commented on CAMEL-12417: --- Hi, I thought I understood that now the doc was no longer generated on camel.apache.org. But she was directly available on Github. But today, it is impossible to navigate in the document on Github. Maybe I'm wrong. in this case where is the documentation? On camel.apapche.org a note gives a link to github and on github the documentation does not allow to navigate. If in the end the documentation must be on github it is not about internal references but the contrary of external references. A + JYT > Camel documentation > --- > > Key: CAMEL-12417 > URL: https://issues.apache.org/jira/browse/CAMEL-12417 > Project: Camel > Issue Type: Improvement >Affects Versions: 2.21.0 >Reporter: Terrien Jean-Yves >Priority: Major > > I am rewriting the doc to fit github. > [https://github.com/jyterrien/camel/blob/master/readme.adoc] > I replaced .md files with .adoc > I started correcting the links in readme.adoc contributing.adoc > and in camel-core. (in alphabetic order from bean-component to file-component) > I did not find, on github, docs like > https://camel.apache.org/data-format.html > [https://camel.apache.org/enterprise-integration-patterns.html] > > in every page I've changed the definition > = title page > I'e added > :toc: left > and I corrected the links <> link:doc.adoc[Doc] > I also when I found the target corrected the relative links like : > === See Also > * link:file-language.adoc[File Language] > * link:../../../../components/camel-ftp/src/main/docs/ftp-component.adoc[FTP] > * Polling Consumer > as soon as I corrected all camel-core I think to make a pull-request -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (CAMEL-12417) Camel documentation
[
https://issues.apache.org/jira/browse/CAMEL-12417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16426709#comment-16426709
]
Fintan Bolton commented on CAMEL-12417:
---
Hi [~sekaijin],
I'd like to understand why you want to change the link format from
{{<>}} back to {{link:file.adoc[Text of Link]}}. This
would reverse a lot of the changes I made in CAMEL-12246, where I introduced
the angle-bracket cross reference format [1] into the Camel docs.
As I understand it, the angle-bracket format offers several advantages:
* Because the angle-bracket cross reference does not reference a file name,
you are free to rename {{.adoc}} files and move them around without breaking
the link.
* If you specify {{<>}} without the link text, AsciiDoc can
automatically substitute the text at the target location for you (e.g. title or
section heading).
* Most important of all, the angle-bracket format is compatible with every
kind of documentation build chain. But this is not true of the
{{link:filename.adoc[Text]}} format. If you use the
{{link:filename.adoc[Text]}} format, there is an implicit assumption that the
generated output format is paged HTML, organized with exactly the same
directory structure as the AsciiDoc source. This might work when you generate
paged HTML with the {{asciidoctor}} Maven plugin, but almost any other approach
to building the docs is liable to fail. For example, there is no way the
{{link:filename.adoc[Text]}} format would work for PDF or ePub output.
[1] [https://asciidoctor.org/docs/user-manual/#internal-cross-references]
> Camel documentation
> ---
>
> Key: CAMEL-12417
> URL: https://issues.apache.org/jira/browse/CAMEL-12417
> Project: Camel
> Issue Type: Improvement
>Affects Versions: 2.21.0
>Reporter: Terrien Jean-Yves
>Priority: Major
>
> I am rewriting the doc to fit github.
> [https://github.com/jyterrien/camel/blob/master/readme.adoc]
> I replaced .md files with .adoc
> I started correcting the links in readme.adoc contributing.adoc
> and in camel-core. (in alphabetic order from bean-component to file-component)
> I did not find, on github, docs like
> https://camel.apache.org/data-format.html
> [https://camel.apache.org/enterprise-integration-patterns.html]
>
> in every page I've changed the definition
> = title page
> I'e added
> :toc: left
> and I corrected the links <> link:doc.adoc[Doc]
> I also when I found the target corrected the relative links like :
> === See Also
> * link:file-language.adoc[File Language]
> * link:../../../../components/camel-ftp/src/main/docs/ftp-component.adoc[FTP]
> * Polling Consumer
> as soon as I corrected all camel-core I think to make a pull-request
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
