knative/docs

Add guidance about creating and including snippets in docs for contributors.

Open

#4,558 opened on Dec 13, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (1,202 forks)batch import
hacktoberfestkind/good-first-issuekind/infrastructurelifecycle/frozenpriority/nice-to-have

Repository metrics

Stars
 (4,320 stars)
PR merge metrics
 (Avg merge 4d 20h) (1 merged PR 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.

Contributor guide

Research direction
After #4556 is merged, review the snippets plugin implementation and update the docs contributor guide with instructions on creating and using snippets.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85