Docs placeholder for alpha-1

githedgehog · Oct 30, 2023 · ff944a7 · ff944a7
1 parent 2c7319f
commit ff944a7
Show file tree

Hide file tree

Showing 23 changed files with 19 additions and 211 deletions.
diff --git a/docs/.pages b/docs/.pages
@@ -1,12 +1,6 @@
 # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
 nav:
   - index.md
-  - getting-started
-  - concepts
-  - Wiring Diagram: wiring
-  - Install & Upgrade: install-upgrade
-  - User Guide: user-guide
-  - Reference: reference
-  - Troubleshooting: troubleshooting
   - ...
-  - contribute
+  - release-notes
+
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/logo.webp b/docs/assets/logo.webp
diff --git a/docs/concepts/overview.md b/docs/concepts/overview.md
diff --git a/docs/contribute/.pages b/docs/contribute/.pages
diff --git a/docs/contribute/docs.md b/docs/contribute/docs.md
diff --git a/docs/contribute/overview.md b/docs/contribute/overview.md
diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,165 +1,6 @@
 # Introduction
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+Documentation for alpha-1 release is available though the [support portal](https://support.githedgehog.com/)
+Knowledge base articles.
 
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
-
-
-## Examples
-
-https://squidfunk.github.io/mkdocs-material/reference/
-
-The HTML specification is maintained by the W3C.
-
-*[HTML]: Hyper Text Markup Language
-
-W3C abbr coming from includes/abbreviations.md
-
-
-https://squidfunk.github.io/mkdocs-material/reference/admonitions/
-https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
-
-```markdown
-!!! note
-
-    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
-    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
-    massa, nec semper lorem quam in massa.
-```
-
-!!! note
-
-    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
-    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
-    massa, nec semper lorem quam in massa.
-
-```markdown
-!!! info inline end "Lorem ipsum"
-
-    Lorem ipsum dolor sit amet, consectetur
-    adipiscing elit. Nulla et euismod nulla.
-    Curabitur feugiat, tortor non consequat
-    finibus, justo purus auctor massa, nec
-    semper lorem quam in massa.
-```
-
-!!! info end "Lorem ipsum"
-
-    Lorem ipsum dolor sit amet, consectetur
-    adipiscing elit. Nulla et euismod nulla.
-    Curabitur feugiat, tortor non consequat
-    finibus, justo purus auctor massa, nec
-    semper lorem quam in massa.
-
-``` py
-import tensorflow as tf
-```
-
-``` py title="bubble_sort.py" hl_lines="2 3" linenums="1"
-def bubble_sort(items):
-    for i in range(len(items)):
-        for j in range(len(items) - 1 - i):
-            if items[j] > items[j + 1]:
-                items[j], items[j + 1] = items[j + 1], items[j]
-```
-
-``` yaml
-theme:
-  features:
-    - content.code.annotate # (1)
-```
-
-1.  :man_raising_hand: I'm a code annotation! I can contain `code`, __formatted
-    text__, images, ... basically anything that can be written in Markdown.
-
-
-
-=== "C"
-
-    ``` c
-    #include <stdio.h>
-
-    int main(void) {
-      printf("Hello world!\n");
-      return 0;
-    }
-    ```
-
-=== "C++"
-
-    ``` c++
-    #include <iostream>
-
-    int main(void) {
-      std::cout << "Hello world!" << std::endl;
-      return 0;
-    }
-    ```
-
-
-| Method      | Description                          |
-| :---------- | :----------------------------------- |
-| `GET`       | :material-check:     Fetch resource  |
-| `PUT`       | :material-check-all: Update resource |
-| `DELETE`    | :material-close:     Delete resource |
-
-
-``` mermaid
-graph LR
-  A[Start] --> B{Error?};
-  B -->|Yes| C[Hmm...];
-  C --> D[Debug];
-  D --> B;
-  B ---->|No| E[Yay!];
-```
-
-``` mermaid
-sequenceDiagram
-  autonumber
-  Alice->>John: Hello John, how are you?
-  loop Healthcheck
-      John->>John: Fight against hypochondria
-  end
-  Note right of John: Rational thoughts!
-  John-->>Alice: Great!
-  John->>Bob: How about you?
-  Bob-->>John: Jolly good!
-```
-
-Text can be {--deleted--} and replacement text {++added++}. This can also be
-combined into {~~one~>a single~~} operation. {==Highlighting==} is also
-possible {>>and comments can be added inline<<}.
-
-{==
-
-Formatting can also be applied to blocks by putting the opening and closing
-tags on separate lines and adding new lines between the tags and the content.
-
-==}
-
-++ctrl+alt+del++
-
-
-``` markdown
-:fontawesome-regular-face-laugh-wink:
-:fontawesome-brands-twitter:{ .twitter }
-```
-
-:fontawesome-regular-face-laugh-wink:
-:fontawesome-brands-twitter:{ .twitter }
-
-https://github.com/mkdocstrings/autorefs
-
-(test url)[https://test.githedgehog.com]
+Release notes are available [here](release-notes/index.md).
diff --git a/docs/install-upgrade/overview.md b/docs/install-upgrade/overview.md
diff --git a/docs/install-upgrade/requirements.md b/docs/install-upgrade/requirements.md
diff --git a/docs/install-upgrade/supported-devices.md b/docs/install-upgrade/supported-devices.md
diff --git a/docs/reference/api.md b/docs/reference/api.md
diff --git a/docs/reference/cli.md b/docs/reference/cli.md
diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md
@@ -0,0 +1,14 @@
+# Release notes
+
+## Alpha-1
+
+Fabric topology: collapsed-core
+
+Software versions:
+
+* Fabricator: v0.5.2
+* Fabric: v0.18.6
+* Das-boot: v0.8.2
+* K3s: v1.27.4-k3s1
+* Zot: v1.4.3
+* SONiC: Broadcom Enterprise Base 4.1.1
diff --git a/docs/troubleshooting/overview.md b/docs/troubleshooting/overview.md
diff --git a/docs/user-guide/.pages b/docs/user-guide/.pages
diff --git a/docs/user-guide/harvester.md b/docs/user-guide/harvester.md
diff --git a/docs/user-guide/overview.md b/docs/user-guide/overview.md
diff --git a/docs/user-guide/vpc.md b/docs/user-guide/vpc.md
diff --git a/docs/wiring/.pages b/docs/wiring/.pages
diff --git a/docs/wiring/clos.md b/docs/wiring/clos.md
diff --git a/docs/wiring/overview.md b/docs/wiring/overview.md