Initial documentation boilerplate

.gitignore

@@ -0,0 +1,2 @@
+public/
+resources/_gen/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/syna"]
+	path = themes/syna
+	url = https://git.okkur.org/syna

README.md

@@ -1,2 +1,18 @@
-# keda-docs
+# KEDA - Docs
 Documentation and landing page for KEDA
+
+## Building docs locally
+
+Install Hugo Extended:
+
+Windows:
+
+```
+choco install hugo-extended
+```
+
+Run docs locally:
+
+```
+hugo server -D
+```

config.toml

@@ -0,0 +1,112 @@
+# Site settings
+baseurl = "/"
+languageCode = "en-us"
+title = "Kubernetes event-driven Autoscaling (KEDA)"
+theme = "syna"
+enableGitInfo = true
+version = "0.15.2"
+
+# Google Analytics tracking
+googleAnalytics = ""
+
+[outputs]
+  home = ["HTML", "JSON"]
+
+[frontmatter]
+date = ["date", "lastmod"]
+lastmod = ["lastmod", ":git", "date"]
+
+[params]
+  name = "KEDA"
+  description = "Kubernetes Event-driven Autoscaling"
+
+  [params.style]
+    #background = "secondary"
+
+  # Theme customizations
+  # Assets relative to 'static/'
+  [params.custom]
+    favicon = "images/favicon.ico"
+    favicon_ico_sizes = "16x16 32x32"
+
+  # Piwik tracking
+  [params.analytics.piwik]
+    #url = ""
+    #id = ""
+    #domain = "" # Track subdomains via "*.example.com"
+    # Optional hash for integrity check
+    #hash = "sha512-RfeD0pacGTqy9m7U6PgehQfS4cc7SIt+e+P+H5e848kEvB/RW84CUGO3O4O3LNbxjevym6KPUZ8muPsMrI8WIw=="
+
+  # Optional, global disable switch for fontawesome related files
+  # For custom fontawesome js files use the custom.js method
+  [params.fontawesome]
+    disabled = false
+    pro = false
+
+  [params.colors]
+    primary = "#00838F"
+    secondary = "#868e96"
+    success = "#008f54"
+    info = "#00c9dc"
+    warning = "#fdf314"
+    danger = "#dc1200"
+    light = "#f8f9fa"
+    dark = "#343a40"
+
+# main/prepend/postpend menus are displayed in nav fragment.
+# Keep an eye out for updates. These will be moved out to make navbar more
+# configurable.
+[[menu.main]]
+  url = "/"
+  name = "Home"
+  weight = 10
+
+[[menu.main]]
+  url = "/getting-started"
+  name = "Getting Started"
+  weight = 20
+
+[[menu.main]]
+  url = "/deploy"
+  name = "Deploying KEDA"
+  weight = 30
+
+[[menu.main]]
+  url = "/architecture"
+  name = "Architecture"
+  weight = 40
+
+[[menu.main]]
+  url = "/faq"
+  name = "FAQ"
+  weight = 50
+
+[[menu.footer]]
+  url = "/getting-started"
+  name = "Getting Started"
+  weight = 10
+
+[[menu.footer]]
+  url = "/deploy"
+  name = "Deploying KEDA"
+  weight = 20
+
+[[menu.footer]]
+  url = "/architecture"
+  name = "Architecture"
+  weight = 30
+
+[[menu.footer]]
+  url = "https://github.com/kedacore/keda"
+  name = "GitHub"
+  weight = 40
+
+[[menu.footer]]
+  url = "/faq"
+  name = "FAQ"
+  weight = 50
+
+[[menu.copyright_footer]]
+  url = "https://github.com/kedacore/keda"
+  name = "GitHub"
+  weight = 10

content/FAQ.md

