Skip to content

Commit fc74204

Browse files
Merge pull request #50438 from michellengnx/merged-main-dev-1.33
Merging main branch into dev-1.33
2 parents 598c259 + bf4734d commit fc74204

File tree

104 files changed

+5023
-3091
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+5023
-3091
lines changed

OWNERS_ALIASES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,13 @@ aliases:
8484
sig-docs-es-owners: # Admins for Spanish content
8585
- electrocucaracha
8686
- krol3
87+
- raelga
8788
- ramrodo
8889
sig-docs-es-reviews: # PR reviews for Spanish content
8990
- electrocucaracha
9091
- jossemarGT
9192
- krol3
93+
- raelga
9294
- ramrodo
9395
sig-docs-fr-owners: # Admins for French content
9496
- perriea

content/en/blog/_posts/2024-05-09-gateway-api-v1.1/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -136,20 +136,20 @@ metadata:
136136
spec:
137137
gatewayClassName: acme-lb
138138
listeners:
139-
name: foo-https
139+
- name: foo-https
140140
protocol: HTTPS
141141
port: 443
142142
hostname: foo.example.com
143-
tls:
144-
certificateRefs:
145-
kind: Secret
146-
group: ""
147-
name: foo-example-com-cert
148-
frontendValidation:
149-
caCertificateRefs:
150-
kind: ConfigMap
143+
tls:
144+
certificateRefs:
145+
- kind: Secret
151146
group: ""
152-
name: foo-example-com-ca-cert
147+
name: foo-example-com-cert
148+
frontendValidation:
149+
caCertificateRefs:
150+
- kind: ConfigMap
151+
group: ""
152+
name: foo-example-com-ca-cert
153153
```
154154

155155
#### [Session Persistence and BackendLBPolicy](https://gateway-api.sigs.k8s.io/geps/gep-1619/)

content/en/docs/contribute/_index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,18 @@ card:
1414
<!-- overview -->
1515

1616
There are lots of ways to contribute to Kubernetes. You can work on designs for new features,
17-
you can document the code we already have, you can write for our [blog](/blog). There's more:
18-
you can implement those new features or fix bugs. You can help people join our contributor
19-
community, or support existing contributors.
17+
you can document the code we already have, you can [write for our blogs](/docs/contribute/blog/).
18+
There's more: you can implement those new features or fix bugs. You can help people join our
19+
contributor community, or support existing contributors.
2020

2121
With all these different ways to make a difference to the project, we - Kubernetes - have made
2222
a dedicated website: https://k8s.dev/. You can go there to learn more about
2323
contributing to Kubernetes.
2424

25-
If you specifically want to learn about contributing to _this_ documentation, read
26-
[Contribute to Kubernetes documentation](/docs/contribute/docs/).
25+
If you specifically want to learn about contributing to the documentation or
26+
other parts of _this_ website, read [Contribute to Kubernetes documentation](/docs/contribute/docs/).
27+
If you specifically want to help with the official Kubernetes blogs, read
28+
[Contributing to Kubernetes blogs](/docs/contribute/blog/).
2729

2830
You can also read the
2931
{{< glossary_tooltip text="CNCF" term_id="cncf" >}}
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Contributing to Kubernetes blogs
3+
slug: blog-contribution
4+
content_type: concept
5+
weight: 15
6+
simple_list: true
7+
---
8+
9+
<!-- overview -->
10+
11+
There are two official Kubernetes blogs, and the CNCF has [its own blog](https://www.cncf.io/blog/) where you can cover Kubernetes too.
12+
For the main Kubernetes blog, we (the Kubernetes project) like to publish articles with different perspectives and special focuses, that have a link to Kubernetes.
13+
14+
With only a few special case exceptions, we only publish content that hasn't been submitted or published anywhere else.
15+
16+
Read the [blog guidelines](/docs/contribute/blog/guidelines/#what-we-publish) for more about that aspect.
17+
18+
## Official Kubernetes blogs
19+
20+
### Main blog
21+
22+
The main [Kubernetes blog](/blog/) is used by the project to communicate new features, community reports, and any
23+
news that might be relevant to the Kubernetes community. This includes end users and developers.
24+
Most of the blog's content is about things happening in the core project, but Kubernetes
25+
as a project encourages you to submit about things happening elsewhere in the ecosystem too!
26+
27+
Anyone can write a blog post and submit it for publication. With only a few special case exceptions, we only publish content that hasn't been submitted or published anywhere else.
28+
29+
### Contributor blog
30+
31+
The [Kubernetes contributor blog](https://k8s.dev/blog/) is aimed at an audience of people who
32+
work **on** Kubernetes more than people who work **with** Kubernetes. The Kubernetes project
33+
deliberately publishes some articles to both blogs.
34+
35+
Anyone can write a blog post and submit it for review.
36+
37+
## Article updates and maintenance {#maintenance}
38+
39+
The Kubernetes project does not maintain older articles for its blogs. This means that any
40+
published article more than one year old will normally **not** be eligible for issues or pull
41+
requests that ask for changes. To avoid establishing precedent, even technically correct pull
42+
requests are likely to be rejected.
43+
44+
However, there are exceptions like the following:
45+
46+
* (updates to) articles marked as [evergreen](#maintenance-evergreen)
47+
* removing or correcting articles giving advice that is now wrong and dangerous to follow
48+
* fixes to ensure that an existing article still renders correctly
49+
50+
For any article that is over a year old and not marked as _evergreen_, the website automatically
51+
displays a notice that the content may be stale.
52+
53+
### Evergreen articles {#maintenance-evergreen}
54+
55+
You can mark an article as evergreen by setting `evergreen: true` in the front matter.
56+
57+
We only mark blog articles as maintained (`evergreen: true` in front matter) if the Kubernetes project
58+
can commit to maintaining them indefinitely. Some blog articles absolutely merit this; for example, the release comms team always marks official release announcements as evergreen.
59+
60+
## {{% heading "whatsnext" %}}
61+
62+
* Discover the official blogs:
63+
* [Kubernetes blog](/blog/)
64+
* [Kubernetes contributor blog](https://k8s.dev/blog/)
65+
66+
* Read about [reviewing blog pull requests](/docs/contribute/review/reviewing-prs/#blog)
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: Helping as a blog writing buddy
3+
slug: writing-buddy
4+
content_type: concept
5+
weight: 70
6+
---
7+
8+
<!-- overview -->
9+
10+
There are two official Kubernetes blogs, and the CNCF has its own blog where you can cover Kubernetes too.
11+
Read [contributing to Kubernetes blogs](/docs/contribute/blog/) to learn about these two blogs.
12+
13+
When people contributor to either blog as an author, the Kubernetes project pairs up authors
14+
as _writing buddies_. This page explains how to fulfil the buddy role.
15+
16+
You should make sure that you have at least read an outline of [article submission](/docs/contribute/blog/submission/)
17+
before you read on within this page.
18+
19+
<!-- body -->
20+
21+
## Buddy responsibilities
22+
23+
As a writing buddy, you:
24+
25+
* help the blog team get articles ready to merge and to publish
26+
* support your buddy to produce content that is good to merge
27+
* provide a review on the article that your buddy has written
28+
29+
30+
When the team pairs you up with another author, the idea is that you both support each other by
31+
reviewing the other author's draft article.
32+
Most people reading articles on the Kubernetes blog are not experts; the content should
33+
try to make sense for that audience, or at least to support non-expert readers appropriately.
34+
35+
The blog team are also there to help you both along the journey from draft to publication.
36+
They will either be directly able to approve your article for publication, or can arrange for
37+
the approval to happen.
38+
39+
## Supporting the blog team
40+
41+
Your main responsibility here is to communicate about your capacity, availability and progress
42+
in a reasonable timeline. If many weeks go by and your buddy hasn't heard from you, it makes
43+
the overall work take more time.
44+
45+
## Supporting your buddy
46+
47+
There are two parts to the process
48+
49+
{{< tabs name="buddy_support" >}}
50+
{{% tab name="Collaborative editing" %}}
51+
**(This is the recommended option)**
52+
53+
The blog team recommend that the main author for the article sets up collaborative editing
54+
using either a Google Doc or HackMD (their choice). The main author then shares that document
55+
with the following people:
56+
57+
* Any co-authors
58+
* You (their writing buddy)
59+
* Ideally, with a nominated
60+
person from the blog team.
61+
62+
As a writing buddy, you then read the draft text and either directly make suggestions or provide
63+
feedback in a different way. The author of the blog is very commonly also **your** writing buddy in turn, so they will provide the
64+
same kind of feedback on the draft for your blog article.
65+
66+
Your role here is to recommend the smallest set of changes that will get the article look good
67+
for publication. If there's a diagram that really doesn't make sense, or the writing is really
68+
unclear: provide feedback. If you have a slight different of opinion about wording or punctuation,
69+
skip it. Let the article author(s) write in their own style, provided that they align to
70+
the [blog guidelines](/docs/contribute/blog/guidelines/).
71+
72+
After this is ready, the lead author will open a pull request and use Markdown to submit the
73+
article. You then provide a [review](#pull-request-review).
74+
{{% /tab %}}
75+
{{% tab name="Markdown / Git editing" %}}
76+
Some authors prefer to start with
77+
[collaborative editing](#buddy-support-0); others like to go straight into
78+
GitHub.
79+
80+
Whichever route they take, your role is to provide feedback that lets the blog team provide
81+
a simple signoff and confirm that the article can merge as a draft. See
82+
[submitting articles to Kubernetes blogs](/docs/contribute/blog/submission/) for what the authors
83+
need to do.
84+
85+
Use GitHub suggestions to point out any required changes.
86+
87+
Once the Markdown and other content (such as images) look right, you provide a
88+
formal [review](#pull-request-review).
89+
{{% /tab %}}
90+
{{< /tabs >}}
91+
92+
93+
## Pull request review
94+
95+
Follow the [blog](/docs/contribute/review/reviewing-prs/#blog) section of _Reviewing pull requests_.
96+
97+
When you think that the open blog pull request is good enough to merge, add the `/lgtm` comment to the pull request.
98+
99+
This indicates to the repository automation tooling (Prow) that the content "looks good to me". Prow moves things forward. The `/lgtm` command lets you add your opinion to the record whether or not you are formally a member of the Kubernetes project.
100+
101+
Either you or the article author(s) should let the blog team know that there is an article
102+
ready for signoff. It should already be marked as `draft: true` in the front matter, as
103+
explained in the submission guidance.
104+
105+
## Subsequent steps
106+
107+
For you as a writing buddy, **there is no step four**. Once the pull request is good to merge,
108+
the blog team (or, for the contributor site, the contributor comms team) take things from there.
109+
It's possible that you'll need to return to an earlier step based on feedback, but you can usually expect that your work as a buddy is done.

0 commit comments

Comments
 (0)