From b8fcf1449281e7aff96457edda804ad6a9b7f89c Mon Sep 17 00:00:00 2001 From: MikeG <62085623+Michaelg22@users.noreply.github.com> Date: Mon, 15 Aug 2022 22:57:49 -0700 Subject: [PATCH] Add files via upload --- docs/Gemfile | 19 ++++ docs/Gemfile.lock | 273 +++++++++++++++++++++++++++++++++++++++++++++ docs/_config.yml | 38 +++++++ docs/cdks.md | 42 +++++++ docs/concepts.md | 7 ++ docs/connectors.md | 7 ++ docs/index.md | 20 ++++ docs/operator.md | 7 ++ 8 files changed, 413 insertions(+) create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_config.yml create mode 100644 docs/cdks.md create mode 100644 docs/concepts.md create mode 100644 docs/connectors.md create mode 100644 docs/index.md create mode 100644 docs/operator.md diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 00000000..77ea4075 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,19 @@ +source "https://rubygems.org" +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! + +gem "jekyll", "~> 3.9" +gem "github-pages", group: :jekyll_plugins + +gem "just-the-docs" + +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.15" +end \ No newline at end of file diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 00000000..12c2b1d7 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,273 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (6.0.3.4) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + zeitwerk (~> 2.2, >= 2.2.2) + addressable (2.8.0) + public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.23.4) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.10) + dnsruby (1.61.5) + simpleidn (~> 0.1) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + ethon (0.12.0) + ffi (>= 1.3.0) + eventmachine (1.2.7) + execjs (2.7.0) + faraday (1.1.0) + multipart-post (>= 1.2, < 3) + ruby2_keywords + ffi (1.15.5) + forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (209) + github-pages-health-check (= 1.16.1) + jekyll (= 3.9.0) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.6) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.15.1) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.13.0) + jekyll-mentions (= 1.6.0) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.16.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.2) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.6.1) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.2) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.12.0) + kramdown (= 2.4.0) + kramdown-parser-gfm (= 1.1.0) + liquid (= 4.0.3) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.10.4, < 2.0) + rouge (= 3.23.0) + terminal-table (~> 1.4) + github-pages-health-check (1.16.1) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (~> 3.0) + typhoeus (~> 1.3) + html-pipeline (2.14.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.8.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.9.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (>= 1.17, < 3) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.23.4) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.23.4) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.15.1) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.13.0) + jekyll (>= 3.4, < 5.0) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.6.0) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.2) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.2) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.4) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.12.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + just-the-docs (0.3.3) + jekyll (>= 3.8.5) + jekyll-seo-tag (~> 2.0) + rake (>= 12.3.1, < 13.1.0) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.7.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + mini_portile2 (2.8.0) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.14.2) + multipart-post (2.1.1) + nokogiri (1.13.6) + mini_portile2 (~> 2.8.0) + racc (~> 1.4) + octokit (4.19.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (3.1.1) + racc (1.6.0) + rake (13.0.1) + rb-fsevent (0.11.1) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.5) + rouge (3.23.0) + ruby-enum (0.9.0) + i18n + ruby2_keywords (0.0.2) + rubyzip (2.3.0) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + simpleidn (0.1.1) + unf (~> 0.1.4) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (1.2.10) + thread_safe (~> 0.1) + unf (0.1.4) + unf_ext + unf_ext (0.0.7.7) + unicode-display_width (1.7.0) + zeitwerk (2.4.1) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + jekyll (~> 3.9) + jekyll-feed (~> 0.15) + just-the-docs + +BUNDLED WITH + 2.1.4 +© 2022 GitHub, Inc. +Terms diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 00000000..f1467380 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,38 @@ +# To configure the environment locally to test the website, check out +# https://help.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll + +title: Vance +baseurl: "/Vance" +url: "https://linkall-labs.github.io" +remote_theme: just-the-docs/just-the-docs +plugins: + - jemoji + +search_enabled: true + +gh_edit_link: true +gh_edit_link_text: "Edit this page on GitHub." +gh_edit_repository: "https://github.com/linkall-labs/vance" +gh_edit_branch: "main" +gh_edit_source: docs +gh_edit_view_mode: "tree" + +aux_links: + "GitHub Repository": + - "https://github.com/linkall-labs/vance" + "Linkall home": + - "https://linkall.com/" +back_to_top: true +back_to_top_text: "Back to top" + +footer_content: "Copyright © 2022 Linkall, Inc." + +compress_html: + clippings: all + comments: all + endings: all + startings: [] + blanklines: false + profile: false + # ignore: + # envs: all diff --git a/docs/cdks.md b/docs/cdks.md new file mode 100644 index 00000000..6c4e687b --- /dev/null +++ b/docs/cdks.md @@ -0,0 +1,42 @@ +--- +layout: default +title: CDKs +nav_order: 5 +description: "Connector-Deployment Kits (CDKs) are collections of packages to help you to build a new [Vance Connector][vc] in minutes." +permalink: /cdks.md + +# CDKs for Vance + +## Introduction +A CDK aim's to speed up the development of a vance connector by offering some utilities including: + +HTTP implementations (either to handle general HTTP requests or CloudEvents) +Config implementation to load user-specific configs +The ability to interact with the Vance operator +and more. + +## Getting started +--- + # CDK-java + To use the cdk-java, add following dependency to your pom.xml + ``` + + com.linkall + cdk-java + 0.1.0 + +``` +for more information visit [CDK-java][javacdk] +--- +# CDK-Go +To use the cdk-go, add following dependency to your go.mod +``` +require ( + github.com/linkall-labs/cdk-go v0.1.0 +) +``` +for more information visit [CDK-Go][gocdk] +--- +[vc]: https://github.com/linkall-labs/vance-docs/blob/main/docs/concept.md +[javacdk]: https://linkall-labs.github.io/cdk-java/ +[gocdk]: https://linkall-labs.github.io/cdk-go/ diff --git a/docs/concepts.md b/docs/concepts.md new file mode 100644 index 00000000..ace7b691 --- /dev/null +++ b/docs/concepts.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Concepts +nav_order: 2 +description: "" +permalink: /concepts.md +--- diff --git a/docs/connectors.md b/docs/connectors.md new file mode 100644 index 00000000..f2ca3329 --- /dev/null +++ b/docs/connectors.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Connectors +nav_order: 3 +description: "" +permalink: /connector.md +--- diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..c23ddc0d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +--- +layout: default +title: Home +nav_order: 1 +description: "The Java Connector-Development Kit (CDK) is a collection of Java packages to help you to build a new [Vance Connector][vc] in minutes." +permalink: / +--- + +# Vance +{: .fs-9 } + +## Introduction + +A Connector-Development Kit (CDK) aims to speed up the development of a Vance connector by offering some utilities including: +- HTTP implementations (either to handle general HTTP requests or CloudEvents) +- Config implementation to load user-specific configs +- The ability to interact with the Vance operator +- And more. + +## Getting started diff --git a/docs/operator.md b/docs/operator.md new file mode 100644 index 00000000..7b7fa55e --- /dev/null +++ b/docs/operator.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Home +nav_order: 4 +description: "" +permalink: /operator.md +---