docs: add an introduction to colony + prerequisites section

.docusaurus/docusaurus-plugin-content-docs/default/p/index-466.json

@@ -1 +1 @@
-{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{},"docs":{"index":{"id":"index","title":"Colony Docs","description":"Yep"}}}}
+{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"myAutogeneratedSidebar":[{"type":"link","label":"Colony","href":"/","docId":"index","unlisted":false},{"type":"link","label":"Clusters","href":"/clusters/","docId":"clusters/index","unlisted":false},{"type":"link","label":"Templates","href":"/templates/","docId":"templates/index","unlisted":false}]},"docs":{"clusters/index":{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","sidebar":"myAutogeneratedSidebar"},"index":{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","sidebar":"myAutogeneratedSidebar"},"templates/index":{"id":"templates/index","title":"Templates","description":"One thing you can do with the machines discovered by colony is to use one of our available templates to install a specific operating system easily on one or multiples machines. For now we support Talos Linux, and Ubuntu, but more templates will be added soon. If you have any suggestions, feel free to let us know in the #colony-templates channel in our Slack community.","sidebar":"myAutogeneratedSidebar"}}}}

.docusaurus/docusaurus-plugin-content-docs/default/site-docs-clusters-index-md-6ab.json

@@ -0,0 +1,23 @@
+{
+  "id": "clusters/index",
+  "title": "Clusters",
+  "description": "One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.",
+  "source": "@site/docs/clusters/index.md",
+  "sourceDirName": "clusters",
+  "slug": "/clusters/",
+  "permalink": "/clusters/",
+  "draft": false,
+  "unlisted": false,
+  "tags": [],
+  "version": "current",
+  "frontMatter": {},
+  "sidebar": "myAutogeneratedSidebar",
+  "previous": {
+    "title": "Colony",
+    "permalink": "/"
+  },
+  "next": {
+    "title": "Templates",
+    "permalink": "/templates/"
+  }
+}

.docusaurus/docusaurus-plugin-content-docs/default/site-docs-index-md-c37.json

@@ -1,7 +1,7 @@
 {
   "id": "index",
-  "title": "Colony Docs",
-  "description": "Yep",
+  "title": "Colony",
+  "description": "colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.",
   "source": "@site/docs/index.md",
   "sourceDirName": ".",
   "slug": "/",
@@ -13,5 +13,10 @@
   "sidebarPosition": 1,
   "frontMatter": {
     "sidebar_position": 1
+  },
+  "sidebar": "myAutogeneratedSidebar",
+  "next": {
+    "title": "Clusters",
+    "permalink": "/clusters/"
   }
 }

.docusaurus/docusaurus-plugin-content-docs/default/site-docs-templates-index-md-066.json

@@ -0,0 +1,19 @@
+{
+  "id": "templates/index",
+  "title": "Templates",
+  "description": "One thing you can do with the machines discovered by colony is to use one of our available templates to install a specific operating system easily on one or multiples machines. For now we support Talos Linux, and Ubuntu, but more templates will be added soon. If you have any suggestions, feel free to let us know in the #colony-templates channel in our Slack community.",
+  "source": "@site/docs/templates/index.md",
+  "sourceDirName": "templates",
+  "slug": "/templates/",
+  "permalink": "/templates/",
+  "draft": false,
+  "unlisted": false,
+  "tags": [],
+  "version": "current",
+  "frontMatter": {},
+  "sidebar": "myAutogeneratedSidebar",
+  "previous": {
+    "title": "Clusters",
+    "permalink": "/clusters/"
+  }
+}

.docusaurus/docusaurus-plugin-debug/default/p/docusaurus-debug-content-0d5.json

