Merge pull request #12 from smithy-security/feature/new-content

Docs content - OSS quickstarts
smithy-security · Nov 5, 2024 · ece8494 · ece8494
2 parents 275e09e + 5ace205
commit ece8494
Show file tree

Hide file tree

Showing 60 changed files with 2,330 additions and 4,388 deletions.
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -15,7 +15,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: yarn
 
       - name: Install dependencies

diff --git a/.github/workflows/test-deploy.yaml b/.github/workflows/test-deploy.yaml
@@ -15,7 +15,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: yarn
 
       - name: Install dependencies

diff --git a/README.md b/README.md
@@ -20,22 +20,6 @@ This command starts a local development server and opens up a browser window. Mo
 
 The docs are automatically deployed to GitHub pages, hosted at [docs.smithy.security](https://docs.smithy.security). More information can be found in the `.github/workflows/` folder.
 
-## OpenAPI Docs
-
-We automatically generate some parts of the docs from OpenAPI specifications using the [docusaurus-openapi-docs plugin](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs).
-
-### Adding OpenAPI Docs
-
-1. Place the corresponding `openapi.yaml` specs in the `openapi/` folder
-2. Reference the docs in the `plugins` section of `docusaurus.config.ts`
-3. Run `yarn docusaurus gen-api-docs all`
-
-### Updating OpenAPI Docs
-
-1. Place a new version of the `openapi.yaml` in the `openapi/` folder
-2. Run `yarn docusaurus clean-api-docs all` to remove outdated docs
-3. Then run `yarn docusaurus gen-api-docs all` to generate the new docs
-
 ## Writing
 
 We [follow Diátaxis](https://diataxis.fr/), a systematic approach to technical documentation authoring.
diff --git a/docs/explanation/_category_.json b/docs/explanation/_category_.json
diff --git a/docs/explanation/components.md b/docs/explanation/components.md
diff --git a/docs/explanation/pipelines.md b/docs/explanation/pipelines.md
diff --git a/docs/how-tos/_category_.json b/docs/how-tos/_category_.json
diff --git a/docs/how-tos/components/_category_.json b/docs/how-tos/components/_category_.json
diff --git a/docs/how-tos/components/advanced.md b/docs/how-tos/components/advanced.md
diff --git a/docs/how-tos/components/example-producer/main.go b/docs/how-tos/components/example-producer/main.go
diff --git a/docs/how-tos/components/example-producer/main_test.go b/docs/how-tos/components/example-producer/main_test.go
diff --git a/docs/how-tos/components/example-producer/task.yaml b/docs/how-tos/components/example-producer/task.yaml
diff --git a/docs/how-tos/components/introduction.md b/docs/how-tos/components/introduction.md
diff --git a/docs/how-tos/components/writing-consumers.md b/docs/how-tos/components/writing-consumers.md