camel-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Claus Ibsen (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CAMEL-9541) Component docs - Maintain docs as part of the source code
Date Thu, 11 Aug 2016 13:23:20 GMT

    [ https://issues.apache.org/jira/browse/CAMEL-9541?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15417217#comment-15417217
] 

Claus Ibsen commented on CAMEL-9541:
------------------------------------

We should probably use a suffix for the documentation names so we can avoid clashes and know
if its a component / language etc.

eg ahc.adoc -> ahc-component.adoc
groovy.adoc -> groovy-language.adoc

eg use suffix

- component
- language
- dataformat



> Component docs - Maintain docs as part of the source code
> ---------------------------------------------------------
>
>                 Key: CAMEL-9541
>                 URL: https://issues.apache.org/jira/browse/CAMEL-9541
>             Project: Camel
>          Issue Type: New Feature
>          Components: build system, documentation
>            Reporter: Claus Ibsen
>            Assignee: Andrea Cosentino
>             Fix For: 2.18.0
>
>
> Just a ticket to capture what we are discussing at @dev
> http://camel.465427.n5.nabble.com/gitbook-based-doc-generation-td5776497.html
> We have a maven plugin that can keep all the component and endpoint options up to date.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message