Docs first stable version

resizes · Feb 28, 2024 · e143a6a · e143a6a
commit e143a6a
Show file tree

Hide file tree

Showing 109 changed files with 16,928 additions and 0 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,39 @@
+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
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Build website
+        run: npm run build
+
+      - name: Set build folder as artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          name: github-pages
+          path: ./build
+
+      - uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](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/artifact-storage/_category_.json b/docs/artifact-storage/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Artifact Storage",
+    "position": 10,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+
diff --git a/docs/artifact-storage/introduction.md b/docs/artifact-storage/introduction.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# What is an Artifact?
+
+An artifact is a deployable component of your application. It can be a compiled binary, a library, a Docker image, or any other file that is part of your application. Artifacts are stored in an artifact repository, which is a collection of all the artifacts that are part of your application.
diff --git a/docs/chaos-engineering/_category_.json b/docs/chaos-engineering/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Chaos Engineering",
+    "position": 21,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+
diff --git a/docs/chaos-engineering/introduction.md b/docs/chaos-engineering/introduction.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# What is Chaos Engineering?
+
+Chaos engineering is the practice of intentionally introducing failure into a system in order to test its resilience and reliability. It is a way to proactively identify and address weaknesses in a system, and it is used to ensure that a system can continue to function in the face of unexpected events and conditions.
diff --git a/docs/ci-cd/_category_.json b/docs/ci-cd/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "CI/CD",
+    "position": 9,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+
diff --git a/docs/ci-cd/continuous-integration.md b/docs/ci-cd/continuous-integration.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Continuous Integration
+
+Continuous Integration (CI) is a software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run. The key goals of CI are to find and address bugs quicker, improve software quality, and reduce the time it takes to validate and release new software updates.
diff --git a/docs/cloud/_category_.json b/docs/cloud/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Cloud",
+    "position": 7,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+
diff --git a/docs/cloud/cloud-native.md b/docs/cloud/cloud-native.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 4
+---
+
+# Cloud-Native
+
+## What is Cloud-Native?
+
+Cloud-Native is an approach to building and running applications that fully leverage the advantages of cloud computing. It is a set of practices and patterns that enable organizations to build scalable, resilient, and efficient applications in the cloud.
diff --git a/docs/cloud/cloud-patterns.md b/docs/cloud/cloud-patterns.md
@@ -0,0 +1,5 @@
+---
+sidebar_position: 3
+---
+
+# Cloud Patterns
diff --git a/docs/cloud/cloud-providers.md b/docs/cloud/cloud-providers.md
@@ -0,0 +1,5 @@
+---
+sidebar_position: 2
+---
+
+# Cloud Providers
diff --git a/docs/cloud/what-is-cloud.md b/docs/cloud/what-is-cloud.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# What is Cloud?
+
+The cloud is a network of servers that are hosted on the internet. These servers store and manage data, run applications, and deliver content or services such as streaming videos, webmail, office productivity software, and social media.
diff --git a/docs/code-analysis/_category_.json b/docs/code-analysis/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Code Analysis",
+    "position": 15,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+
diff --git a/docs/code-analysis/introduction.md b/docs/code-analysis/introduction.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# What is Code Analysis?
+
+Code analysis is the process of analyzing source code to find bugs, security vulnerabilities, and other issues. It is an essential part of the software development process, as it helps to ensure that the code is of high quality and free from defects. Code analysis tools can be used to automate the process of finding and fixing issues in the code, which can help to improve the overall quality of the software.
diff --git a/docs/container-orchestrator/_category_.json b/docs/container-orchestrator/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Container Orchestrator",
+    "position": 11,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+
diff --git a/docs/container-orchestrator/introduction.md b/docs/container-orchestrator/introduction.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# What is Container Orchestration?
+
+Container orchestration is the process of managing the lifecycle of containers, especially in large, dynamic environments. It involves automating the deployment, scaling, and management of containerized applications. Container orchestration tools provide a platform for defining, deploying, and managing a set of interconnected containers.
diff --git a/docs/containers/_category_.json b/docs/containers/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Containers",
+    "position": 5,
+    "link": {
+      "type": "generated-index"
+    }
+  }
+