Repository: camel Updated Branches: refs/heads/master fd78d4510 -> d661a7a33
CAMEL-11145: Component docs - Fix broken links on github Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/d661a7a3 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d661a7a3 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d661a7a3 Branch: refs/heads/master Commit: d661a7a33b6acb35b24c8f80d21f9a9913b62515 Parents: fd78d45 Author: Claus Ibsen <davscl...@apache.org> Authored: Thu Apr 13 13:26:42 2017 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Apr 13 13:26:42 2017 +0200 ---------------------------------------------------------------------- components/readme.adoc | 16 ++++++++-------- .../camel/maven/packaging/PrepareReadmeMojo.java | 6 ++++++ .../camel/maven/packaging/model/ComponentModel.java | 13 +++++++++++++ 3 files changed, 27 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/d661a7a3/components/readme.adoc ---------------------------------------------------------------------- diff --git a/components/readme.adoc b/components/readme.adoc index b3393de..f87adc6 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -98,7 +98,7 @@ Number of Components: 231 in 184 JAR artifacts (14 deprecated) | link:camel-bonita/src/main/docs/bonita-component.adoc[Bonita] (camel-bonita) + `bonita:operation` | 2.19 | Camel Bonita support -| link:camel-box/src/main/docs/box-component.adoc[Box] (camel-box) + +| link:camel-box/camel-box-component/src/main/docs/box-component.adoc[Box] (camel-box) + `box:apiName/methodName` | 2.14 | For uploading downloading and managing files folders groups collaborations etc on box DOT com. | link:camel-braintree/src/main/docs/braintree-component.adoc[Braintree] (camel-braintree) + @@ -293,9 +293,6 @@ Number of Components: 231 in 184 JAR artifacts (14 deprecated) | link:camel-ibatis/src/main/docs/ibatis-component.adoc[iBatis] (camel-ibatis) + `ibatis:statement` | 1.2 | *deprecated* Performs a query poll insert update or delete in a relational database using Apache iBATIS. -| link:camel-mail/src/main/docs/imap-component.adoc[IMAP] (camel-mail) + -`imap:host:port` | 1.0 | To send or receive emails using imap/pop3 or stmp protocols. - | link:camel-infinispan/src/main/docs/infinispan-component.adoc[Infinispan] (camel-infinispan) + `infinispan:cacheName` | 2.13 | For reading/writing from/to Infinispan distributed key/value store and data grid. @@ -374,7 +371,7 @@ Number of Components: 231 in 184 JAR artifacts (14 deprecated) | link:camel-ldap/src/main/docs/ldap-component.adoc[LDAP] (camel-ldap) + `ldap:dirContextName` | 1.5 | The ldap component allows you to perform searches in LDAP servers using filters as the message payload. -| link:camel-linkedin/src/main/docs/linkedin-component.adoc[Linkedin] (camel-linkedin) + +| link:camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc[Linkedin] (camel-linkedin) + `linkedin:apiName/methodName` | 2.14 | The linkedin component is uses for retrieving LinkedIn user profiles connections companies groups posts etc. | link:../camel-core/src/main/docs/log-component.adoc[Log] (camel-core) + @@ -386,6 +383,9 @@ Number of Components: 231 in 184 JAR artifacts (14 deprecated) | link:camel-lumberjack/src/main/docs/lumberjack-component.adoc[Lumberjack] (camel-lumberjack) + `lumberjack:host:port` | 2.18 | The lumberjack retrieves logs sent over the network using the Lumberjack protocol. +| link:camel-mail/src/main/docs/mail-component.adoc[Mail] (camel-mail) + +`imap:host:port` | 1.0 | To send or receive emails using imap/pop3 or stmp protocols. + | link:camel-metrics/src/main/docs/metrics-component.adoc[Metrics] (camel-metrics) + `metrics:metricsType:metricsName` | 2.14 | To collect various metrics directly from Camel routes using the DropWizard metrics library. @@ -446,10 +446,10 @@ Number of Components: 231 in 184 JAR artifacts (14 deprecated) | link:camel-netty4-http/src/main/docs/netty4-http-component.adoc[Netty4 HTTP] (camel-netty4-http) + `netty4-http:protocol:host:port/path` | 2.14 | Netty HTTP server and client using the Netty 4.x library. -| link:camel-olingo2/src/main/docs/olingo2-component.adoc[Olingo2] (camel-olingo2) + +| link:camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc[Olingo2] (camel-olingo2) + `olingo2:apiName/methodName` | 2.14 | Communicates with OData 2.0 services using Apache Olingo. -| link:camel-olingo4/src/main/docs/olingo4-component.adoc[Olingo4] (camel-olingo4) + +| link:camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc[Olingo4] (camel-olingo4) + `olingo4:apiName/methodName` | 2.19 | Communicates with OData 4.0 services using Apache Olingo OData API. | link:camel-milo/src/main/docs/milo-server-component.adoc[OPC UA Server] (camel-milo) + @@ -542,7 +542,7 @@ Number of Components: 231 in 184 JAR artifacts (14 deprecated) | link:camel-rss/src/main/docs/rss-component.adoc[RSS] (camel-rss) + `rss:feedUri` | 2.0 | The rss component is used for consuming RSS feeds. -| link:camel-salesforce/src/main/docs/salesforce-component.adoc[Salesforce] (camel-salesforce) + +| link:camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc[Salesforce] (camel-salesforce) + `salesforce:operationName:topicName` | 2.12 | The salesforce component is used for integrating Camel with the massive Salesforce API. | link:camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc[SAP NetWeaver] (camel-sap-netweaver) + http://git-wip-us.apache.org/repos/asf/camel/blob/d661a7a3/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareReadmeMojo.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareReadmeMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareReadmeMojo.java index 9b9ecf1..f9e47be 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareReadmeMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareReadmeMojo.java @@ -219,6 +219,12 @@ public class PrepareReadmeMojo extends AbstractMojo { } if (add) { models.add(model); + + // special for camel-mail where we want to refer its imap scheme to mail so its mail.adoc in the doc link + if ("imap".equals(model.getScheme())) { + model.setScheme("mail"); + model.setTitle("Mail"); + } } } http://git-wip-us.apache.org/repos/asf/camel/blob/d661a7a3/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java index 0832bc1..bb5a391 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java @@ -218,6 +218,19 @@ public class ComponentModel { } public String getDocLink() { + // special for these components + if ("camel-box".equals(artifactId)) { + return "camel-box/camel-box-component/src/main/docs"; + } else if ("camel-linkedin".equals(artifactId)) { + return "camel-linkedin/camel-linkedin-component/src/main/docs"; + } else if ("camel-olingo2".equals(artifactId)) { + return "camel-olingo2/camel-olingo2-component/src/main/docs"; + } else if ("camel-olingo4".equals(artifactId)) { + return "camel-olingo4/camel-olingo4-component/src/main/docs"; + } else if ("camel-salesforce".equals(artifactId)) { + return "camel-salesforce/camel-salesforce-component/src/main/docs"; + } + if ("camel-core".equals(artifactId)) { return coreOnly ? "src/main/docs" : "../camel-core/src/main/docs"; } else {
