Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs content - OSS quickstarts #12

Merged
merged 8 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 0 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 0 additions & 8 deletions docs/explanation/_category_.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/explanation/components.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/explanation/pipelines.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/how-tos/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/how-tos/components/_category_.json

This file was deleted.

47 changes: 0 additions & 47 deletions docs/how-tos/components/advanced.md

This file was deleted.

111 changes: 0 additions & 111 deletions docs/how-tos/components/example-producer/main.go

This file was deleted.

53 changes: 0 additions & 53 deletions docs/how-tos/components/example-producer/main_test.go

This file was deleted.

46 changes: 0 additions & 46 deletions docs/how-tos/components/example-producer/task.yaml

This file was deleted.

14 changes: 0 additions & 14 deletions docs/how-tos/components/introduction.md

This file was deleted.

29 changes: 0 additions & 29 deletions docs/how-tos/components/writing-consumers.md

This file was deleted.

Loading