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

Update documentation Makefile and README #6339

Merged
merged 6 commits into from
Sep 4, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Revert template explanation changes
ADubhlaoich committed Sep 3, 2024

Verified

This commit was signed with the committer’s verified signature.
ADubhlaoich Alan Dooley
commit 52332012f200841098662529cd64552a9bf26e22
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -66,13 +66,13 @@ The default template -- task -- should be used for most documentation. To create
hugo new tutorials/deploy.md --kind tutorial
```

The available content types (`kind`) are:
The available content templates (`kind`) are:

- concept: Helps a customer learn about a specific feature or feature set.
- tutorial: Walks a customer through an example use case scenario; results in a functional PoC environment.
- concept: Help a user learn about a specific feature or feature set.
- tutorial: Walk a user through an example use case scenario; results in a functional PoC environment.
- reference: Describes an API, command line tool, config options, etc.; should be generated automatically from source code.
- troubleshooting: Helps a customer solve a specific problem.
- openapi: Contains front-matter and shortcode for rendering an openapi.yaml spec
- troubleshooting: Help a user solve a specific problem.
- openapi: A template with the requirements to render an openapi.yaml specification

## Documentation formatting