Docs/dino (#3182)

Moving to docusaurus
Netflix · Mar 29, 2023 · fbbacae · fbbacae
1 parent 347e1f9
commit fbbacae
Show file tree

Hide file tree

Showing 163 changed files with 37,803 additions and 300 deletions.
diff --git a/.github/workflows/deploy-docs-test.yml b/.github/workflows/deploy-docs-test.yml
@@ -0,0 +1,24 @@
+name: Test documentation deployment
+
+on:
+  pull_request:
+    branches:
+      - master
+    # 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:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: docs/package-lock.json
+
+      - name: Install and Build
+        run: pwd && npm install && npm run build
+        working-directory: docs
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -0,0 +1,44 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    # 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:
+    defaults:
+      run:
+        shell: bash
+        working-directory: docs
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+
+      - name: Install dependencies
+        run: npm install
+      - name: Test build website
+        run: npm run 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
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com
diff --git a/SUMMARY.md b/SUMMARY.md
diff --git a/docs/.gitignore b/docs/.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/docs/README.md b/docs/README.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/admin-guide/README.md b/docs/admin-guide/README.md
diff --git a/docs/admin-guide/administration/README.md b/docs/admin-guide/administration/README.md
diff --git a/docs/admin-guide/administration/contact/README.md b/docs/admin-guide/administration/contact/README.md
diff --git a/docs/babel.config.js b/docs/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/admin-guide/administration/api.md → docs/docs/administration/api.mdx b/docs/admin-guide/administration/api.md → docs/docs/administration/api.mdx
diff --git a/...uide/administration/case/case-priority.md → ...ocs/administration/case/case-priority.mdx b/...uide/administration/case/case-priority.md → ...ocs/administration/case/case-priority.mdx
@@ -1,8 +1,8 @@
-## Case Priority
+# Case Priority
 
 In addition to case types, Dispatch allows you to specify the case's priority.
 
-![](../../../.gitbook/assets/admin-ui-case-priorities.png)
+![](/img/admin-ui-case-priorities.png)
 
 **Name:** The name of the case priority presented to the user.
 

diff --git a/...uide/administration/case/case-severity.md → ...ocs/administration/case/case-severity.mdx b/...uide/administration/case/case-severity.md → ...ocs/administration/case/case-severity.mdx
@@ -1,8 +1,8 @@
-## Case Severity
+# Case Severity
 
 In addition to case types, Dispatch allows you to specify the case's severity.
 
-![](../../../.gitbook/assets/admin-ui-case-severities.png)
+![](/img/admin-ui-case-severities.png)
 
 **Name:** The name of the case severity presented to the user.
 

diff --git a/...in-guide/administration/case/case-type.md → docs/docs/administration/case/case-type.mdx b/...in-guide/administration/case/case-type.md → docs/docs/administration/case/case-type.mdx
@@ -1,8 +1,8 @@
-## Case Types
+# Case Types
 
 Dispatch allows you to categorize your cases by defining case types and to map them to various Dispatch resources (e.g. templates, oncall services, and incident types).
 
-![](../../../.gitbook/assets/admin-ui-case-types.png)
+![](/img/admin-ui-case-types.png)
 
 **Name:** The name of the case type presented to the user.
 

diff --git a/...admin-guide/administration/case/README.md → ...docs/administration/case/introduction.mdx b/...admin-guide/administration/case/README.md → ...docs/administration/case/introduction.mdx
@@ -1,5 +1,6 @@
 ---
-description: View and manage all cases.
+title: Introduction
+sidebar_position: 0
 ---
 
 Cases are meant to triage events that do not raise to the level of incidents, but can be escalated to incidents if necessary. If you map a case type to an incident type and you escalate the case, then Dispatch will automatically create an incident and link the two.

diff --git a/docs/admin-guide/administration/cli.md → docs/docs/administration/cli.mdx b/docs/admin-guide/administration/cli.md → docs/docs/administration/cli.mdx
@@ -175,9 +175,9 @@ Commands:
   upgrade        Upgrades database schema to newest version.
 ```
 
-{% hint style="info" %}
+:::info
 Note: The database command is a combination of custom commands and `alembic` commands. For more information about alembic database migrations, see [here](https://alembic.sqlalchemy.org/en/latest/).
-{% endhint %}
+:::
 
 ### Init
 
@@ -244,4 +244,4 @@ INFO:dispatch.common.utils.cli:Attempting to load plugin: dispatch_document_reso
 ...
 ```
 
-Keep in mind that this will only make plugins available. To enable them [create and configure the plugin instance](./plugins/README.md)
+Keep in mind that this will only make plugins available. To enable them [create and configure the plugin instance](./plugins/introduction.mdx)
diff --git a/...uide/administration/contact/individual.md → ...ocs/administration/contact/individual.mdx b/...uide/administration/contact/individual.md → ...ocs/administration/contact/individual.mdx
@@ -1,10 +1,10 @@
-## Individual
+# Individual
 
 In Dispatch, Individuals are either internal or external people identifiers. Typically, an organization will maintain a robust internal directory for user identities. Dispatch does not expect to replace those data stores. Instead, it keeps a lightweight notion of identities to associate with incidents for filtering and metrics.
 
 It's common for incident response teams to maintain a list of contacts and run books to specify whom to contact when an incident occurs. Dispatch handles this for incident response teams by pulling the right individuals directly into an incident. By assigning terms, incident types, or incident priorities to individuals, Dispatch can instantly add them to the incident \(if internal\) or suggest reaching out to them \(if external\).
 
-![](../../../.gitbook/assets/admin-ui-contacts-individuals.png)
+![](/img/admin-ui-contacts-individuals.png)
 
 **Name:** Name of the individual.
 

diff --git a/docs/docs/administration/contact/introduction.mdx b/docs/docs/administration/contact/introduction.mdx
@@ -0,0 +1,4 @@
+---
+title: Introduction
+sidebar_position: 0
+---
diff --git a/...n-guide/administration/contact/service.md → docs/docs/administration/contact/service.mdx b/...n-guide/administration/contact/service.md → docs/docs/administration/contact/service.mdx
@@ -1,8 +1,8 @@
-## Service
+# Service
 
 Like `Teams`, there are often groups of individuals (teams) responsible for an application or service that need to be involved in an incident. However, in these circumstances, we don't want to engage the _whole_ team. We only want to engage the individual that is on-call for the service. `Services` allow Dispatch to resolve these individuals via third-party on-call services (e.g., PagerDuty, OpsGenie).
 
-![](../../../.gitbook/assets/admin-ui-contacts-services.png)
+![](/img/admin-ui-contacts-services.png)
 
 **Name:** Name of the service.
 

diff --git a/...dmin-guide/administration/contact/team.md → docs/docs/administration/contact/team.mdx b/...dmin-guide/administration/contact/team.md → docs/docs/administration/contact/team.mdx
@@ -1,8 +1,8 @@
-## Team
+# Team
 
 Like `Individuals`, there are often groups of individuals (teams) that need to be engaged and notified during an incident. Dispatch manages those groups \(typically, team distribution lists\), providing a centralized data store for that contact data.
 
-![](../../../.gitbook/assets/admin-ui-contacts-teams.png)
+![](/img/admin-ui-contacts-teams.png)
 
 **Name:** Name of the team.
 

diff --git a/...-guide/administration/data/data-format.md → .../docs/administration/data/data-format.mdx b/...-guide/administration/data/data-format.md → .../docs/administration/data/data-format.mdx
@@ -1,4 +1,4 @@
-## Data Formats
+# Data Formats
 
 Data sources are not always uniformed in nature. It's often helpful to understand what the underlying data format for a given data source is. Here, Dispatch allows you to define common data formats that sources in your environment use.
 

diff --git a/...-guide/administration/data/environment.md → .../docs/administration/data/environment.mdx b/...-guide/administration/data/environment.md → .../docs/administration/data/environment.mdx
@@ -1,4 +1,4 @@
-## Environment
+# Environment
 
 Data sources often have a corresponding environment to which they apply. For example, one data set may only contain information from the production account. When responding to incidents and using data sources for investigation, it's essential to understand the data source's scope.
 

diff --git a/...admin-guide/administration/data/README.md → ...docs/administration/data/introduction.mdx b/...admin-guide/administration/data/README.md → ...docs/administration/data/introduction.mdx
@@ -1,7 +1,6 @@
 ---
-description: Learning about Dispatch's data catalog.
+title: Introduction
+sidebar_position: 0
 ---
 
-# Data
-
 Along with incident orchestration, Dispatch is adept at building a catalog of data that can be used to resolve incidents.
diff --git a/...admin-guide/administration/data/status.md → docs/docs/administration/data/status.mdx b/...admin-guide/administration/data/status.md → docs/docs/administration/data/status.mdx
@@ -1,4 +1,4 @@
-## Status
+# Status
 
 When using a data source in the coarse of an investigation, one needs to understand the current state of that database. Here, Dispatch allows you define your own data source statuses.
 

diff --git a/...in-guide/administration/data/transport.md → docs/docs/administration/data/transport.mdx b/...in-guide/administration/data/transport.md → docs/docs/administration/data/transport.mdx
@@ -1,4 +1,4 @@
-## Transport
+# Transport
 
 Allows the user define their own transport layers for their data sources.
 

diff --git a/docs/admin-guide/administration/data/type.md → docs/docs/administration/data/type.mdx b/docs/admin-guide/administration/data/type.md → docs/docs/administration/data/type.mdx
@@ -1,4 +1,4 @@
-## Type
+# Type
 
 You may have several different systems you need to interact with in order to access/query a data source. It's type denotes the underlying technology or system that it's most closely associated with.
 

diff --git a/docs/faq.md → docs/docs/administration/faq.mdx b/docs/faq.md → docs/docs/administration/faq.mdx
diff --git a/...nistration/incident/incident-cost-type.md → ...istration/incident/incident-cost-type.mdx b/...nistration/incident/incident-cost-type.md → ...istration/incident/incident-cost-type.mdx
@@ -1,8 +1,8 @@
-## Incident Cost Types
+# Incident Cost Types
 
 Dispatch allows you to define incident cost types. These types can then be used when editing and adding costs to incidents. Dispatch calculates the incident response cost for all incidents every 5 minutes and saves the result to the default incident cost type. We recommend creating at least the response cost type and making it the default to take advantage of this useful feature. You can find the list of incident cost types (or Forms of Loss) recommended by the Factor Analysis of Information Risk (FAIR) Institute [here](https://www.fairinstitute.org/blog/a-crash-course-on-capturing-loss-magnitude-with-the-fair-model).
 
-![](../../../.gitbook/assets/admin-ui-incident-cost-types.png)
+![](/img/admin-ui-incident-cost-types.png)
 
 **Name:** The name of the incident cost type presented to the user.
 
@@ -18,4 +18,4 @@ Dispatch allows you to define incident cost types. These types can then be used
 
 Dispatch [calculates](https://github.com/Netflix/dispatch/blob/develop/src/dispatch/incident/service.py#L279) the cost of an incident by adding up the time participants have spent on each incident role \(e.g., Incident Commander\) and applying an [engagement multiplier](https://github.com/Netflix/dispatch/blob/develop/src/dispatch/incident/service.py#L266) that's based on the incident role. It also includes time spent on incident review-related activities. Dispatch calculates and published the cost for all incidents [every 5 minutes](https://github.com/Netflix/dispatch/blob/develop/src/dispatch/incident/scheduled.py#L257).
 
-If you can tweak incident cost parameters on a per-project basis by editing your project [here](../project.md)
+If you can tweak incident cost parameters on a per-project basis by editing your project [here](../project.mdx)
diff --git a/...inistration/incident/incident-priority.md → ...nistration/incident/incident-priority.mdx b/...inistration/incident/incident-priority.md → ...nistration/incident/incident-priority.mdx
@@ -1,8 +1,8 @@
-## Incident Priority
+# Incident Priority
 
 In addition to incident types, Dispatch allows you to specify the incident's _priority_.
 
-![](../../../.gitbook/assets/admin-ui-incident-priorities.png)
+![](/img/admin-ui-incident-priorities.png)
 
 **Name:** The name of the incident priority presented to the user.