Add guidance about creating and including snippets in docs for contributors.
Open
hacktoberfest
kind/good-first-issue
kind/infrastructure
lifecycle/frozen
priority/nice-to-have
- Dominant language
- HTML
- Stars
- 5.1k
- Forks
- 1.3k
- PR merge metrics
- No merged PRs in 30d
Description
## Context
To prevent duplication in docs we want to implement a snippets feature that meets our needs.
## Tasks
1. After #4556 is closed, document how to use the snippets plugin in the [docs contributor guide](https://github.com/knative/docs/tree/main/contribute-to-docs).
Contributor guide
Research direction
Start by checking issue #4556, then read the docs contributor guide at contribute-to-docs to identify where the snippets guidance belongs. Done means the guide explains how contributors create and include snippets using the completed snippets feature, without duplicating existing documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100