docs: started documentation structure (#40)

* docs: started documentation structure

Signed-off-by: Kostis Kapelonis <[email protected]>

* docs: documentation site skeleton

Signed-off-by: Kostis Kapelonis <[email protected]>

---------

Signed-off-by: Kostis Kapelonis <[email protected]>

.readthedocs.yaml

@@ -0,0 +1,11 @@
+version: 2
+formats: all
+mkdocs:
+  fail_on_warning: false
+python:
+  install:
+    - requirements: docs/requirements.txt
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.7"

Makefile

@@ -20,3 +20,13 @@ local-build:
 .PHONY: lint
 lint:
 	golangci-lint run --fix
+
+
+
+
+# convenience target to run `mkdocs serve` using a docker container
+.PHONY: serve-docs
+serve-docs:  ## serve docs locally
+	docker run --rm -it -p 8000:8000 -v ${CURRENT_DIR}:/docs squidfunk/mkdocs-material serve -a 0.0.0.0:8000
+
+

docs/CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# Contributing
+
+## Before You Start
+The Gateway Plugin for Argo Rollouts is written in Golang. If you do not have a good grounding in Go, try out [the tutorial](https://tour.golang.org/).
+
+## Pre-requisites
+
+Install:
+
+* [docker](https://docs.docker.com/install/#supported-platforms)
+* [golang](https://golang.org/)
+* [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
+* [kustomize](https://github.com/kubernetes-sigs/kustomize/releases) >= 4.5.5
+* [k3d](https://k3d.io/) recommended
+
+
+Checkout the code:
+
+```bash
+git clone https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi.git
+cd rollouts-plugin-trafficrouter-gatewayapi
+```
+
+## Building
+
+`go.mod` is used, so the `go build/test` commands automatically install the needed dependencies
+
+The `make` command will build the plugin.
+
+
+
+
+<!-- ## Running the plugin Locally
+
+It is much easier to run and debug if you run Argo Rollout in your local machine than in the Kubernetes cluster.
+
+```bash
+cd ~/go/src/github.com/argoproj/argo-rollouts
+go run ./cmd/rollouts-controller/main.go
+```
+
+When running locally it will connect to whatever kubernetes cluster you have configured in your kubeconfig. You will need to make sure to install the Argo Rollout CRDs into your local cluster, and have the `argo-rollouts` namespace. -->
+
+## Running Unit Tests
+
+<!-- To run unit tests:
+
+```bash
+make test
+``` -->
+
+## Running E2E tests
+
+<!-- The end-to-end tests need to run against a kubernetes cluster with the Argo Rollouts controller
+running. The rollout controller can be started with the command:
+
+```
+make start-e2e
+```
+
+Start and prepare your cluster for e2e tests:
+
+```
+k3d cluster create
+kubectl create ns argo-rollouts
+kubectl apply -k manifests/crds
+kubectl apply -f test/e2e/crds
+```
+
+Then run the e2e tests:
+
+```
+make test-e2e
+```
+
+To run a subset of e2e tests, you need to specify the suite with `-run`, and the specific test regex with `-testify.m`.
+
+```
+E2E_TEST_OPTIONS="-run 'TestCanarySuite' -testify.m 'TestCanaryScaleDownOnAbortNoTrafficRouting'" make test-e2e 
+``` -->
+
+
+## Documentation Changes
+
+Install Docker locally.
+Modify contents in `docs/` directory.
+
+Preview changes in your browser by visiting http://localhost:8000 after running:
+
+```shell
+make serve-docs
+```
+
+<!-- To publish changes, run:
+
+```shell
+make release-docs
+``` -->

docs/assets/versions.css

@@ -0,0 +1,175 @@
+.md-header__title {
+  display: flex;
+}
+
+.dropdown-caret {
+  display: inline-block !important;
+  position: absolute;
+  right: 4px;
+}
+
+.fa .fa-caret-down {
+  display: none !important;
+}
+
+.rst-other-versions {
+  text-align: right;
+}
+
+.rst-other-versions > dl, .rst-other-versions dt, .rst-other-versions small {
+  display: none;
+}
+
+.rst-other-versions > dl:first-child {
+  display: flex !important;
+  flex-direction: column;
+  line-height: 0px !important;
+}
+
+.rst-versions.shift-up .rst-other-versions {
+  display: flex !important;
+}
+
+.rst-versions .rst-other-versions {
+  display: none;
+}
+
+/* Version Warning */
+div[data-md-component=announce] {
+  background-color: rgb(248, 243, 236);
+  position: sticky;
+  top: 0;
+  z-index: 2;
+}
+div[data-md-component=announce]>div#announce-msg{
+  color: var(--md-code-hl-number-color);
+  font-size: .8rem;
+  text-align: center;
+  margin: 15px;
+}
+div[data-md-component=announce]>div#announce-msg>a{
+  color: var(--md-typeset-a-color);
+  text-decoration: underline;
+}
+
+/* from https://assets.readthedocs.org/static/css/badge_only.css,
+most styles have to be overriden here */
+.rst-versions{
+  position: relative !important;
+  bottom: 0;
+  left: 0;
+  width: 100px !important;
+  background: hsla(173, 100%, 24%, 1) !important;
+  font-family: inherit !important;
+  z-index: 0 !important;
+}
+.rst-versions a{
+  color:#2980B9;
+  text-decoration:none
+}
+.rst-versions .rst-badge-small{
+  display:none
+}
+.rst-versions .rst-current-version{
+  padding:12px;
+  background: hsla(173, 100%, 24%, 1) !important;
+  display:block;
+  text-align:right;
+  font-size:90%;
+  cursor:pointer;
+  color: white !important;
+  *zoom:1
+}
+.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{
+  display:table;content:""
+}
+.rst-versions .rst-current-version:after{
+  clear:both
+}
+.rst-versions .rst-current-version .fa{
+  color:#fcfcfc
+}
+.rst-versions .rst-current-version .fa-caret-down{
+  display: none;
+}
+.rst-versions.shift-up .rst-other-versions{
+  display:block
+}
+.rst-versions .rst-other-versions{
+  font-size:90%;
+  padding:12px;
+  color:gray;
+  display:none
+}
+.rst-versions .rst-other-versions hr{
+  display: none !important;
+  height: 0px !important;
+  border: 0px;
+  margin: 0px !important;
+  padding: 0px;
+  border-top: none !important;
+}
+.rst-versions .rst-other-versions dd{
+  display:inline-block;
+  margin:0
+}
+.rst-versions .rst-other-versions dd a{
+  display:inline-block;
+  padding: 1em 0em !important;
+  color:#fcfcfc;
+  font-size: .6rem !important;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+  overflow: hidden;
+  width: 80px;
+}
+.rst-versions .rst-other-versions dd a:hover{
+  font-size: .7rem !important;
+  font-weight: bold;
+}
+.rst-versions.rst-badge{
+  display: block !important;
+  width: 100px !important;
+  bottom: 0px !important;
+  right: 0px !important;
+  left:auto;
+  border:none;
+  text-align: center !important;
+  line-height: 0;
+}
+.rst-versions.rst-badge .icon-book{
+  display: none;
+}
+.rst-versions.rst-badge .fa-book{
+  display: none !important;
+}
+.rst-versions.rst-badge.shift-up .rst-current-version{
+  text-align: left !important;
+}
+.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{
+  display: none !important;
+}
+.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{
+  display: none !important;
+}
+.rst-versions.rst-badge .rst-current-version{
+  width: 70px !important;
+  height: 2.4rem !important;
+  line-height:2.4rem !important;
+  padding: 0px 5px !important;
+  display: inline-block !important;
+  font-size: .6rem !important;
+  overflow: hidden !important;
+  text-overflow: ellipsis !important;
+  white-space: nowrap !important;
+  text-align: left !important;
+}
+@media screen and (max-width: 768px){
+  .rst-versions{
+      width:85%;
+      display:none
+  }
+  .rst-versions.shift{
+      display:block
+  }
+}

docs/assets/versions.js

@@ -0,0 +1,25 @@
+setTimeout(function() {
+  const callbackName = 'callback_' + new Date().getTime();
+  window[callbackName] = function (response) {
+  const div = document.createElement('div');
+  div.innerHTML = response.html;
+  document.querySelector(".md-header__inner > .md-header__title").appendChild(div);
+  const container = div.querySelector('.rst-versions');
+  var caret = document.createElement('div');
+  caret.innerHTML = "<i class='fa fa-caret-down dropdown-caret'></i>"
+  caret.classList.add('dropdown-caret')
+  div.querySelector('.rst-current-version').appendChild(caret);
+  }
+
+  var CSSLink = document.createElement('link');
+  CSSLink.rel='stylesheet';
+  CSSLink.href = '/assets/versions.css';
+  document.getElementsByTagName('head')[0].appendChild(CSSLink);
+
+  var script = document.createElement('script');
+  script.src = 'https://argo-rollouts.readthedocs.io/_/api/v2/footer_html/?'+
+      'callback=' + callbackName + '&project=argo-rollouts&page=&theme=mkdocs&format=jsonp&docroot=docs&source_suffix=.md&version=' + (window['READTHEDOCS_DATA'] || { version: 'latest' }).version;
+  document.getElementsByTagName('head')[0].appendChild(script);
+}, 0);
+
+

docs/features/advanced-deployments.md

@@ -0,0 +1,3 @@
+# Advanced Deployment methods
+
+To be written

docs/features/header-based-routing.md

@@ -0,0 +1,3 @@
+# Header Based routing
+
+To be written

docs/features/multiple-routes.md

@@ -0,0 +1,3 @@
+# Using Multiple Routes
+
+To be written

docs/features/tcp.md

@@ -0,0 +1,3 @@
+# Using TCP
+
+To be written

docs/index.md

@@ -0,0 +1,3 @@
+# Progressive Delivery with the Kubernetes Gateway API
+
+To be written

docs/provider-status.md

@@ -0,0 +1,3 @@
+# Provider Status
+
+To be Written

docs/requirements.txt

@@ -0,0 +1,6 @@
+mkdocs==1.4.2
+mkdocs-material==8.5.11
+markdown_include==0.8.0
+pygments==2.13.0
+jinja2==3.1.2
+markdown==3.3.7