[camel] 03/04: CAMEL-18077: camel-jbang - Run from gist

[da...@apache.org]

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

davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git

commit cccc1dba5996ec8f1030041412038776b5d2a2ca
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Sun May 8 07:55:45 2022 +0200

    CAMEL-18077: camel-jbang - Run from gist
---
 .../src/main/docs/resourceresolver-github.adoc        | 19 +++++++++++++++++++
 docs/user-manual/modules/ROOT/pages/camel-jbang.adoc  | 14 ++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc b/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc
index 869f140a4b0..c75e77c7593 100644
--- a/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc
+++ b/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc
@@ -41,3 +41,22 @@ github:apache:camel-kamelets:kamelets/aws-ddb-streams-source.kamelet.yaml
 
 IMPORTANT: This resource resolver can potentially load any resources from GitHub that are in public repositories.
 It's not recommended for production usage, but is great for development and demo purposes.
+
+== Resolving from gist
+
+You can also load resources from gist
+
+The syntax is
+
+[source,text]
+----
+gist:user:id:cid:fileName
+----
+
+For example:
+
+[source,text]
+----
+gist:davsclaus:477ddff5cdeb1ae03619aa544ce47e92:cd1be96034748e42e43879a4d27ed297752b6115:mybeer.xml
+----
+
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
index 52a9b34f6d4..2d6cf4e818c 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
@@ -150,6 +150,20 @@ Or you can run all files starting with rou*
 camel run https://github.com/apache/camel-k/tree/main/examples/languages/rou*
 ----
 
+==== Running routes from GitHub gists
+
+Using gists from GitHub is a quick way to share small Camel routes that you can easily run.
+
+For example to run a gist you simply do:
+
+[source,bash]
+----
+camel run https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92
+----
+
+A gist can contain one or more files, and Camel JBang will gather all relevant files, so a gist
+can contain multiple routes, properties files, Java beans, etc.
+
 === Downloading routes hosted on GitHub
 
 We have made it easy for Camel JBang to download existing examples from GitHub to local disk,