Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide to blog contributions #50092

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Mar 14, 2025

Add a dedicated section about contributing to the Kubernetes official blogs.

preview

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 14, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from sftim. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Mar 14, 2025
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 14, 2025
@sftim sftim requested review from Copilot and removed request for salaxander and natalisucks March 14, 2025 11:37
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 14, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a dedicated guide for contributing to Kubernetes blogs. It introduces new pages for blog guidelines, mirroring, post‐release communications, and article submissions, while also updating related indices and review guidelines to better support blog contributions.

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
content/en/docs/contribute/blog/guidelines.md New blog guidelines document covering original content, blog scheduling, and technical details.
content/en/docs/contribute/blog/_index.md New index page for blog contributions with an overview of official blogs.
content/en/docs/contribute/blog/mirroring.md New instructions on mirroring blog articles.
content/en/docs/contribute/blog/release-comms.md New guide for post-release communications and related procedures.
content/en/docs/contribute/blog/submission.md New comprehensive instructions for submitting blog articles.
content/en/docs/contribute/new-content/case-studies.md New page for case studies submissions with a minor typo in the link title.
content/en/docs/contribute/review/reviewing-prs.md Updated review guidelines for blog-related contributions.
content/en/docs/contribute/new-content/_index.md Updated index content with additional links to blog articles and case studies.
content/en/docs/contribute/new-content/new-features.md Added a reference to the post-release communications guide in the context of new features.
content/en/docs/contribute/review/for-approvers.md Minor wording improvements regarding closing stale blog-related issues.
content/en/docs/contribute/suggesting-improvements.md Adjusted weight value to better reflect this page’s importance.
content/en/docs/contribute/_index.md Modified text to reference "blogs" instead of a singular "blog" for clarity.
content/en/docs/contribute/new-content/blogs-case-studies.md Removed obsolete content that is now covered by updated guidelines.

Copy link

netlify bot commented Mar 14, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit aa361dd
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67e3f79b5792df0007a57cbd
😎 Deploy Preview https://deploy-preview-50092--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sftim sftim force-pushed the 20250313_blog_contribution branch from 0bbfc1c to c07ae08 Compare March 14, 2025 11:54
@sftim sftim marked this pull request as ready for review March 14, 2025 11:55
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 14, 2025
@sftim sftim requested a review from natalisucks March 14, 2025 11:56
@sftim sftim force-pushed the 20250313_blog_contribution branch from c07ae08 to d80c737 Compare March 14, 2025 12:15
Copy link
Member

@rytswd rytswd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't gone through all the notes yet, but just leaving a few things I noticed! 🙏

Comment on lines 57 to 59
We only mark blog articles as maintained (`evergreen: true` in front matter) if the Kubernetes project
is happy to commit to maintaining them indefinitely. Some blog articles absolutely merit this; for example, the release comms team always marks official release announcements as evergreen.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We only mark blog articles as maintained (`evergreen: true` in front matter) if the Kubernetes project
is happy to commit to maintaining them indefinitely. Some blog articles absolutely merit this; for example, the release comms team always marks official release announcements as evergreen.
We only mark blog articles as maintained (`evergreen: true` in front matter) if the Kubernetes project
is happy to commit to maintaining them indefinitely. Some blog articles absolutely merit this; for example, the Release Comms team always marks official release announcements as evergreen.

I'm not sure when you'd mark blogs as evergreen other than Comms use cases. I suppose it's rather rare, and possibly we could highlight that this is usually not the case for most blogs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer not to highlight this @rytswd as we have had instances in the past where evergreen blogs (the Katacoda removal comes to mind, and the dockershim deprecation) are indeed needed, alongside the frequency of release announcements. I see this kind of inclusion as a good case of us being thorough about any possible review, including for release blogs

Articles must contain content that applies broadly to the Kubernetes community. For example, a
submission should focus on upstream Kubernetes as opposed to vendor-specific configurations.
Hyperlinks in articles should primarily be to the official Kubernetes documentation. When using external
references, links should be diverse - For example a submission shouldn't contain only links
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
references, links should be diverse - For example a submission shouldn't contain only links
references, links should be diverse. For example, a submission shouldn't contain only links

