11# Contributing to the Knative Documentation
22
3+ - [ Before you begin] ( #before-you-begin )
4+ - [ Contributing to the documentation] ( #contributing-to-the-documentation )
5+ - [ Docs contributor roles] ( #docs-contributor-roles )
6+
37** First off, thanks for taking the time to contribute!**
48
59The following are guidelines for contributing to the Knative documentation.
@@ -20,7 +24,9 @@ Knative documentation follows the
2024[ Google Developer Documentation Style Guide] ( https://developers.google.com/style/ ) ;
2125use it as a reference for writing style questions.
2226
23- ## Reporting documentation issues
27+ ## Contributing to the documentation
28+
29+ ### Reporting documentation issues
2430
2531Knative uses Github issues to track documentation issues and requests. If you
2632see a problem with the documentation, submit an issue using the following steps:
@@ -42,7 +48,6 @@ Note that code issues should be filed against the
4248[ individual Knative repositories] ( http://github.com/knative ) , while
4349documentation issues should go in the ` docs ` repository.
4450
45- ## Contributing to the documentation
4651
4752### Working group
4853
@@ -98,3 +103,122 @@ Code samples follow a similar strategy, where most code samples should be
98103located in the ` docs ` repository. If there are code samples used for testing
99104that are only expected to be used by contributors, those samples are put in the
100105` samples ` folder within the component repo.
106+
107+ ## Docs contributor roles
108+
109+ Because contributing to the documentation requires a different skill set than
110+ contributing to the Knative code base, we've defined the roles of
111+ documentation contributors seperately from the roles of code contributors.
112+
113+ If you're looking for code contributor roles, see [ ROLES] ( ./ROLES.md ) .
114+
115+ ### Member
116+
117+ Established contributor to the Knative docs.
118+
119+ Members are continuously active contributors in the community. They can have
120+ issues and PRs assigned to them, might participate in working group meetings, and
121+ pre-submit tests are automatically run for their PRs. Members are expected to
122+ remain active contributors to the Knative documentation.
123+
124+ All members are encouraged to help with PR reviews, although each PR
125+ must be reviewed by an official [ Approver] ( #approver ) . In their review,
126+ members should be looking for technical correctness of the documentation,
127+ adherence to the [ style guide] ( https://developers.google.com/style/ ) , good spelling and grammar (writing quality),
128+ intuitive organization, and strong documentation usability. Members should be
129+ proficient in at least one of these review areas.
130+
131+ ### Requirements
132+
133+ - Has made multiple contributions to the project or community. Contributions might
134+ include, but are not limited to:
135+
136+ - Authoring and reviewing PRs on GitHub in the Docs or Website repos.
137+
138+ - Filing and commenting on issues on GitHub.
139+
140+ - Contributing to working group or community discussions.
141+
142+ - Subscribed to
143+ [ [email protected] ] ( https://groups.google.com/forum/#!forum/knative-dev ) .
144+
145+ - Actively contributing to 1 or more areas.
146+
147+ - Sponsored by 1 approver.
148+
149+ - Done by adding GitHub user to Knative organization.
150+
151+ ### Responsibilities and privileges
152+
153+ - Responsive to issues and PRs assigned to them.
154+
155+ - Active owner of documents they have contributed (unless ownership is explicitly
156+ transferred).
157+
158+ - Addresses bugs or issues in their documentation in a timely manner.
159+
160+ ### Becoming a member
161+
162+ First, reach out to an approver and ask them to sponsor you so that you can become a member.
163+ The easiest way to do this is using Slack.
164+
165+ If they are supportive of your membership, your sponsor will reach out to the Knative Steering
166+ committee to ask that you be added as a member of the Knative org.
167+
168+ Once your sponsor notifies you that you've been added to the Knative org,
169+ open a PR to add yourself as a docs-reviewer in the
170+ [ OWNERS_ALIASES] ( ../OWNERS_ALIASES ) file.
171+
172+ ## Approver
173+
174+ Docs approvers are able to both review and approve documentation contributions.
175+ While documentation review is focused on writing quality and correctness,
176+ approval is focused on holistic acceptance of a contribution including:
177+ long-term maintainability, adhering to style guide conventions, overall information
178+ architecture, and usability from an engineering standpoint. Docs approvers will
179+ enlist help from engineers for reviewing code-heavy contributions to the Docs repo.
180+
181+ ### Requirements
182+
183+ - Reviewer of the Docs repo for at least 3 months.
184+
185+ - Proficient in reviewing all aspects of writing quality, including grammar and
186+ spelling, adherence to style guide conventions, organization, and usability.
187+ Can coach newer writers to improve their contributions in these areas.
188+
189+ - Primary reviewer for at least 10 substantial PRs to the docs, showing substantial
190+ ability to coach for writing development.
191+
192+ - Reviewed or merged at least 30 PRs to the docs.
193+
194+ - Nominated by an area lead (with no objections from other leads).
195+
196+ - Done through PR to update an OWNERS file.
197+
198+ ### Responsibilities and privileges
199+
200+ - Responsible for documentation quality control via PR reviews.
201+
202+ - Focus on long-term maintainability, adhering to style
203+ guide conventions, overall information architecture, and usability from
204+ an engineering standpoint.
205+
206+ - Expected to be responsive to review requests as per
207+ [ community expectations] ( REVIEWING.md ) .
208+
209+ - Mentor members and contributors to improve their writing.
210+
211+ - Might approve documentation contributions for acceptance, but will ask for
212+ engineering review for code-heavy contributions.
213+
214+ ### Becoming an approver
215+
216+ If you want to become an approver, make your goal clear to the current
217+ Knative Docs approvers, either by contacting them in Slack or announcing
218+ your intention to become an approver at a meeting of the Documentation
219+ Working Group.
220+
221+ Once you feel you meet the criteria, you can ask one of the current
222+ approvers to nominate you to become an approver. If all existing
223+ approvers agree that you meet the criteria open a PR to add yourself
224+ as a docs-approver in the [ OWNERS_ALIASES] ( ../OWNERS_ALIASES ) file.
0 commit comments