@@ -1 +1 @@
-{"allContent":{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","path":"/","tagsPath":"/tags","isLast":true,"routePriority":-1,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/sidebars.js","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/docs","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/current","docs":[{"id":"index","title":"Colony Docs","description":"Yep","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1}}],"drafts":[],"sidebars":{}}]}},"docusaurus-plugin-content-pages":{"default":null},"docusaurus-plugin-debug":{},"docusaurus-theme-classic":{},"docusaurus-bootstrap-plugin":{},"docusaurus-mdx-fallback-plugin":{}}}
+{"allContent":{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","path":"/","tagsPath":"/tags","isLast":true,"routePriority":-1,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/sidebars.js","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/docs","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/current","docs":[{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","source":"@site/docs/clusters/index.md","sourceDirName":"clusters","slug":"/clusters/","permalink":"/clusters/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Colony","permalink":"/"},"next":{"title":"Templates","permalink":"/templates/"}},{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"myAutogeneratedSidebar","next":{"title":"Clusters","permalink":"/clusters/"}},{"id":"templates/index","title":"Templates","description":"One thing you can do with the machines discovered by colony is to use one of our available templates to install a specific operating system easily on one or multiples machines. For now we support Talos Linux, and Ubuntu, but more templates will be added soon. If you have any suggestions, feel free to let us know in the #colony-templates channel in our Slack community.","source":"@site/docs/templates/index.md","sourceDirName":"templates","slug":"/templates/","permalink":"/templates/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Clusters","permalink":"/clusters/"}}],"drafts":[],"sidebars":{"myAutogeneratedSidebar":[{"type":"doc","id":"index"},{"type":"doc","label":"Clusters","id":"clusters/index"},{"type":"doc","label":"Templates","id":"templates/index"}]}}]}},"docusaurus-plugin-content-pages":{"default":null},"docusaurus-plugin-debug":{},"docusaurus-theme-classic":{},"docusaurus-bootstrap-plugin":{},"docusaurus-mdx-fallback-plugin":{}}}

.docusaurus/globalData.json

@@ -10,13 +10,31 @@
           "path": "/",
           "mainDocId": "index",
           "docs": [
+            {
+              "id": "clusters/index",
+              "path": "/clusters/",
+              "sidebar": "myAutogeneratedSidebar"
+            },
             {
               "id": "index",
-              "path": "/"
+              "path": "/",
+              "sidebar": "myAutogeneratedSidebar"
+            },
+            {
+              "id": "templates/index",
+              "path": "/templates/",
+              "sidebar": "myAutogeneratedSidebar"
             }
           ],
           "draftIds": [],
-          "sidebars": {}
+          "sidebars": {
+            "myAutogeneratedSidebar": {
+              "link": {
+                "path": "/",
+                "label": "index"
+              }
+            }
+          }
         }
       ],
       "breadcrumbs": true

.docusaurus/routes.js

@@ -39,20 +39,33 @@ export default [
   },
   {
     path: '/',
-    component: ComponentCreator('/', '43d'),
+    component: ComponentCreator('/', '770'),
     routes: [
       {
         path: '/',
-        component: ComponentCreator('/', '4ae'),
+        component: ComponentCreator('/', '0e3'),
         routes: [
           {
             path: '/',
-            component: ComponentCreator('/', '0c9'),
+            component: ComponentCreator('/', '81d'),
             routes: [
+              {
+                path: '/clusters/',
+                component: ComponentCreator('/clusters/', '7d5'),
+                exact: true,
+                sidebar: "myAutogeneratedSidebar"
+              },
+              {
+                path: '/templates/',
+                component: ComponentCreator('/templates/', 'd06'),
+                exact: true,
+                sidebar: "myAutogeneratedSidebar"
+              },
               {
                 path: '/',
-                component: ComponentCreator('/', 'c48'),
-                exact: true
+                component: ComponentCreator('/', '515'),
+                exact: true,
+                sidebar: "myAutogeneratedSidebar"
               }
             ]
           }

.docusaurus/routesChunkNames.json

@@ -42,20 +42,28 @@
       "plugin": "plugin---docusaurus-debugb-38-ad3"
     }
   },
-  "/-43d": {
+  "/-770": {
     "__comp": "__comp---theme-docs-root-5-e-9-0b6",
     "__context": {
       "plugin": "plugin---aba-d70"
     }
   },
-  "/-4ae": {
+  "/-0e3": {
     "__comp": "__comp---theme-doc-version-roota-7-b-5de",
     "__props": "__props---22-d-307"
   },
-  "/-0c9": {
+  "/-81d": {
     "__comp": "__comp---theme-doc-roota-94-67a"
   },
-  "/-c48": {
+  "/clusters/-7d5": {
+    "__comp": "__comp---theme-doc-item-178-a40",
+    "content": "content---clusters-6-ab-10d"
+  },
+  "/templates/-d06": {
+    "__comp": "__comp---theme-doc-item-178-a40",
+    "content": "content---templates-066-98e"
+  },
+  "/-515": {
     "__comp": "__comp---theme-doc-item-178-a40",
     "content": "content---c-37-d02"
   }

docs/clusters/index.md

@@ -0,0 +1,7 @@
+# Clusters
+
+One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the `#colony-clusters` channel in our [Slack community](https://kubefirst.io/slack).
+
+## CivoStack
+
+TBD, waiting to finish the initial docs.

docs/index.md

@@ -2,6 +2,73 @@
 sidebar_position: 1
 ---
 
-# Colony Docs
+# Colony
 
-Yep
+colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.
+
+## Get Started
+
+To be able to run colony, you will need to be physically within your data center with a laptop.
+
+### Prerequisites
+
+To be able to run colony in your data center, you will need to install the colony CLI, have Docker Desktop running on your laptop and retrive your colony API key.
+
+#### colony CLI
+
+The easiest way to install the colony CLI is using [Homebrew](https://brew.sh). Run this command in your terminal of choice:
+
+```shell
+brew install colony
+```
+
+If you need to upgrade the colony CLI, run:
+
+```shell
+brew update
+brew upgrade colony
+```
+
+#### Docker Desktop
+
+To install Docker Desktop on your machine, please follow [their instructions](https://docs.docker.com/get-docker/).
+
+#### colony API key
+
+To create a colony API key,first [sign-up to the colony management portal](https://colony-ui.mgmt-20.kubefirst.com/auth/signup).
+
+![colony sign-up page](img/colony/signup.png)
+
+You have the choice to create an account using the following providers:
+
+- Civo
+- GitHub
+- GitLab
+- Google
+
+Once signed in, open the "API keys" page from the "ADMIN SETTINGS" section of the left sidebar.
+
+![Empty API Keys page](img/colony/api-keys-empty.png)
+
+Click on the "Generate API key": while your new key is being created, the button text will quickly change to "", and once it's done, you will see a new key added in your API keys page.
+
+![API Keys page showing one key](img/colony/api-keys-new.png)
+
+To copy your newly created API key, either use the Copy button, or manually show the API key value, select the text and copy it into your clipboard. This key will be useful to initialize colony.
+
+### Install colony
+
+TBD
+
+### Discover your data center machines (physical or virtual)
+
+![Discovered assets in colony](img/colony/assets-discovered.png)
+
+TBD
+
+## Next steps
+
+Once our machines are available in the colony interface assets page, you have two choices:
+
+1. Use one of [our template to install an operating system](templates/index.md) on one or multiple machines.
+2. [Create one or multiple clusters](/clusters/index.md) on those machines.

docs/templates/index.md

@@ -0,0 +1,11 @@
+# Templates
+
+One thing you can do with the machines discovered by colony is to use one of our available templates to install a specific operating system easily on one or multiples machines. For now we support [Talos Linux](https://www.talos.dev), and [Ubuntu](https://ubuntu.com), but more templates will be added soon. If you have any suggestions, feel free to let us know in the `#colony-templates` channel in our [Slack community](https://kubefirst.io/slack).
+
+## Talos Linux
+
+TBD, waiting for it to work from the UI.
+
+## Ubuntu
+
+TBD, waiting for it to work from the UI.

sidebars.js

@@ -1,20 +1,8 @@
-/**
- * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
- */
-
-// @ts-check
-
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
-  // By default, Docusaurus generates a sidebar from the docs folder structure
-
+export default {
+  myAutogeneratedSidebar: [
+    {
+      type: 'autogenerated',
+      dirName: '.'
+    },
+  ],
 };
-
-export default sidebars;