Comment on lines 36 to 38
Sometimes this is a delicate balance. You can ask in Slack ([#sig-docs-blog](https://kubernetes.slack.com/archives/CJDHVD54J))
for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog -
don't hesitate to reach out
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Sometimes this is a delicate balance. You can ask in Slack ([#sig-docs-blog](https://kubernetes.slack.com/archives/CJDHVD54J))
for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog -
don't hesitate to reach out
Sometimes this is a delicate balance. You can ask in Slack ([#sig-docs-blog](https://kubernetes.slack.com/archives/CJDHVD54J))
for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog.
If in doubt, do not hesitate to reach out!

for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog -
don't hesitate to reach out

The [content guide](/docs/contribute/style/content-guide/) applies unconditionally to blog articles
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because there are "Blog content guidance" and "Documentation content guide", it may be better to clarify which one this is about? Also, it may be good to keep the wording consistent, and stick to either "guide" or "guidance"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some changes. However, I actually think we'd be better off renaming https://kubernetes.io/docs/contribute/style/content-guide/ and calling it a content policy.


## Article scheduling

The usual process for submitting a blog article is to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting an unfinished sentence here

Copy link
Contributor

@natalisucks natalisucks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting this together Tim from our continued blog team conversations – I've done an initial review of the content, but altogether this looks great for our current state.


### Examples of content that wouldn't be accepted {#what-we-do-not-publish}

However, the project usually doesn't publish:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
However, the project usually doesn't publish:
However, the project will not publish:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sftim the below bullet points don't begin capitalized, whereas the above bullets do – can your next push please address this inconsistency? thanks!

@sftim
Copy link
Contributor Author

sftim commented Mar 15, 2025

I think merging this makes the site overall better (as it stands today), but I intend to polish and squash this PR when I get time.

Copy link
Contributor

@graz-dev graz-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sftim that looks great!
It makes the whole process much more clear to the first comers!
I just left some comments/suggestion to fix typos or enhance clarity.

Most of the blog's content is about things happening in the core project, but Kubernetes
as a project encourages you to submit about things happening elsewhere in the ecosystem too!

Anyone can write a blog post and submit it for publication.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Anyone can write a blog post and submit it for publication.
Anyone can [write a blog post and submit it](/docs/contribute/blog/submission) for publication.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to link to this here, but I appreciate the suggestion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(it forces people to read on, and that's actually the outcome we want)


## Article updates and maintenance {#maintenance}

The Kubernetes project does not maintain older articles. This means that any published article more than one
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that valid on both contributor site and main blog?
If yes probably is worth specifying.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I replied to a similar comment: I'd rather not.

* [Kubernetes blog](/blog/)
* [Kubernetes contributor blog](https://k8s.dev/blog/)

* Read about [reviewing blog pull requests](/docs/contribute/review/reviewing-prs/#blog)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This guide is valid for both contributor site and main blog?
Maybe is woth specifying.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really want to put "this is valid for all the blogs" everywhere; I kind of hope it can be implicit.

Cloud Native Computing Foundation (so that the Kubernetes project can legally publish it).

The website is localized into many languages; English is the “upstream” for all the other
localizations. Even if you yourself speak another language and would be happy to provide a localization,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
localizations. Even if you yourself speak another language and would be happy to provide a localization,
localizations. Even if you speak another language and would be happy to provide a localization,

for articles that are about the contributor community, or a part of it, but are also relevant
to the wider set of readers for Kubernetes' main blog.

As an author (or reviewer), consider the target audience and whether the blog post is appropriate for the main kubernetes.io blog.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As an author (or reviewer), consider the target audience and whether the blog post is appropriate for the main kubernetes.io blog.
As an author (or reviewer), consider the target audience and whether the blog post is appropriate for the main Kubernetes blog.

to the wider set of readers for Kubernetes' main blog.

As an author (or reviewer), consider the target audience and whether the blog post is appropriate for the main kubernetes.io blog.
For example: if the target audience are Kubernetes contributors only, then kubernetes.dev
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example: if the target audience are Kubernetes contributors only, then kubernetes.dev
For example: if the target audience are Kubernetes contributors only, then the contributor site

## Authoring an article {#authoring}

After you've pitched, we'll encourage you to use either HackMD (a web Markdown editor) or a
Google doc, to share an editable version of the article text. Your writing buddy can critique
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Google doc, to share an editable version of the article text. Your writing buddy can critique
Google doc, to share an editable version of the article text. Your writing buddy can review

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to avoid the word "review" as people might confuse this with pull request review.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then we could use something like "leave comments/feedback."
"Critique" might sound too harsh.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do, good idea.

If you choose to use Google Docs, you can set your document into Markdown mode.
{{< /note >}}

Your writing buddy can critique your text and let you know if it's not in line with the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Your writing buddy can critique your text and let you know if it's not in line with the
Your writing buddy can review your text and let you know if it's not in line with the

@sftim sftim force-pushed the 20250313_blog_contribution branch 2 times, most recently from cc69f1d to ad0820a Compare March 16, 2025 23:55
@natalisucks
Copy link
Contributor

natalisucks commented Mar 17, 2025

@sftim I agree with your prior comment and am happy to provide another review once you squash and polish so that we can have these changes merged. Thanks again for putting this together!

@sftim sftim force-pushed the 20250313_blog_contribution branch from ad0820a to 53eff63 Compare March 17, 2025 17:54
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 17, 2025
@sftim sftim force-pushed the 20250313_blog_contribution branch from 53eff63 to 443198e Compare March 17, 2025 17:56
@sftim
Copy link
Contributor Author

sftim commented Mar 17, 2025

I'd intended to write about being a writing buddy. Added, hyperlinked, committed, pushed.

@graz-dev
Copy link
Contributor

@sftim it might be a good idea to update the SiG-Docs Blog subproject README (https://github.com/kubernetes/community/blob/master/sig-docs/blog-subproject/README.md) adding the distinction between main and maintainer blog, reviewing the existing sections (submit, review and mainenance) to add new details and link to the new pages that will be published after this PR is closed.

What do you think?

@natalisucks
Copy link
Contributor

@graz-dev I would prefer to hold off on updating the README particularly regarding the maintainer/main blog distinctions, as we're currently in the processes of discussing with ContribEx the idea of merging the two blogs together, and this guide is hoping to serve the purpose of recruiting more reviewers to a combined blog team (alongside the improvements to contributing blogs itself)

@graz-dev
Copy link
Contributor

@graz-dev I would prefer to hold off on updating the README particularly regarding the maintainer/main blog distinctions, as we're currently in the processes of discussing with ContribEx the idea of merging the two blogs together, and this guide is hoping to serve the purpose of recruiting more reviewers to a combined blog team (alongside the improvements to contributing blogs itself)

@natalisucks ack!
It was just to keep the things aligned, but maybe it's better to wait the decision about the future of the two blogs.

@sftim
Copy link
Contributor Author

sftim commented Mar 17, 2025

/hold

This tries not to make too much change, but at the same time it's size/xxl now and is documenting a policy that's clearly different from what is written down today.

OK to unhold when there is consensus (or lazy consensus) that we should do that.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 17, 2025
@sftim
Copy link
Contributor Author

sftim commented Mar 17, 2025

There's a lot of support for one team; what we do about the two separate index pages isn't yet settled.

@sftim sftim force-pushed the 20250313_blog_contribution branch 2 times, most recently from f125b55 to f8ec0ae Compare March 17, 2025 21:53
@natalisucks
Copy link
Contributor

with my SIG Docs co-chair hat on, I support these changes. would love to hear from @divya-mohan0209 @reylejano @katcosgrove @salaxander and @tengqm so we can get leadership consensus.

Copy link
Contributor

@divya-mohan0209 divya-mohan0209 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have glanced over most of this PR & will provide a full-fledged review over the weekend. However, overall, this is the direction I'd like to see us head in.
LGTM!

Copy link
Contributor

@fsmunoz fsmunoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments, mostly focused on the k8s.dev -> website cases.

<!-- overview -->

There are two official Kubernetes blogs, and the CNCF has its own blog where you can cover Kubernetes too.
Read [contributing to Kubernetes blogs](/docs/contribute/blog/) to learn about these two blogs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a different take on this (although similar in spirit) on Contributor Comms, as part of the shadowing programme. Would this be on top of that, or something we should harmonise?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand how I'd change this paragraph to reflect that SIG ContribEx Comms has a shadowing programme. What did you have in mind?

to [SIG ContribEx comms](https://kubernetes.slack.com/archives/C03KT3SUJ20).
<!-- FIXME: or using this [form] -->

Unless there's a problem with your submission, the blog team / SIG ContribEx will pair you up with:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a a similar walk-through of the process here, when this is merged I will open a PR to update it, referencing this one and focusing on the things that are specific to spotlights.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eventually, I'd like to have one unified process that both teams jointly own and jointly follow.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, that was the gist of what I said as well, remove things that will be a part of that unified process and only keep the ones that are specific about the Spotlight content. I'll open an issue on this to track it myself.

It is OK to use an empty `alt` attribute if accessibility software should not mention the
image at all, but this is a rare situation.

#### Commit messages
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add something about squashing as a best-practice? I can add a simple paragraph on it, including a link to to how to do it using git and prow, but wanted to have your take on it first.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added (see line 228, at time of writing).

@@ -165,56 +167,33 @@ When reviewing, use the following as a starting point.

### Blog

- 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).
- Before reviewing blog PRs, be familiar with [Submitting blog posts and case studies](/docs/contribute/new-content/blogs-case-studies/).
- We are willing to mirror any blog article that was published to https://kubernetes.dev/blog/ (the contributor blog) provided that:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add the approach that we've been informally using, namely that reviews should be done in the "original" repository to avoid duplicate (and potentially conflicting) reviews. Does this make sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes with a caveat - ideally those happen at HackMD / Google Docs stage.
Would you be willing to write a suggestion on the change to make?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am, will submit one shortly.

@sftim sftim force-pushed the 20250313_blog_contribution branch from f8ec0ae to cf87d35 Compare March 20, 2025 14:58
@sftim sftim force-pushed the 20250313_blog_contribution branch from b1f1ab2 to d8ea467 Compare March 22, 2025 13:27
Copy link
Contributor

@shannonxtreme shannonxtreme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall a good improvement to the guidelines. Some comments around clarity, duplication, and readability (and some nits). I didn't review all of the files (in the new section, I haven't looked at release-comms and submission)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope: For some reason, the title doesn't show up on this page like it does on other pages. It's like this in the live version as well


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

If you specifically want to learn about contributing to _this_ documentation, read
If you specifically want to learn about contributing to _this_ website, read
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"website" encompasses the kubernetes blog as well, right? maybe, since we're linking to the docs contribution section, say "If you want to learn how to contribute to the Kubernetes documentation on this site, see blah"?

Comment on lines +11 to +16
There are two official Kubernetes blogs, and the CNCF has [its own blog](https://www.cncf.io/blog/) where you can cover Kubernetes too.
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.

With only a few special case exceptions, we only publish content that hasn't been submitted or published anywhere else.

Read the [blog guidelines](/docs/contribute/blog/guidelines/#what-we-publish) for more about that aspect.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
There are two official Kubernetes blogs, and the CNCF has [its own blog](https://www.cncf.io/blog/) where you can cover Kubernetes too.
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.
With only a few special case exceptions, we only publish content that hasn't been submitted or published anywhere else.
Read the [blog guidelines](/docs/contribute/blog/guidelines/#what-we-publish) for more about that aspect.
This page describes the official Kubernetes blogs, including what each blog covers, how the project maintains published content, and how to contribute to the blogs. This page doesn't describe the
[CNCF blog]((https://www.cncf.io/blog/) , where you can also cover Kubernetes.

This page's intro should ideally introduce the reader to what the page covers. Move the info about what we publish in the main blog to that section below.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the main blog section says it in a different way already, so no need to move it down there

Comment on lines 13 to 15
If you are not already familiar, you should read up on the differences between the
[main blog](/docs/contribute/blog/#main-blog) and the
[contributor blog](/docs/contribute/blog/#contributor-blog).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use one link to this destination.

[main blog](/docs/contribute/blog/#main-blog) and the
[contributor blog](/docs/contribute/blog/#contributor-blog).

Some articles appear on both blogs: there is a primary version of the article, and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add some information in brief about the point of the current page, like "This page describes the criteria for mirroring and how to mirror an article that you're drafting"

For example: if the target audience are Kubernetes contributors only, then the
[contributor blog](/docs/contribute/blog/#contributor-blog).
may be more appropriate;
if the blog post is about open source in general then it may be more suitable on another site outside the Kubernetes project.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be too much detail. Consider just telling the reader to ensure that their content is appropriate for our blogs and is being added to the most relevant of the two blogs. Then, link to the "What we publish" section in the blog guidelines for more details.

This consideration about target audience applies to original and mirrored articles equally.

The Kubernetes project is willing to mirror any blog article that was published to https://kubernetes.dev/blog/
(the contributor blog), provided that:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

provided that (all of the | any of the) following criteria apply:

@sftim sftim force-pushed the 20250313_blog_contribution branch 2 times, most recently from 880b526 to 40e9b69 Compare March 24, 2025 22:03
@sftim
Copy link
Contributor Author

sftim commented Mar 24, 2025

I propose dropping the lazy consensus hold after KubeCon EU 2025.

Add a dedicated section about contributing to the Kubernetes official
blogs.

Co-authored-by: Graziano Casto <[email protected]>
Co-authored-by: Natali Vlatko <[email protected]>
Co-authored-by: Ryota <[email protected]>
Co-authored-by: Shannon Kularathna <[email protected]>
@sftim sftim force-pushed the 20250313_blog_contribution branch from 40e9b69 to aa361dd Compare March 26, 2025 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants