add doc hints for get.openziti.io function

openziti · Oct 31, 2023 · 898e416 · 898e416
1 parent 386db7c
commit 898e416
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/dist/cloudfront/get.openziti.io/README.md b/dist/cloudfront/get.openziti.io/README.md
@@ -0,0 +1,7 @@
+
+# CloudFront Function for get.openziti.io
+
+This function provides the routing logic for the GitHub raw reverse proxy for downloading specific versions of OpenZiti
+files that are checked in to GitHub.
+
+[Documented as part of the quickstart release](../../../quickstart/README.md#github-raw-reverse-proxy)
diff --git a/dist/cloudfront/get.openziti.io/routes.yml b/dist/cloudfront/get.openziti.io/routes.yml
@@ -1,4 +1,5 @@
-# this is a list of shortcut routes at get.openziti.io for raw.githubusercontent.com
+# this is a list of shortcut routes at get.openziti.io for raw.githubusercontent.com and is documented in
+# https://github.com/openziti/ziti/tree/main/quickstart#github-raw-reverse-proxy
 
 # these are file shortcuts, so the shortcut is the test file
 - get: /ziti-cli-functions.sh