Prepare everything

Signed-off-by: Christian Berendt <[email protected]>
osism · Sep 10, 2023 · c6d2c09 · c6d2c09
1 parent 9384c3b
commit c6d2c09
Show file tree

Hide file tree

Showing 56 changed files with 21,562 additions and 0 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,33 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./build
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+.docusaurus
diff --git a/README.md b/README.md
@@ -1 +1,41 @@
 # osism.github.io
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
@@ -0,0 +1,12 @@
+---
+slug: first-blog-post
+title: First Blog Post
+authors:
+  name: Gao Wei
+  title: Docusaurus Core Team
+  url: https://github.com/wgao19
+  image_url: https://github.com/wgao19.png
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
@@ -0,0 +1,44 @@
+---
+slug: long-blog-post
+title: Long Blog Post
+authors: endi
+tags: [hello, docusaurus]
+---
+
+This is the summary of a very long blog post,
+
+Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
+
+<!--truncate-->
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
@@ -0,0 +1,20 @@
+---
+slug: mdx-blog-post
+title: MDX Blog Post
+authors: [slorber]
+tags: [docusaurus]
+---
+
+Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
+
+:::tip
+
+Use the power of React to create interactive blog posts.
+
+```js
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+```
+
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+
+:::
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
@@ -0,0 +1,25 @@
+---
+slug: welcome
+title: Welcome
+authors: [slorber, yangshun]
+tags: [facebook, hello, docusaurus]
+---
+
+[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
+
+Simply add Markdown files (or folders) to the `blog` directory.
+
+Regular blog authors can be added to `authors.yml`.
+
+The blog post date can be extracted from filenames, such as:
+
+- `2019-05-30-welcome.md`
+- `2019-05-30-welcome/index.md`
+
+A blog post folder can be convenient to co-locate blog post images:
+
+![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
+
+The blog supports tags as well!
+
+**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
diff --git a/blog/authors.yml b/blog/authors.yml
@@ -0,0 +1,17 @@
+endi:
+  name: Endilie Yacop Sucipto
+  title: Maintainer of Docusaurus
+  url: https://github.com/endiliey
+  image_url: https://github.com/endiliey.png
+
+yangshun:
+  name: Yangshun Tay
+  title: Front End Engineer @ Facebook
+  url: https://github.com/yangshun
+  image_url: https://github.com/yangshun.png
+
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer
+  url: https://sebastienlorber.com
+  image_url: https://github.com/slorber.png
diff --git a/docs/advanced-guides/contributor-guide.md b/docs/advanced-guides/contributor-guide.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Contributor Guide
+sidebar_position: 80
+---
+
+# Contributor Guide
diff --git a/docs/advanced-guides/developer-guide.md b/docs/advanced-guides/developer-guide.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Developer Guide
+sidebar_position: 90
+---
+
+# Developer Guide
diff --git a/docs/advanced-guides/index.md b/docs/advanced-guides/index.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Advanced Guides
+sidebar_position: 60
+---
+
+# Advanced Guides
diff --git a/docs/advanced-guides/style-guide.md b/docs/advanced-guides/style-guide.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Style Guide
+sidebar_position: 100
+---
+
+# Style Guide
diff --git a/docs/appendix/glossary.md b/docs/appendix/glossary.md
@@ -0,0 +1,9 @@
+---
+sidebar_label: Glossary
+sidebar_position: 1
+---
+
+# Glossary
+
+💡 This section serves as the central glossary within OSISM. It is intended to clearly define
+terms used within OSISM where there may be differing understandings.
diff --git a/docs/appendix/index.md b/docs/appendix/index.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Appendix
+sidebar_position: 100
+---
+
+# Appendix
diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Getting Started
+sidebar_position: 10
+---
+
+# Getting Started
diff --git a/docs/guides/deploy-guide/bootstrap.md b/docs/guides/deploy-guide/bootstrap.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Bootstrap
+sidebar_position: 5
+---
+
+# Bootstrap
diff --git a/docs/guides/deploy-guide/ceph.md b/docs/guides/deploy-guide/ceph.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Ceph
+sidebar_position: 20
+---
+
+# Ceph
diff --git a/docs/guides/deploy-guide/index.md b/docs/guides/deploy-guide/index.md
@@ -0,0 +1,22 @@
+---
+sidebar_label: Deploy Guides
+sidebar_position: 10
+---
+
+# Deploy Guides
+
+💡 The Deploy Guides describe how to deploy individual nodes and services.
+
+A classification is made for services. For example, all infrastructure services
+such as RabbitMQ or MariaDB are covered in the Infrastructure Guide.
+
+The Manager Node is treated specially because it must be treated differently when
+building a new machine.
+
+Before deploying services to nodes, they must all be bootstrapped. This is covered
+in the Bootstrap Guide.
+
+The guides always assume that a node is already initially accessible via SSH and only
+needs to be bootstrapped and integrated into the machine. Deploying bare-metal nodes
+with an operating system is not part of the Deploy Guides and is covered in the
+Advanced Guides.
diff --git a/docs/guides/deploy-guide/infrastructure.md b/docs/guides/deploy-guide/infrastructure.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Infrastructure
+sidebar_position: 10
+---
+
+# Infrastructure
diff --git a/docs/guides/deploy-guide/kubernetes.md b/docs/guides/deploy-guide/kubernetes.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Kubernetes
+sidebar_position: 8
+---
+
+# Kubernetes
diff --git a/docs/guides/deploy-guide/manager-node.md b/docs/guides/deploy-guide/manager-node.md
@@ -0,0 +1,10 @@
+---
+sidebar_label: Manager Node
+sidebar_position: 2
+---
+
+# Manager Node
+
+💡 The Manager Node Deploy Guides describes the initial deployment of a Manager Node. It describes everything
+up to that point so that the other Deploy Guides can be used afterwards. The necessary preparations of the
+initial configuration repository and a seed node are also included in this guide.
diff --git a/docs/guides/deploy-guide/monitoring.md b/docs/guides/deploy-guide/monitoring.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Monitoring
+sidebar_position: 40
+---
+
+# Monitoring
diff --git a/docs/guides/deploy-guide/network.md b/docs/guides/deploy-guide/network.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Network
+sidebar_position: 15
+---
+
+# Network
diff --git a/docs/guides/deploy-guide/openstack.md b/docs/guides/deploy-guide/openstack.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: OpenStack
+sidebar_position: 30
+---
+
+# OpenStack
diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Guides
+sidebar_position: 50
+---
+
+# Guides
diff --git a/docs/guides/operations-guide.md b/docs/guides/operations-guide.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Operations Guides
+sidebar_position: 30
+---
+
+# Operations Guides
diff --git a/docs/guides/upgrade-guide.md b/docs/guides/upgrade-guide.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Upgrade Guides
+sidebar_position: 20
+---
+
+# Upgrade Guides
diff --git a/docs/intro/architecture.md b/docs/intro/architecture.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Architecture
+sidebar_position: 20
+---
+
+# Architecture
diff --git a/docs/intro/index.md b/docs/intro/index.md
@@ -0,0 +1,8 @@
+---
+sidebar_label: Introduction
+sidebar_position: 1
+---
+
+# Introduction
+
+⚡️ OSISM will help you ship and operate a production grade open cloud infrastructure.
diff --git a/docs/references/cli.md b/docs/references/cli.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Command line interface reference
+sidebar_position: 1
+---
+
+# Command line interface reference
diff --git a/docs/references/configuration.md b/docs/references/configuration.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: Configuration reference
+sidebar_position: 2
+---
+
+# Configuration reference
diff --git a/docs/references/index.md b/docs/references/index.md
@@ -0,0 +1,6 @@
+---
+sidebar_label: References
+sidebar_position: 90
+---
+
+# References