You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by nf...@apache.org on 2021/02/17 13:12:20 UTC

[camel-kamelets] 02/02: Added docs

This is an automated email from the ASF dual-hosted git repository.

nferraro pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git

commit a4cf1d3264a9e7f4479f5e3c7132b36ebf240d74
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Wed Feb 17 13:05:18 2021 +0100

    Added docs
---
 ...3-source.kamelet.yaml => aws-s3-source.kamelet.yaml |  4 ++--
 .../kamelets/{aws2-s3-source.svg => aws-s3-source.svg} |  0
 docs/modules/ROOT/nav.adoc                             |  2 +-
 .../pages/{aws2-s3-source.adoc => aws-s3-source.adoc}  | 18 +++++++++---------
 4 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/aws2-s3-source.kamelet.yaml b/aws-s3-source.kamelet.yaml
similarity index 98%
rename from aws2-s3-source.kamelet.yaml
rename to aws-s3-source.kamelet.yaml
index 1494707..6e0e027 100644
--- a/aws2-s3-source.kamelet.yaml
+++ b/aws-s3-source.kamelet.yaml
@@ -1,7 +1,7 @@
 apiVersion: camel.apache.org/v1alpha1
 kind: Kamelet
 metadata:
-  name: aws2-s3-source
+  name: aws-s3-source
   annotations:
     camel.apache.org/kamelet.icon: "data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjEiIGlkPSJMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHg9IjAiIHk9IjAiIHZpZXdCb3g9IjAgMCAyNDguMiAzMDAiIHhtbDpzcGFjZT0icHJlc2VydmUiPjxzdHlsZT4uc3QyOHtmaWxsOiM4YzMxMjN9LnN0Mjl7ZmlsbDojZTA1MjQzfTwvc3R5bGU+PHBhdGggY2xhc3M9InN0MjgiIGQ9Ik0yMCA1Mi4xTDAgNjJ2MTc1LjVsMjAgOS45LjEtLjFWNTIuMmwtLjEtLjEiLz48cGF0aCBjbGFzcz0ic3QyOSIgZD0iTTEyNyAyMjJMMjAgMjQ3LjVWNTIuMUwxMjcgNzd2MTQ1Ii8+PHBhdGggY2xhc3M9InN0MjgiIG [...]
     camel.apache.org/provider: "Apache Software Foundation"
@@ -9,7 +9,7 @@ metadata:
     camel.apache.org/kamelet.type: "source"
 spec:
   definition:
-    title: "AWS2 S3 Source"
+    title: "AWS S3 Source"
     description: |-
       Receive data from AWS S3.
     required:
diff --git a/docs/modules/ROOT/assets/images/kamelets/aws2-s3-source.svg b/docs/modules/ROOT/assets/images/kamelets/aws-s3-source.svg
similarity index 100%
rename from docs/modules/ROOT/assets/images/kamelets/aws2-s3-source.svg
rename to docs/modules/ROOT/assets/images/kamelets/aws-s3-source.svg
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 6a794bb..efa5ec4 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -1,7 +1,7 @@
 // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
 * xref:ROOT:aws-kinesis-source.adoc[image:kamelets/aws-kinesis-source.svg[] AWS Kinesis Source]
+* xref:ROOT:aws-s3-source.adoc[image:kamelets/aws-s3-source.svg[] AWS S3 Source]
 * xref:ROOT:aws-sqs-source.adoc[image:kamelets/aws-sqs-source.svg[] AWS SQS Source]
-* xref:ROOT:aws2-s3-source.adoc[image:kamelets/aws2-s3-source.svg[] AWS2 S3 Source]
 * xref:ROOT:bitcoin-source.adoc[image:kamelets/bitcoin-source.svg[] Bitcoin Source]
 * xref:ROOT:http-source.adoc[image:kamelets/http-source.svg[] HTTP Source]
 * xref:ROOT:jira-source.adoc[image:kamelets/jira-source.svg[] Jira Source]
diff --git a/docs/modules/ROOT/pages/aws2-s3-source.adoc b/docs/modules/ROOT/pages/aws-s3-source.adoc
similarity index 75%
rename from docs/modules/ROOT/pages/aws2-s3-source.adoc
rename to docs/modules/ROOT/pages/aws-s3-source.adoc
index cc5b51c..db0ce0b 100644
--- a/docs/modules/ROOT/pages/aws2-s3-source.adoc
+++ b/docs/modules/ROOT/pages/aws-s3-source.adoc
@@ -1,5 +1,5 @@
 // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
-= image:kamelets/aws2-s3-source.svg[] AWS2 S3 Source
+= image:kamelets/aws-s3-source.svg[] AWS S3 Source
 
 *Provided by: "Apache Software Foundation"*
 
@@ -7,7 +7,7 @@ Receive data from AWS S3.
 
 == Configuration Options
 
-The following table summarizes the configuration options available for the `aws2-s3-source` Kamelet:
+The following table summarizes the configuration options available for the `aws-s3-source` Kamelet:
 [width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
 |===
 | Property| Name| Description| Type| Default| Example
@@ -22,25 +22,25 @@ NOTE: Fields marked with ({empty}*) are mandatory.
 
 == Usage
 
-This section summarizes how the `aws2-s3-source` can be used in various contexts.
+This section summarizes how the `aws-s3-source` can be used in various contexts.
 
 === Knative Source
 
-The `aws2-s3-source` Kamelet can be used as Knative source by binding it to a Knative object.
+The `aws-s3-source` Kamelet can be used as Knative source by binding it to a Knative object.
 
-.aws2-s3-source-binding.yaml
+.aws-s3-source-binding.yaml
 [source,yaml]
 ----
 apiVersion: camel.apache.org/v1alpha1
 kind: KameletBinding
 metadata:
-  name: aws2-s3-source-binding
+  name: aws-s3-source-binding
 spec:
   source:
     ref:
       kind: Kamelet
       apiVersion: camel.apache.org/v1alpha1
-      name: aws2-s3-source
+      name: aws-s3-source
     properties:
       accessKey: "The Access Key"
       bucketNameOrArn: "The Bucket Name"
@@ -56,12 +56,12 @@ spec:
 
 Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.
 
-Save the `aws2-s3-source-binding.yaml` file into your hard drive, then configure it according to your needs.
+Save the `aws-s3-source-binding.yaml` file into your hard drive, then configure it according to your needs.
 
 You can run the source using the following command:
 
 [source,shell]
 ----
-kubectl apply -f aws2-s3-source-binding.yaml
+kubectl apply -f aws-s3-source-binding.yaml
 ----
 // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT