Skip to content

Commit 1cb7e62

Browse files
committed
partial draft
1 parent 5ce4063 commit 1cb7e62

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed
154 KB
Loading
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Content reviews
4+
meta:
5+
title: Content reviews | How we docs
6+
---
7+
8+
We work in (and appreciate working in) [GitHub](https://github.com/cloudflare/cloudflare-docs), but it's not a perfect tool by any means.
9+
10+
We've added several ergonomic improvements to help us:
11+
12+
- Triage incoming work
13+
- Streamline reviews
14+
- Automate communication
15+
16+
## Triage work
17+
18+
Labeling for size and product, assignment based on codeowners.
19+
20+
## Streamline reviews
21+
22+
Preview builds with every commit.
23+
24+
Before/after table for comparisons.
25+
26+
Codeowner comments.
27+
28+
- Who needs to approve this? —> Codeowner comments
29+
- What is the difference —> Builds + before/after comment
30+
- Is there anything else I need to check —> Potential redirects comment.
31+
32+
## Automate communication
33+
34+
We automate communication primarily through the [`no-response`](https://github.com/lee-dohm/no-response) GitHub Action.
35+
36+
Being open source means that we accept issues and pull requests from anyone! And a lot of these are either self explanatory or have enough context for us to follow up on them.
37+
38+
The ones without enough context, however, are often painful. A writer has to ask for more detail, then remember to check back in, and then sometimes re-ask for more detail, and then check in again.
39+
40+
To help avoid some of this mental toil, we'll ask a question and then apply the `more-information-needed` label. This label starts a [14-day clock](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/no-response.yml) for the author to respond. If they do respond, the label gets removed and the conversation can continue. If they don't respond, the issue automatically gets closed with a [comment explaining why](https://github.com/cloudflare/cloudflare-docs/issues/22943#issuecomment-3002211164).
41+
42+
![No response comment](~/assets/images/style-guide/how-we-docs/no-response-comment.png)
43+
44+
This workflow - we hope - balances the needs our of team with a healthy respect for our contributors.
45+
46+
### Stale issues
47+
48+
We intentionally avoid the [`stale` workflow](https://github.com/github/docs/blob/main/.github/workflows/stale.yml) that closes pull requests or issues that have been inactive for a specific period of time.
49+
50+
In our opinion, this workflow causes more friction and frustration than it solves. Just because something has been around for a year doesn't mean it's not still relevant.

0 commit comments

Comments
 (0)