Added docs website scaffolding (#511)

aws · Jul 14, 2021 · b586684 · b586684
1 parent 4c17e4a
commit b586684
Show file tree

Hide file tree

Showing 93 changed files with 12,248 additions and 900 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 coverage.out
 coverage.html
 *.test
+website/node_modules
+website/resources
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "website/themes/docsy"]
+	path = website/themes/docsy
+	url = https://github.com/google/docsy.git
diff --git a/.nojekyll b/.nojekyll
diff --git a/docs/README.md → API.md b/docs/README.md → API.md
@@ -427,5 +427,5 @@ its target, and indicates whether or not those conditions are met.</p>
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>b4e9691</code>.
+on git commit <code>5e4fe45</code>.
 </em></p>
diff --git a/docs/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md
diff --git a/docs/CONTRIBUTING.md → CONTRIBUTING.md b/docs/CONTRIBUTING.md → CONTRIBUTING.md
diff --git a/docs/DEVELOPER_GUIDE.md → DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md → DEVELOPER_GUIDE.md
@@ -1,8 +1,8 @@
-# Contributing
+# Developer Guide
 
 ## Dependencies
 
-The following tools are required for doing development on Karpenter.
+The following tools are required for developing the Karpenter operator.
 
 | Package                                                            | Version  | Install                |
 | ------------------------------------------------------------------ | -------- | ---------------------- |