@@ -0,0 +1,54 @@
++++
+title = "FAQ"
+date = "2017-10-05"
+fragment = "content"
+weight = 100
++++
+
+#### What is KEDA and why is it useful?
+KEDA stands for Kubernetes Event Driven Auto-Scaler. It is built to be able to activate a Kubernetes deployment (i.e. no pods to a single pod) and subsequently to more pods based on events from various event sources.
+
+#### What are the prerequisites for using KEDA?
+KEDA is designed to be run on any vanilla Kubernetes cluster. It uses a CRD and needs a Metric Server so you will have to use a Kubernetes version which supports these. Any Kubernetes cluster >= 1.11.10 have been tested and should work.
+
+#### Does KEDA depend on any Azure service?
+No, KEDA only takes a dependency on vanilla Kubernetes constructs and can run on any Kubernetes cluster whether in OpenShift, AKS, GKE, EKS or your own.
+
+#### Does KEDA only work with Azure Functions?
+No, KEDA can scale up/down any container that you specify in your deployment. There has however been work done in the Azure Function tooling to make it easy to install an Azure Function container.
+
+#### Why should we use KEDA if we are already use Azure Functions in Azure?
+
+* Want to run functions on-premises (potentially in something like an 'intelligent edge' architecture)
+* Want to run functions alongside other Kubernetes apps (maybe in a restricted network, app mesh, custom environment, etc.)
+* Want to run functions outside of Azure (no vendor lockin)
+* Specific need for more control (GPU enabled compute clusters, more knobs and such)
+
+#### Can I scale my Http triggered Azure Function on Kubernetes with KEDA?
+Yes we currently enable this through Osiris. It is integrated in the Azure Functions tooling i.e. through the Core tools. We are working on making significant investment in this scenario going forward. Stay tuned!
+
+How do I add a new Scaler?
+[TODO]
+
+####  Where can I get to the code for the Scalers?
+All scalers have their code [here](https://github.com/kedacore/keda/tree/master/pkg/scalers)
+
+#### Is short polling intervals a problem?
+Polling interval really only impacts the time-to-activation (scaling from 0 to 1) but once scaled to one it's really up to the HPA which polls KEDA.
+
+#### How can I get involved?
+There are several ways to get involved.
+
+* Pick up an issue to work on. A good place to start might be issues which are marked as [Good First Issue](https://github.com/kedacore/keda/labels/good%20first%20issue) or [Help Wanted](https://github.com/kedacore/keda/labels/help%20wanted)
+* We are always looking to add more scalers. These are some ideas of missing scalers
+* We are always looking for more samples, documentation etc.
+* Please join us in our [weekly standup](https://github.com/kedacore/keda#community-standup)
+
+#### Can KEDA be used in production?
+As of September 2019 KEDA is still in beta and hence it is not suggested to use in production. We are fast approaching a 1.0 release and then you should be able to use it in production.
+
+#### Is there an ETA for KEDA release 1.0?
+Currently we are targeting the end of 2019 if not earlier for a KEDA 1.0 release.
+
+#### What does it cost?
+There is no charge for using KEDA itself.

content/_global/copyright.md

@@ -0,0 +1,7 @@
++++
+fragment = "copyright"
+date = "2016-09-07"
+weight = 1250
+copyright = "" # default: Copyright $Year .Site.params.name
+attribution = true # enable attribution by setting it to true
++++

content/_global/footer.md

@@ -0,0 +1,14 @@
++++
+fragment = "footer"
+date = "2016-09-07"
+weight = 1200
+menu_title = "Learn More"
+
+[asset]
+  title = "KEDA"
+  image = "logo-transparent.png"
+  text = "Logo Subtext"
+  url = "#"
++++
+
+KEDA is open-source under MIT License

content/_global/index.md

@@ -0,0 +1,3 @@
++++
+headless = true
++++

content/_global/nav.md

@@ -0,0 +1,15 @@
++++
+fragment = "nav"
+date = "2018-05-17"
+weight = 0
+
+[repo_button]
+  url = "https://github.com/kedacore/keda"
+  text = "Star" # default: "Star"
+  icon = "fab fa-github" # defaults: "fab fa-github"
+
+# Branding options
+[asset]
+  image = "logo-transparent.png"
+  text = "KEDA"
++++

content/_index/contact.md

@@ -0,0 +1,51 @@
++++
+fragment = "contact"
+disabled = true
+date = "2017-09-10"
+weight = 1100
+#background = "light"
+form_name = "defaultContact"
+
+title = "Contact fragment"
+subtitle  = "*not working on demo page*"
+
+# PostURL can be used with backends such as mailout from caddy
+post_url = "https://example.com/mailout" #default: formspree.io
+email = "[email protected]"
+button = "Send Button" # defaults to theme default
+#netlify = false
+
+# Optional google captcha
+#[recaptcha]
+#  sitekey = ""
+
+[message]
+  #success = "" # defaults to theme default
+  #error = "" # defaults to theme default
+
+# Only defined fields are shown in contact form
+[fields.name]
+  text = "Your Name *"
+  #error = "" # defaults to theme default
+
+[fields.email]
+  text = "Your Email *"
+  #error = "" # defaults to theme default
+
+[fields.phone]
+  text = "Your Phone *"
+  #error = "" # defaults to theme default
+
+[fields.message]
+  text = "Your Message *"
+  #error = "" # defaults to theme default
+
+# Optional hidden form fields
+# Fields "page" and "site" will be autofilled
+[[fields.hidden]]
+  name = "page"
+
+[[fields.hidden]]
+  name = "someID"
+  value = "example.com"
++++

content/_index/features/cloud-agnostic.md

@@ -0,0 +1,9 @@
++++
+title = "Vendor-Agnostic"
+weight = 50
+
+[asset]
+  icon = "fas fa-cloud"
++++
+
+Support for triggers across multiple vendors

content/_index/features/event-driven.md

@@ -0,0 +1,9 @@
++++
+title = "Event-driven"
+weight = 40
+
+[asset]
+  icon = "fas fa-bolt"
++++
+
+Scale your event-driven application

content/_index/features/index.md

@@ -0,0 +1,6 @@
++++
+fragment = "items"
+weight = 100
+background = "light"
+title = "Features"
++++

content/_index/features/scalers.md

@@ -0,0 +1,9 @@
++++
+title = "Built-in Scalers"
+weight = 30
+
+[asset]
+  icon = "fas fa-cubes"
++++
+
+Out-of-the-box scalers for various vendors

content/_index/features/scaling-made-simple.md

@@ -0,0 +1,9 @@
++++
+title = "Autoscaling Made Simple"
+weight = 10
+
+[asset]
+  icon = "fas fa-rocket"
++++
+
+Just let us know how to scale, we've got this

content/_index/features/workload-types.md

@@ -0,0 +1,9 @@
++++
+title = "Multiple Workload Types"
+weight = 30
+
+[asset]
+  icon = "fas fa-shapes"
++++
+
+Support for variety of workload types such as deployments & jobs

content/_index/hero.md

@@ -0,0 +1,38 @@
++++
+fragment = "hero"
+#disabled = true
+date = "2016-09-07"
+weight = 50
+background = "light" # can influence the text color
+particles = true
+title = "KEDA"
+subtitle = "Kubernetes Event-driven Autoscaling (KEDA)"
+
+[header]
+  image = "header.jpg"
+
+[asset]
+  image = "logo-transparent.png"
+  width = "500px" # optional - will default to image width
+  #height = "150px" # optional - will default to image height
+
+[[buttons]]
+  text = "Getting Started"
+  url = "/getting-started"
+  color = "success" # primary, secondary, success, danger, warning, info, light, dark, link - default: primary
+
+[[buttons]]
+  text = "Deploying KEDA"
+  url = "/deploy"
+  color = "primary" # primary, secondary, success, danger, warning, info, light, dark, link - default: primary
+
+[[buttons]]
+  text = "Architecture"
+  url = "/Architecture"
+  color = "info" # primary, secondary, success, danger, warning, info, light, dark, link - default: primary
+
+[[buttons]]
+  text = "GitHub"
+  url = "https://github.com/kedacore/keda"
+  color = "dark" # primary, secondary, success, danger, warning, info, light, dark, link - default: primary
++++