diff --git a/docs/.pages b/docs/.pages index c4fe0b7..5d7b17a 100644 --- 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 + \ No newline at end of file diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico deleted file mode 100644 index e7c4865..0000000 Binary files a/docs/assets/favicon.ico and /dev/null differ diff --git a/docs/assets/logo.webp b/docs/assets/logo.webp deleted file mode 100644 index f1ec1c7..0000000 Binary files a/docs/assets/logo.webp and /dev/null differ diff --git a/docs/concepts/overview.md b/docs/concepts/overview.md deleted file mode 100644 index 639d880..0000000 --- a/docs/concepts/overview.md +++ /dev/null @@ -1 +0,0 @@ -# Concepts \ No newline at end of file diff --git a/docs/contribute/.pages b/docs/contribute/.pages deleted file mode 100644 index ca4c62d..0000000 --- a/docs/contribute/.pages +++ /dev/null @@ -1,4 +0,0 @@ -nav: - - overview.md - - docs.md - - ... diff --git a/docs/contribute/docs.md b/docs/contribute/docs.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/contribute/overview.md b/docs/contribute/overview.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md deleted file mode 100644 index 8b3a794..0000000 --- a/docs/getting-started/overview.md +++ /dev/null @@ -1 +0,0 @@ -# Getting Started \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 04cefbc..b4ef3e2 100644 --- 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 - - int main(void) { - printf("Hello world!\n"); - return 0; - } - ``` - -=== "C++" - - ``` c++ - #include - - 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] \ No newline at end of file +Release notes are available [here](release-notes/index.md). \ No newline at end of file diff --git a/docs/install-upgrade/overview.md b/docs/install-upgrade/overview.md deleted file mode 100644 index 4bba659..0000000 --- a/docs/install-upgrade/overview.md +++ /dev/null @@ -1 +0,0 @@ -# Overview \ No newline at end of file diff --git a/docs/install-upgrade/requirements.md b/docs/install-upgrade/requirements.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/install-upgrade/supported-devices.md b/docs/install-upgrade/supported-devices.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/reference/api.md b/docs/reference/api.md deleted file mode 100644 index b2fad2e..0000000 --- a/docs/reference/api.md +++ /dev/null @@ -1 +0,0 @@ -# API Reference \ No newline at end of file diff --git a/docs/reference/cli.md b/docs/reference/cli.md deleted file mode 100644 index 8341cf3..0000000 --- a/docs/reference/cli.md +++ /dev/null @@ -1 +0,0 @@ -# CLI reference \ No newline at end of file diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md new file mode 100644 index 0000000..bd140b4 --- /dev/null +++ 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 deleted file mode 100644 index 64a80c8..0000000 --- a/docs/troubleshooting/overview.md +++ /dev/null @@ -1 +0,0 @@ -# Troubleshooting \ No newline at end of file diff --git a/docs/user-guide/.pages b/docs/user-guide/.pages deleted file mode 100644 index 6cf14ec..0000000 --- a/docs/user-guide/.pages +++ /dev/null @@ -1,5 +0,0 @@ -nav: - - overview.md - - vpc.md - - harvester.md - - ... diff --git a/docs/user-guide/harvester.md b/docs/user-guide/harvester.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/user-guide/overview.md b/docs/user-guide/overview.md deleted file mode 100644 index 4bba659..0000000 --- a/docs/user-guide/overview.md +++ /dev/null @@ -1 +0,0 @@ -# Overview \ No newline at end of file diff --git a/docs/user-guide/vpc.md b/docs/user-guide/vpc.md deleted file mode 100644 index 3eca96f..0000000 --- a/docs/user-guide/vpc.md +++ /dev/null @@ -1 +0,0 @@ -# VPCs \ No newline at end of file diff --git a/docs/wiring/.pages b/docs/wiring/.pages deleted file mode 100644 index ed3e32d..0000000 --- a/docs/wiring/.pages +++ /dev/null @@ -1,4 +0,0 @@ -nav: - - overview.md - - clos.md - - ... diff --git a/docs/wiring/clos.md b/docs/wiring/clos.md deleted file mode 100644 index fc14d2d..0000000 --- a/docs/wiring/clos.md +++ /dev/null @@ -1,19 +0,0 @@ -# Clos - -Placeholder: - -```mermaid -flowchart TD - spine1 --- leaf1 - spine2 --- leaf1 - spine1 --- leaf2 - spine2 --- leaf2 - spine1 --- leaf3 - spine2 --- leaf3 - spine1 --- leaf4 - spine2 --- leaf4 - leaf1 --- edge1 - leaf2 --- edge1 - leaf3 --- edge2 - leaf4 --- edge2 -``` \ No newline at end of file diff --git a/docs/wiring/overview.md b/docs/wiring/overview.md deleted file mode 100644 index 3038553..0000000 --- a/docs/wiring/overview.md +++ /dev/null @@ -1 +0,0 @@ -# Wiring Diagram \ No newline at end of file