@@ -11,6 +11,12 @@ The following tools are required for doing development on Karpenter.
 | [helm](https://helm.sh/docs/intro/install/)                        |          | `brew install helm`    |
 | Other tools                                                        |          | `make toolchain`       |
 
+The following tools are required for developing the Karpenter website.
+| Package                       | Version | Install             |
+| ----------------------------- | ------- | ------------------- |
+| [hugo](https://gohugo.io/)    |         | `brew install hugo` |
+| [npm](https://www.npmjs.com/) |         | `brew install node` |
+
 ## Developing
 
 ### Setup / Teardown

diff --git a/docs/FAQs.md → FAQs.md b/docs/FAQs.md → FAQs.md
diff --git a/Makefile b/Makefile
@@ -66,19 +66,22 @@ codegen: ## Generate code. Must be run if changes are made to ./pkg/apis/...
 	gen-crd-api-reference-docs \
 		-api-dir ./pkg/apis/provisioning/v1alpha2 \
 		-config $(shell go env GOMODCACHE)/github.com/ahmetb/[email protected]/example-config.json \
-		-out-file docs/README.md \
+		-out-file API.md \
 		-template-dir $(shell go env GOMODCACHE)/github.com/ahmetb/[email protected]/template
 
 publish: ## Generate release manifests and publish a versioned container image.
 	@aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin $(RELEASE_REPO)
-	yq e -i ".controller.image = \"$$($(WITH_RELEASE_REPO) $(WITH_GOFLAGS) ko publish -B -t $(RELEASE_VERSION) --platform all ./cmd/controller)\"" ./charts/karpenter/values.yaml
-	yq e -i ".webhook.image = \"$$($(WITH_RELEASE_REPO) $(WITH_GOFLAGS) ko publish -B -t $(RELEASE_VERSION) --platform all ./cmd/webhook)\"" ./charts/karpenter/values.yaml
-	yq e -i '.version = "$(RELEASE_VERSION)"' ./charts/karpenter/Chart.yaml
+	yq e -i ".controller.image = \"$$($(WITH_RELEASE_REPO) $(WITH_GOFLAGS) ko publish -B -t $(RELEASE_VERSION) --platform all ./cmd/controller)\"" charts/karpenter/values.yaml
+	yq e -i ".webhook.image = \"$$($(WITH_RELEASE_REPO) $(WITH_GOFLAGS) ko publish -B -t $(RELEASE_VERSION) --platform all ./cmd/webhook)\"" charts/karpenter/values.yaml
+	yq e -i '.version = "$(RELEASE_VERSION)"' charts/karpenter/Chart.yaml
 
-helm:  ## Generate Helm Chart
+helm: ## Generate Helm Chart
 	cd charts;helm lint karpenter;helm package karpenter;helm repo index .
 
+website: ## Generate Docs Website
+	cd website;npm install;hugo -d ../docs
+
 toolchain: ## Install developer toolchain
 	./hack/toolchain.sh
 
-.PHONY: help dev ci release test battletest verify codegen apply delete publish helm toolchain licenses
+.PHONY: help dev ci release test battletest verify codegen apply delete publish helm website toolchain licenses
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![GitHub License](https://img.shields.io/badge/License-Apache%202.0-ff69b4.svg)](https://github.com/awslabs/karpenter/blob/main/LICENSE)
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/awslabs/karpenter/issues)
 
-![](docs/images/karpenter-banner.png)
+![](images/karpenter-banner.png)
 
 Karpenter is a node lifecycle management solution. It observes incoming pods and launches the right instances for the situation. Instance selection decisions are intent based and driven by the specification of incoming pods, including resource requests and scheduling constraints.
 
@@ -14,35 +14,35 @@ It's responsible for:
 - **Terminating** nodes if outdated or no longer needed
 - **Draining** nodes gracefully before preemption
 
-For most use cases, the entirety of a cluster’s capacity can be managed by a single Karpenter [Provisioner](./docs/README.md). Availability zone, instance type, capacity type, machine image, and scheduling constraints are automatically determined by the controller using a combination of defaults and overrides. Additionally, you can define multiple Provisioners, enabling use cases like isolation, entitlements, and sharding.
+For most use cases, the entirety of a cluster’s capacity can be managed by a single Karpenter [Provisioner](README.md). Availability zone, instance type, capacity type, machine image, and scheduling constraints are automatically determined by the controller using a combination of defaults and overrides. Additionally, you can define multiple Provisioners, enabling use cases like isolation, entitlements, and sharding.
 
 Karpenter optimizes for scheduling latency and utilization efficiency using two complementary control loops. First, is the allocator, a fast-acting latency-sensitive controller responsible for ensuring that incoming pods are scheduled as quickly as possible. Second, is the reallocator, a slow-acting cost-sensitive controller that replaces nodes as pods requests and capacity prices shift over time. Together, they maximize the availability and efficiency of your cluster.
 
 Come discuss Karpenter in the [#provider-aws channel](https://kubernetes.slack.com/archives/C0LRMHZ1T) in the [Kubernetes slack](https://slack.k8s.io/)!
 
-*Note: Reallocation is still in development. Check out the [FAQs](docs/FAQs.md) and [Roadmap](docs/ROADMAP.md) to learn more.*
+*Note: Reallocation is still in development. Check out the [FAQs](FAQs.md) and [Roadmap](ROADMAP.md) to learn more.*
 
-<img src="docs/images/karpenter-overview.jpg" width="50%" height="50%">
+<img src="images/karpenter-overview.jpg" width="50%" height="50%">
 
 ## Installation
 
 Follow the setup recommendations of your cloud provider.
-- [AWS](docs/aws)
+- [AWS](pkg/cloudprovider/aws/docs)
 
 > ❗ Note: There may be backwards incompatible changes between versions when upgrading before v0.3.0. Karpenter follows [Kubernetes versioning guidelines](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-changes). Before upgrading, we recommend:
 > - Check the [release notes](https://github.com/awslabs/karpenter/releases)
 > - Uninstall Karpenter
 > - Remove all nodes launched by karpenter
 > - Reinstall Karpenter
 
-## Docs
-- [API](docs/README.md)
-- [FAQs](docs/FAQs.md)
-- [Roadmap](docs/ROADMAP.md)
-- [Examples](docs/aws/examples)
-- [Working Group](docs/working-group)
-- [Developer Guide](docs/DEVELOPER_GUIDE.md)
-- [Contributing](docs/CONTRIBUTING.md)
+## References
+- [Docs](https://awslabs.github.io/karpenter/docs)
+- [API](README.md)
+- [FAQs](FAQs.md)
+- [Roadmap](ROADMAP.md)
+- [Working Group](WORKING_GROUP.md)
+- [Developer Guide](DEVELOPER_GUIDE.md)
+- [Contributing](CONTRIBUTING.md)
 
 ## Talks
 - [Karpenter @ Container Day, May 2021](https://www.twitch.tv/videos/1010593737?t=141m50s)

diff --git a/docs/ROADMAP.md → ROADMAP.md b/docs/ROADMAP.md → ROADMAP.md
diff --git a/docs/TROUBLESHOOTING.md → TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md → TROUBLESHOOTING.md
diff --git a/docs/working-group/README.md → WORKING_GROUP.md b/docs/working-group/README.md → WORKING_GROUP.md
diff --git a/docs/designs/aws-launch-templates-options.md → designs/aws-launch-templates-options.md b/docs/designs/aws-launch-templates-options.md → designs/aws-launch-templates-options.md
diff --git a/docs/designs/bin-packing.md → designs/bin-packing.md b/docs/designs/bin-packing.md → designs/bin-packing.md
diff --git a/docs/designs/termination.md → designs/termination.md b/docs/designs/termination.md → designs/termination.md
diff --git a/docs/404.html b/docs/404.html
@@ -0,0 +1,128 @@
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+<meta name="generator" content="Hugo 0.85.0" /><META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
+
+
+<link rel="shortcut icon" href="/karpenter/docs/favicons/favicon.ico" >
+<link rel="apple-touch-icon" href="/karpenter/docs/favicons/apple-touch-icon-180x180.png" sizes="180x180">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/favicon-16x16.png" sizes="16x16">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/favicon-32x32.png" sizes="32x32">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-36x36.png" sizes="36x36">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-48x48.png" sizes="48x48">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-72x72.png" sizes="72x72">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-96x96.png" sizes="96x96">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-144x144.png" sizes="144x144">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-192x192.png" sizes="192x192">
+
+<title>404 Page not found | Karpenter</title>
+<meta name="description" content=""><meta property="og:title" content="404 Page not found" />
+<meta property="og:description" content="" />
+<meta property="og:type" content="website" />
+<meta property="og:url" content="http://awslabs.github.com/karpenter/docs/404.html" />
+
+<meta itemprop="name" content="404 Page not found">
+<meta itemprop="description" content=""><meta name="twitter:card" content="summary"/>
+<meta name="twitter:title" content="404 Page not found"/>
+<meta name="twitter:description" content=""/>
+
+
+
+
+<link rel="preload" href="/karpenter/docs/scss/main.min.c7864c5e11ce29b0d7fb95d2fbbc92f0cd7d92caacfebfa74a46b09df7d22072.css" as="style">
+<link href="/karpenter/docs/scss/main.min.c7864c5e11ce29b0d7fb95d2fbbc92f0cd7d92caacfebfa74a46b09df7d22072.css" rel="stylesheet" integrity="">
+
+
+<script
+  src="https://code.jquery.com/jquery-3.5.1.min.js"
+  integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0="
+  crossorigin="anonymous"></script>
+
+
+
+
+
+  </head>
+  <body class="td-404">
+    <header>
+
+<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
+        <a class="navbar-brand" href="/karpenter/docs/">
+		<span class="navbar-logo"></span><span class="text-uppercase font-weight-bold">Karpenter</span>
+	</a>
+	<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
+		<ul class="navbar-nav mt-2 mt-lg-0">
+
+
+
+
+		</ul>
+	</div>
+	<div class="navbar-nav d-none d-lg-block">
+</div>
+</nav>
+
+    </header>
+    <div class="container-fluid td-default td-outer">
+      <main role="main" class="td-main">
+
+    <main id="main">
+      <div>
+       <h1 id="title">Not found</h1>
+          <p>Oops! This page doesn't exist. Try going back to our <a href="/karpenter/docs/">home page</a>.</p>
+      </div>
+    </main>
+
+      </main>
+
+<footer class="bg-dark py-5 row d-print-none">
+  <div class="container-fluid mx-sm-5">
+    <div class="row">
+      <div class="col-6 col-sm-4 text-xs-center order-sm-2">
+
+      </div>
+      <div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
+
+      </div>
+      <div class="col-12 col-sm-4 text-center py-2 order-sm-2">
+
+
+
+
+
+      </div>
+    </div>
+  </div>
+</footer>
+
+
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js" integrity="sha384-+YQ4JLhjyBLPDQt//I+STsc9iw4uQqACwlvpslubQzn4u2UU2UFM80nGisd026JF" crossorigin="anonymous"></script>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<script src="/karpenter/docs/js/main.min.492c73c720d423f271eac0a3a1ae34fdf851cafa1da7a788bc330115ad5d51c4.js" integrity="sha256-SSxzxyDUI/Jx6sCjoa40/fhRyvodp6eIvDMBFa1dUcQ=" crossorigin="anonymous"></script>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/categories/index.html b/docs/categories/index.html
@@ -0,0 +1,135 @@
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+<meta name="generator" content="Hugo 0.85.0" /><link rel="alternate" type="application/rss&#43;xml" href="http://awslabs.github.com/karpenter/docs/categories/index.xml">
+<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
+
+
+<link rel="shortcut icon" href="/karpenter/docs/favicons/favicon.ico" >
+<link rel="apple-touch-icon" href="/karpenter/docs/favicons/apple-touch-icon-180x180.png" sizes="180x180">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/favicon-16x16.png" sizes="16x16">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/favicon-32x32.png" sizes="32x32">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-36x36.png" sizes="36x36">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-48x48.png" sizes="48x48">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-72x72.png" sizes="72x72">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-96x96.png" sizes="96x96">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-144x144.png" sizes="144x144">
+<link rel="icon" type="image/png" href="/karpenter/docs/favicons/android-192x192.png" sizes="192x192">
+
+<title>Categories | Karpenter</title>
+<meta name="description" content=""><meta property="og:title" content="Categories" />
+<meta property="og:description" content="" />
+<meta property="og:type" content="website" />
+<meta property="og:url" content="http://awslabs.github.com/karpenter/docs/categories/" />
+
+<meta itemprop="name" content="Categories">
+<meta itemprop="description" content=""><meta name="twitter:card" content="summary"/>
+<meta name="twitter:title" content="Categories"/>
+<meta name="twitter:description" content=""/>
+
+
+
+
+<link rel="preload" href="/karpenter/docs/scss/main.min.c7864c5e11ce29b0d7fb95d2fbbc92f0cd7d92caacfebfa74a46b09df7d22072.css" as="style">
+<link href="/karpenter/docs/scss/main.min.c7864c5e11ce29b0d7fb95d2fbbc92f0cd7d92caacfebfa74a46b09df7d22072.css" rel="stylesheet" integrity="">
+
+
+<script
+  src="https://code.jquery.com/jquery-3.5.1.min.js"
+  integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0="
+  crossorigin="anonymous"></script>
+
+
+
+
+
+  </head>
+  <body class="td-taxonomy">
+    <header>
+
+<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
+        <a class="navbar-brand" href="/karpenter/docs/">
+		<span class="navbar-logo"></span><span class="text-uppercase font-weight-bold">Karpenter</span>
+	</a>
+	<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
+		<ul class="navbar-nav mt-2 mt-lg-0">
+
+
+
+
+		</ul>
+	</div>
+	<div class="navbar-nav d-none d-lg-block">
+</div>
+</nav>
+
+    </header>
+    <div class="container-fluid td-default td-outer">
+      <main role="main" class="td-main">
+
+<div class="td-content">
+  <main class="taxonomy-terms-page">
+    <h1>Categories</h1>
+
+
+
+
+
+
+
+  </main>
+</div>
+
+      </main>
+
+<footer class="bg-dark py-5 row d-print-none">
+  <div class="container-fluid mx-sm-5">
+    <div class="row">
+      <div class="col-6 col-sm-4 text-xs-center order-sm-2">
+
+      </div>
+      <div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
+
+      </div>
+      <div class="col-12 col-sm-4 text-center py-2 order-sm-2">
+
+
+
+
+
+      </div>
+    </div>
+  </div>
+</footer>
+
+
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js" integrity="sha384-+YQ4JLhjyBLPDQt//I+STsc9iw4uQqACwlvpslubQzn4u2UU2UFM80nGisd026JF" crossorigin="anonymous"></script>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<script src="/karpenter/docs/js/main.min.492c73c720d423f271eac0a3a1ae34fdf851cafa1da7a788bc330115ad5d51c4.js" integrity="sha256-SSxzxyDUI/Jx6sCjoa40/fhRyvodp6eIvDMBFa1dUcQ=" crossorigin="anonymous"></script>
+
+
+
+
+  </body>
+</html>