New site design (kedacore#124)

* New KEDA website Signed-off-by: lucperkins <[email protected]> * Uncomment blog link on menus Signed-off-by: lucperkins <[email protected]> * Add links to scaler code Signed-off-by: lucperkins <[email protected]> * Small aesthetic fixes Signed-off-by: lucperkins <[email protected]> * More README docs Signed-off-by: lucperkins <[email protected]> * Update scaler info hero Signed-off-by: lucperkins <[email protected]> * Update deployment doc Signed-off-by: lucperkins <[email protected]> * Add subtitle to home page Scalers section Signed-off-by: lucperkins <[email protected]> * Add text shadow to hero text Signed-off-by: lucperkins <[email protected]> * Fix feature logos Signed-off-by: lucperkins <[email protected]> * Add RSS links and pagination to blog Signed-off-by: lucperkins <[email protected]> * Remove example blog posts Signed-off-by: lucperkins <[email protected]> * Add scalers list to bottom of docs Signed-off-by: lucperkins <[email protected]> * Add initial blog post Signed-off-by: lucperkins <[email protected]> * Delete unused files Signed-off-by: lucperkins <[email protected]> * Update Twitter Card metadata Signed-off-by: lucperkins <[email protected]> * Page source -> Suggest a change Signed-off-by: lucperkins <[email protected]> * Add resources page Signed-off-by: lucperkins <[email protected]> * Overhaul navigation Signed-off-by: lucperkins <[email protected]> * Add doc comments to config.toml Signed-off-by: lucperkins <[email protected]> * Fix Resources link in menu Signed-off-by: lucperkins <[email protected]> * Re-add get involved section to main page Signed-off-by: lucperkins <[email protected]> * Add community page to menu Signed-off-by: lucperkins <[email protected]>
nadnerb · Apr 1, 2020 · 18176a1 · 18176a1
1 parent b56c0e4
commit 18176a1
Show file tree

Hide file tree

Showing 426 changed files with 2,313 additions and 37,224 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,14 @@
+root = true
+
+[*]
+end_of_line = lf
+
+[Makefile]
+indent_style = tab
+
+[*.{html,js,json,md,sass,toml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{js,json,md,sass,toml,yaml}]
+insert_final_newline = true
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,8 @@
+node_modules/
 public/
 .idea
-resources/_gen/
+resources/
+
+# Link checker artifacts
+bin/
+tmp/
diff --git a/.gitmodules b/.gitmodules
diff --git a/.htmltest.yml b/.htmltest.yml
@@ -0,0 +1,4 @@
+DirectoryPath: public
+IgnoreDirectoryMissingTrailingSlash: true
+CheckExternal: false
+IgnoreAltMissing: true
diff --git a/Makefile b/Makefile
@@ -0,0 +1,36 @@
+clean:
+	rm -rf public resources
+
+yarn:
+	yarn
+
+serve: yarn
+	hugo server \
+		--buildDrafts \
+		--buildFuture
+
+production-build: clean
+	hugo \
+		--minify
+
+	make check-links
+
+preview-build: clean
+	hugo \
+		--baseURL $(DEPLOY_PRIME_URL) \
+		--buildDrafts \
+		--buildFuture \
+		--minify
+
+	make check-links
+
+open:
+	open https://keda.sh
+
+link-checker-setup:
+	curl https://htmltest.wjdp.uk | bash
+
+run-link-checker:
+	bin/htmltest
+
+check-links: link-checker-setup run-link-checker
diff --git a/README.md b/README.md
@@ -1,24 +1,83 @@
 # KEDA - Docs
-Documentation and landing page for KEDA
 
-## Building docs locally
+Documentation and landing page for the KEDA project at https://keda.sh.
 
-Install Hugo Extended:
+## Running the site locally
 
-Windows:
+Install [Hugo](https://gohugo.io/getting-started/installing/) (the "extended" version with [Hugo Pipes](https://gohugo.io/hugo-pipes/introduction/) support) and [Yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable):
 
-```
+### Windows
+
+```sh
 choco install hugo-extended
+choco install yarn
 ```
 
-Mac:
+### Mac
 
-```
+```sh
 brew install hugo
+brew install yarn
+```
+
+Now you can run the docs locally:
+
+```sh
+yarn
+
+hugo server -D -F
+```
+
+## Publishing the site
+
+The KEDA website is published automatically by [Netlify](https://netlify.com). Any time changes to this repo are pushed to `master`, the site is re-built and re-published in roughly two minutes.
+
+## Adding blog posts
+
+To add a new post to the [Keda blog](https://keda.sh/blog):
+
+```sh
+hugo new blog/my-new-post.md
+```
+
+This creates a boilerplate Markdown file in `content/blog/my-new-post.md` whose contents you can modify. The following fields are required:
+
+* `title`
+* `date` (in `YYYY-MM-DD` format)
+* `author`
+
+## Adding scaler documentation
+
+To add documentation for a new KEDA [scaler](https://keda.sh/docs/scalers):
+
+```sh
+hugo new --kind scaler docs/scalers/my-new-scaler.md
+```
+
+This creates a boilerplate Markdown file in `content/docs/scalers/my-new-scaler.md` whose contents you can modify. Make sure to update the following metadata fields:
+
+* `title`
+* `availability`
+* `maintainer`
+* `description`
+
+## Updating the FAQ
+
+To update the KEDA [FAQ page](https://keda.sh/docs/faq), update the TOML file at [`data/faq.toml`]. Here's an example question/answer pair:
+
+```toml
+[[qna]]
+q = "How can I add a new question/answer pair?"
+a = "You're looking at it! 😀"
 ```
 
-Run docs locally:
+## Updating the troubleshooting page
 
+To add a new section to the [troubleshooting page](https://keda.sh/docs/troubleshooting):
+
+```sh
+hugo new troubleshooting/my-new-issue.md
 ```
-hugo server -D
-```
+
+To adjust the order in which the troubleshooting tiles appear, use the `weight` parameter in each page's metadata.
+
diff --git a/archetypes/blog.md b/archetypes/blog.md
@@ -0,0 +1,5 @@
++++
+title = "{{ replace .Name "-" " " | title }}"
+date = {{ dateFormat "2006-01-02" .Date }}
+author = "Scaley McAutoscaler"
++++
diff --git a/archetypes/scaler.md b/archetypes/scaler.md
@@ -0,0 +1,35 @@
++++
+title = "{{ replace .Name "-" " " | title }}"
+availability = ""
+maintainer = ""
+description = "Insert description here"
++++
+
+### Trigger Specification
+
+This specification describes the `*Scaler Type*` trigger that scales based on a Huawei Cloudeye.
+
+```yaml
+triggers:
+  - type: *Scaler Type*
+    metadata:
+      namespace: SYS.ELB
+```
+
+**Parameter list:**
+
+- `namespace` is the namespace of the metric. The format is service.item; service and item must be strings, must start with a letter, can only contain 0-9/a-z/A-Z/_, the total length of service.item is 3, the maximum is 32. (required)
+
+### Authentication Parameters
+
+You can use `TriggerAuthentication` CRD to configure the authenticate by providing a set of IAM credentials.
+
+**Credential based authentication:**
+
+- `IdentityEndpoint` - Endpoint to verify the identity against
+
+The user will need access to read data from Huawei Cloudeye.
+
+### Example
+
+*Provide an example of how to configure the trigger, preferably using TriggerAuthentication* 
diff --git a/archetypes/troubleshooting.md b/archetypes/troubleshooting.md
@@ -0,0 +1,5 @@
++++
+title = "Replace this with a question"
++++
+
+And provide the answer here...
diff --git a/assets/sass/card.sass b/assets/sass/card.sass
@@ -0,0 +1,18 @@
+.card
+  height: 100%
+  border: $card-border
+  border-radius: 5px
+
+  display: flex
+  flex-direction: column
+
+  &.is-dark
+    background-color: $black-bis
+    color: $white-bis
+
+  &-content
+    flex: 1
+
+  &.is-collapsible
+    & + &
+      margin-top: 0.5rem
diff --git a/assets/sass/content.sass b/assets/sass/content.sass
@@ -0,0 +1,30 @@
+.content
+  a sup
+    margin-left: 0.1rem
+
+  ol li pre
+    margin-bottom: 1rem
+
+  .highlight
+    margin-bottom: 1rem
+
+  &.is-constrained
+    max-width: 90ch
+
+  &.has-bottom-margin
+    margin-bottom: 8rem
+
+  // Headline hashes
+  .headline-hash
+    display: none
+    margin-left: 0.25rem
+    color: $secondary
+
+  @for $i from 1 through 6
+    h#{$i}
+      &:hover > .headline-hash
+        display: inline
+
+  figure img
+    +desktop
+      width: 80%
diff --git a/assets/sass/nav.sass b/assets/sass/nav.sass
@@ -0,0 +1,53 @@
+=active
+  font-weight: $weight-bold
+
+  a
+    color: $primary !important
+
+=split-x
+  display: flex
+  flex-direction: row
+  justify-content: space-between
+
+
+.nav
+  padding-bottom: 2rem
+
+  &-section
+    &-title
+      a
+        font-weight: 600
+        color: $dark
+
+      +split-x
+
+      &.is-active
+        +active
+
+    &-toc
+      padding: 0.35rem 0 0.75rem 1rem
+      //padding: 0.75rem 0 0.75rem 1rem
+
+      li a
+        color: $grey
+
+      ul + ul
+        margin-top: 0.3rem
+
+    ul.nav-section-links
+      margin: 0.5rem 0 0.75rem 1rem
+
+      li.nav-section-link
+        font-size: 1.1rem
+
+        a
+          color: $dark
+
+        &.is-active
+          +active
+
+        & + li.nav-section-link
+          margin-top: 0.4rem
+
+    & + &
+      margin-top: 1rem