patch(#92) Add README regarding general cluster folder structure.

README.md

@@ -22,16 +22,12 @@ _... managed with Flux and Renovate_ :robot:
 <div align="center">
 
 [![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/bloopnet.xyz?publish&style=for-the-badge)](https://observatory.mozilla.org/)
-
-[![GitHub last commit](https://img.shields.io/github/last-commit/h3mmy/bloopySphere?style=for-the-badge)]()
-
-[![GitHub branch checks state](https://img.shields.io/github/checks-status/h3mmy/bloopySphere/main?style=flat-square)]()
-
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/h3mmy/bloopySphere/Deploy%20Keycloak%20Theme%20to%20GHCR?label=Keycloak%20Theme&style=for-the-badge)]()
-
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/h3mmy/bloopysphere/Lint?label=Lint&style=for-the-badge)]()
-
 [![Uptime](https://img.shields.io/uptimerobot/ratio/m790142441-faed6f7043db9c588f5e949f?style=for-the-badge)]()
+[![GitHub last commit](https://img.shields.io/github/last-commit/h3mmy/bloopySphere?style=for-the-badge)](https://github.com/h3mmy/bloopySphere/commits/main)
+
+[![GitHub branch checks state](https://img.shields.io/github/checks-status/h3mmy/bloopySphere/main?style=flat-square)](https://github.com/h3mmy/bloopySphere/actions?query=branch%3Amain)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/h3mmy/bloopySphere/Deploy%20Keycloak%20Theme%20to%20GHCR?label=Keycloak%20Theme&style=for-the-badge)](https://github.com/h3mmy/bloopySphere/actions/workflows/deploy-keycloak-theme.yaml)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/h3mmy/bloopysphere/Lint?label=Lint&style=for-the-badge)](https://github.com/h3mmy/bloopySphere/actions/workflows/lint.yaml)
 
 </div>
 

cluster/README.md

@@ -0,0 +1,24 @@
+This is a basic layout for my cluster files
+
+.
+└── cluster/
+    ├── apps/
+    |   └── ...
+    ├── base/
+    |   ├── flux-system/
+    |   |   ├── charts/
+    |   |   ├── git-repos/
+    |   |   └── ...
+    |   └── ...
+    ├── core/
+    |   ├── namespaces/
+    |   └── ...
+    └── crds/
+        └── ...
+
+The apps/ dir contains all the apps in the cluster. I have them striated by namespace.
+The base/ dir contains the flux-system and kustomize 'roots' so to speak. This is what 'drives' the gitops of the cluster.
+The core/ dir contains all resources that are prerequisites to namespaces and workloads.
+The crds/ dir contains ...well CRDS for various things that need to be indepently defined but don't exactly belong in the other categories. Some people just add this as part of core/ which is also valid.
+
+Note: Each subfolder has it's own root kustomization.yaml which aren't strictly necessary as you can configure kustomize to work without them. I like having them because it makes it super easy to enable/disable entire subfolders on the fly.