Cleanup

nais · Feb 7, 2024 · a34fe7e · a34fe7e
1 parent 0ac5691
commit a34fe7e
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 116 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,10 @@
+.PHONY: all install local
+SHELL := bash
+
+all: install local
+
+install:
+	poetry install
+
+local:
+	poetry run mkdocs serve --dev-addr localhost:8001
diff --git a/docs/administrative/fixtures.md b/docs/administrative/fixtures.md
@@ -20,9 +20,3 @@ Any and all meetings that are deemed unnecessary due to priority or lack of subs
 ## Weekly 
 
 The NAIS weekly takes place Monday at high noon.
-
-## Retro
-
-Retros are held on "a need to relieve pressure" basis. You will get an invite if one is scheduled. If you feel that one is needed or have topics you want to address let our esteemed product owner know. 
-
-## Anchor-forum # TBD
diff --git a/docs/social/the-great-outdoors.md b/docs/social/the-great-outdoors.md
@@ -1,9 +1,9 @@
-# Social
+# The Great Outdoors
 
 ### _"All work and no play makes NAIS a dull platform"_
 
 ### Native NAISians
 ![](/assets/naisians.png)
 
 ### The NAIS Pole
-![](/assets/the-nais-pole.png)
+![](/assets/the-nais-pole.png)
diff --git a/docs/technical/development.md b/docs/technical/development.md
diff --git a/docs/technical/installing-nais.md b/docs/technical/installing-nais.md
diff --git a/docs/technical/overview.md b/docs/technical/overview.md
@@ -0,0 +1,20 @@
+# NAIS Overview
+
+This document is a high-level overview of the NAIS platform
+
+## Namespaces
+
+Over the years we have a number of namespaces that we use for different purposes. The ones to know about are:
+
+| Name | Description |
+| ---- | ----------- |
+| `nais-system` | Where we deliver NAIS functionality |
+| `nais` | Team namespace for NAIS. Custom functionality for NAV |
+| `nais-verification` | Test applications for verifying NAIS with alerts |
+| `kyverno` | Only [Kyverno](https://kyverno.io/) is allowed in here |
+| `cnrm-system` | Where [Cloud Native Resource Manager](https://cloud.google.com/config-connector/docs/overview) runs. Managed by Google |
+
+## Tenants
+## Clusters
+## Management
+
diff --git a/docs/technical/production-ready.md b/docs/technical/production-ready.md
@@ -1,4 +1,5 @@
 # What is production ready?
+
 This is the NAIS team's attempt to define what _production ready_ means to us.
 Production implies quality and durability. Running a system means serving
 requests, and requests are ultimately serving users. We care about our users,

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -14,6 +14,7 @@ theme:
     - content.code.annotate
     - navigation.instant
 extra:
+  generator: false
   search:
     language: 'en'
 extra_javascript:
@@ -46,21 +47,3 @@ markdown_extensions:
       emoji_index: !!python/name:materialx.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg
   - tables
-nav:
-  - Welcome to NAIS: README.md
-  - NAIS Onboarding:
-    - Sponsor: welcome/nais-sponsor.md
-    - Manifest: welcome/nais-manifest-eng.md
-    - Checklist for sponsors: welcome/sponsor.md
-  - Administrative:
-    - Fixtures: administrative/fixtures.md
-    - Slack: administrative/slack.md
-  - Technical:
-    - What is nais?: technical/nais.md
-    - NAIS development: technical/development.md
-    - Production ready?: technical/production-ready.md
-    - Publications & Media: technical/publications-media.md
-    - Installing nais: technical/installing-nais.md
-    - Write the doc: technical/write-the-doc/write-the-doc.md
-  - Social:
-      - The Great Outdoors: social/the-great-outdoors.md