docs: rename docs/reference to docs/topics (#1182)

* docs: rename docs/reference to docs/topics
Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

docs/.vuepress/config.js

@@ -107,8 +107,8 @@ module.exports = {
             "identity-providers/",
             "identity-providers/azure",
             "identity-providers/cognito",
-            "identity-providers/gitlab",
             "identity-providers/github",
+            "identity-providers/gitlab",
             "identity-providers/google",
             "identity-providers/okta",
             "identity-providers/one-login",
@@ -128,19 +128,19 @@ module.exports = {
           ],
         },
         {
-          title: "Reference",
+          title: "Topics",
           collapsable: true,
-          path: "/docs/reference/",
+          path: "/docs/topics/",
           type: "group",
           collapsable: false,
           sidebarDepth: 1,
           children: [
-            "reference/certificates",
-            "reference/data-storage",
-            "reference/impersonation",
-            "reference/programmatic-access",
-            "reference/getting-users-identity",
-            "reference/production-deployment",
+            "topics/certificates",
+            "topics/data-storage",
+            "topics/getting-users-identity",
+            "topics/impersonation",
+            "topics/production-deployment",
+            "topics/programmatic-access",
           ],
         },
       ],
@@ -158,6 +158,7 @@ module.exports = {
             "cloud-run",
             "istio",
             "kubernetes",
+            "kubernetes-dashboard",
             "local-oidc",
             "mtls",
             "tiddlywiki",

docs/.vuepress/public/_redirects

@@ -14,8 +14,6 @@
 /community/security					/docs/community/security.html		
 /community/security.html			/docs/community/security.html		
 
-/docs/reference/examples.html		/configuration/examples.html
-
 /guide/					/docs/quick-start/
 /guide/kubernetes.html	/docs/quick-start/kubernetes.html
 /guide/kubernetes		/docs/quick-start/kubernetes.html
@@ -32,4 +30,16 @@
 /recipes/kubernetes.html		/guides/kubernetes.html
 /recipes/local-oidc.html		/guides/local-oidc.html
 /recipes/mtls.html				/guides/mtls.html
-/recipes/vs-code-server.html	/guides/vs-code-server.html
+/recipes/vs-code-server.html	/guides/vs-code-server.html
+
+
+/docs/reference/								/docs/topics/
+/docs/reference/readme.html						/docs/topics/readme.html	
+/docs/reference/certificates.html				/docs/topics/certificates.html
+/docs/reference/data-storage.html				/docs/topics/data-storage.html
+/docs/reference/getting-users-identity.html		/docs/topics/getting-users-identity.html
+/docs/reference/impersonation.html				/docs/topics/impersonation.html
+/docs/reference/production-deployment.html		/docs/topics/production-deployment.html	
+/docs/reference/programmatic-access.html		/docs/topics/programmatic-access.html
+
+/docs/reference/examples.html				/configuration/examples.html

docs/docs/topics/certificates.md

@@ -64,7 +64,7 @@ mkcert "*.localhost.pomerium.io"
 
 Once you've setup your wildcard domain, we can use acme.sh to create a certificate-signing request with LetsEncrypt.
 
-<<< @/docs/docs/reference/sh/generate_wildcard_cert.sh
+<<< @/examples/sh/generate_wildcard_cert.sh
 
 LetsEncrypt will respond with the corresponding `TXT` record needed to verify our domain.
 

docs/guides/kubernetes-dashboard.md

@@ -350,7 +350,7 @@ Whichever option you choose to go with, 🎉🍾🎊 **congratulations** 🎉
 [creating sample users]: https://github.com/kubernetes/dashboard/blob/master/docs/user/access-control/creating-sample-user.md
 [dashboard ui]: https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/#deploying-the-dashboard-ui
 [dns01 challenge provider]: https://docs.cert-manager.io/en/latest/tasks/issuers/setup-acme/dns01/index.html
-[forward-auth]: ../docs/reference/reference.html#forward-auth
+[forward-auth]: ../docs/topics/reference.html#forward-auth
 [helm install]: https://helm.sh/docs/using_helm/#installing-the-helm-client
 [helm]: https://helm.sh
 [homebrew]: https://brew.sh
@@ -362,5 +362,5 @@ Whichever option you choose to go with, 🎉🍾🎊 **congratulations** 🎉
 [nginx]: https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-subrequest-authentication/
 [securing your helm installation]: https://helm.sh/docs/using_helm/#securing-your-helm-installation
 [snap]: https://github.com/snapcrafters/helm
-[with pomerium]: ../docs/reference/reference.html#forward-auth
+[with pomerium]: ../docs/topics/reference.html#forward-auth
 [your dashboard]: http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/#/login

docs/guides/kubernetes.md

@@ -1,5 +1,5 @@
 ---
-title: Kubernetes
+title: Kubernetes API / Kubectl
 lang: en-US
 meta:
   - name: keywords
@@ -35,7 +35,7 @@ kind create cluster --config=./kind-config.yaml
 
 ### Pomerium Service Account
 
-Pomerium uses a single service account and user impersonatation headers to authenticate and authorize users in Kubernetes. To create the Pomerium service account use the following config: (`pomerium-k8s.yaml`)
+Pomerium uses a single service account and user impersonation headers to authenticate and authorize users in Kubernetes. To create the Pomerium service account use the following config: (`pomerium-k8s.yaml`)
 
 ```yaml
 # pomerium-k8s.yaml
@@ -265,3 +265,6 @@ kubectl --context=via-pomerium cluster-info
 ```
 
 You should be prompted to login and see the resulting cluster info.
+
+
+[kubernetes]: https://kubernetes.io

docs/guides/local-oidc.md

@@ -1,5 +1,5 @@
 ---
-title: local oidc
+title: Local OIDC Provider
 lang: en-US
 meta:
   - name: keywords

docs/guides/readme.md

@@ -3,10 +3,11 @@
 This section contains applications, and scenario specific guides for Pomerium.
 
 - The [ad-guard](./ad-guard.md) recipe demonstrates how pomerium can be used to augment web applications that only support simplistic authorization mechanisms like basic-auth with single-sign-on driven access policy.
-- The [Cloud Run](./cloud-run.md) recipe demonstrates deploying pomerium to Google Cloud Run as well as using it to Authorize users to protected Cloud Run endpoints.
-- The [kubernetes](./kubernetes.md) guide covers how to add authentication and authorization to kubernetes dashboard using helm, and letsencrypt certificates. This guide also shows how third party reverse-proxies like nginx/traefik can be used in conjunction with pomerium using forward-auth.
-- The [visual studio code](./vs-code-server.md) guide demonstrates how pomerium can be used to add access control to third-party applications that don't ship with [fine-grained access control](https://github.com/cdr/code-server/issues/905).
 - The [argo](./argo.md) guide demonstrates how pomerium can be used to add access control to [Argo](https://argoproj.github.io/projects/argo).
-- The [mTLS](./mtls.md) guide demonstrates how pomerium can be used to add mutual authentication using client certificates and a custom certificate authority.
+- The [Cloud Run](./cloud-run.md) recipe demonstrates deploying pomerium to Google Cloud Run as well as using it to Authorize users to protected Cloud Run endpoints.
+- The [Kubernetes Dashboard](./kubernetes-dashboard.md) guide covers how to secure Kubernetes dashboard using Pomerium. 
+- The [kubernetes](./kubernetes.md) guide covers how to add authentication and authorization to kubernetes dashboard using helm, and letsencrypt certificates. This guide also shows how third party reverse-proxies like nginx/traefik can be used in conjunction with pomerium using forward-auth.
 - The [local OIDC](./local-oidc.md) guide demonstrates how pomerium can be used with local OIDC server for dev/testing.
+- The [mTLS](./mtls.md) guide demonstrates how pomerium can be used to add mutual authentication using client certificates and a custom certificate authority.
 - The [TiddlyWiki](./tiddlywiki.md) guide demonstrates how pomerium can be used to add authentication and authorization to web application using authenticated header.
+- The [visual studio code](./vs-code-server.md) guide demonstrates how pomerium can be used to add access control to third-party applications that don't ship with [fine-grained access control](https://github.com/cdr/code-server/issues/905).

docs/reference/readme.md

@@ -1122,7 +1122,7 @@ Note: This setting will replace (not append) the system's trust store for a give
 - Type: [base64 encoded] `string` or relative file location
 - Optional
 
-Pomerium supports client certificates which can be used to enforce [mutually authenticated and encrypted TLS connections](https://en.wikipedia.org/wiki/Mutual_authentication) (mTLS). For more details, see our [mTLS example repository](https://github.com/pomerium/examples/tree/master/mutual-tls) and the [certificate docs](../docs/reference/certificates.md).
+Pomerium supports client certificates which can be used to enforce [mutually authenticated and encrypted TLS connections](https://en.wikipedia.org/wiki/Mutual_authentication) (mTLS). For more details, see our [mTLS example repository](https://github.com/pomerium/examples/tree/master/mutual-tls) and the [certificate docs](../docs/topics/certificates.md).
 
 ### Websocket Connections