You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/zh-cn/docs/contribute/review/reviewing-prs.md
+57-90Lines changed: 57 additions & 90 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -259,7 +259,9 @@ When reviewing, use the following as a starting point.
259
259
- 内容本身是否过度依赖于网站范畴之外、独立供应商或者非开源的文档?
260
260
261
261
<!--
262
-
### Website
262
+
### Documentation
263
+
264
+
Some checks to consider:
263
265
264
266
- Did this PR change or remove a page title, slug/alias or anchor link? If so, are there broken
265
267
links as a result of this PR? Is there another option, like changing the page title without
@@ -275,7 +277,9 @@ When reviewing, use the following as a starting point.
275
277
- Do the changes show up in the Netlify preview? Be particularly vigilant about lists, code
276
278
blocks, tables, notes and images.
277
279
-->
278
-
### 网站 {#Website}
280
+
### 文档 {#documentation}
281
+
282
+
考虑做一些检查:
279
283
280
284
- PR 是否改变或者删除了某页面的标题、slug/别名或者链接锚点?
281
285
如果是这样,PR 是否会导致出现新的失效链接?
@@ -294,113 +298,76 @@ When reviewing, use the following as a starting point.
294
298
<!--
295
299
### Blog
296
300
297
-
- Early feedback on blog posts is welcome via a Google Doc or HackMD. Please request input early from the [#sig-docs-blog Slack channel](https://kubernetes.slack.com/archives/CJDHVD54J).
298
-
- Before reviewing blog PRs, be familiar with [Submitting blog posts and case studies](/docs/contribute/new-content/blogs-case-studies/).
299
-
-->
300
-
### 博客
301
+
Early feedback on blog posts is welcome via a Google Doc or HackMD. Please request input early from the [#sig-docs-blog Slack channel](https://kubernetes.slack.com/archives/CJDHVD54J).
- We are willing to mirror any blog article that was published to https://kubernetes.dev/blog/ (the contributor blog) provided that:
307
-
- the mirrored article has the same publication date as the original (it should have the same publication time too, but you can also set a time stamp up to 12 hours later for special cases)
308
-
- for PRs that arrive the original article was merged to https://kubernetes.dev/, there haven't been
309
-
(and won't be) any articles published to the main blog between time that the original and mirrored article
310
-
[will] publish.
311
-
This is because we don't want to add articles to people's feeds, such as RSS, except at the very end of their feed.
312
-
- the original article doesn't contravene any strongly recommended review guidelines or community norms.
313
-
- You should set the canonical URL for the mirrored article, to the URL of the original article
314
-
(you can use a preview to predict the URL and fill this in ahead of actual publication). Use the `canonicalUrl`
315
-
field in [front matter](https://gohugo.io/content-management/front-matter/) for this.
303
+
Before reviewing blog PRs, be familiar with the [blog guidelines](/docs/contribute/blog/guidelines/)
304
+
and with [submitting blog posts and case studies](/docs/contribute/new-content/blogs-case-studies/).
- The [content guide](/docs/contribute/style/content-guide/) applies unconditionally to blog articles
352
-
and the PRs that add them. Bear in mind that some restrictions in the guide state that they are only relevant to documentation; those restrictions don't apply to blog articles.
315
+
Make sure you also know about [evergreen](/docs/contribute/blog/#maintenance-evergreen) articles
316
+
and how to decide if an article is evergreen.
317
+
318
+
Blog articles may contain [direct quotes](https://en.wikipedia.org/wiki/Direct_discourse) and
319
+
[indirect speech](https://en.wikipedia.org/wiki/Indirect_speech). Avoid suggesting a rewording for
320
+
anything that is attributed to someone or part of a dialog that has happened - even if you think
321
+
the original speaker's grammar was not correct. For those cases, also, try to respect the article
322
+
author's suggested punctuation unless it is obviously wrong.
- The [style guide](/docs/contribute/style/style-guide/) largely also applies to blog PRs, but we make some exceptions.
358
-
359
-
- it is OK to use “we“ in a blog article that has multiple authors, or where the article introduction clearly indicates that the author is writing on behalf of a specific group.
360
-
- we avoid using Kubernetes shortcodes for callouts (such as `{{</* caution */>}}`)
361
-
- statements about the future are OK, albeit we use them with care in official announcements on
362
-
behalf of Kubernetes
363
-
- code samples don't need to use the `{{</* code_sample */>}}` shortcode, and often it is better if they do not
364
-
- we are OK to have authors write an article in their own writing style, so long as most readers
365
-
would follow the point being made
332
+
As a project, we only mark blog articles as maintained (`evergreen: true` in front matter) if the Kubernetes project
333
+
is happy to commit to maintaining them indefinitely.
334
+
Some blog articles absolutely merit this, and we always mark our release announcements evergreen. Check with other contributors if you are not sure how to review on this point.
- The [diagram guide](/docs/contribute/style/diagram-guide/) is aimed at Kubernetes documentation,
377
-
not blog articles. It is still good to align with it but:
378
-
- we prefer SVG over raster diagram formats, and also over Mermaid (you can still capture the Mermaid source in a comment)
379
-
- there is no need to caption diagrams as Figure 1, Figure 2 etc
342
+
The [content guide](/docs/contribute/style/content-guide/) applies unconditionally to blog articles and the PRs that add them. Bear in mind that some restrictions in the guide state that they are only relevant to documentation; those restrictions don't apply to blog articles.
343
+
344
+
Check if the Markdown source is using the right [page content type](/docs/contribute/style/page-content-types/) and / or `layout`.
0 commit comments