-
Notifications
You must be signed in to change notification settings - Fork 15.1k
Add guide to blog contributions #50092
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,66 @@ | ||||||||||||||||||
| --- | ||||||||||||||||||
| title: Contributing to Kubernetes blogs | ||||||||||||||||||
| slug: blog-contribution | ||||||||||||||||||
| content_type: concept | ||||||||||||||||||
| weight: 15 | ||||||||||||||||||
| simple_list: true | ||||||||||||||||||
| --- | ||||||||||||||||||
|
|
||||||||||||||||||
| <!-- overview --> | ||||||||||||||||||
|
|
||||||||||||||||||
| 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. | ||||||||||||||||||
|
Comment on lines
+11
to
+16
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
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.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
||||||||||||||||||
|
|
||||||||||||||||||
| ## Official Kubernetes blogs | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Main blog | ||||||||||||||||||
|
|
||||||||||||||||||
| The main [Kubernetes blog](/blog/) is used by the project to communicate new features, community reports, and any | ||||||||||||||||||
| news that might be relevant to the Kubernetes community. This includes end users and developers. | ||||||||||||||||||
| 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. With only a few special case exceptions, we only publish content that hasn't been submitted or published anywhere else. | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Contributor blog | ||||||||||||||||||
|
|
||||||||||||||||||
| The [Kubernetes contributor blog](https://k8s.dev/blog/) is aimed at an audience of people who | ||||||||||||||||||
| work **on** Kubernetes more than people who work **with** Kubernetes. The Kubernetes project | ||||||||||||||||||
| deliberately publishes some articles to both blogs. | ||||||||||||||||||
|
|
||||||||||||||||||
| Anyone can write a blog post and submit it for review. | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since this is true for both blogs, consider adding this type of common info to the parent section "Official Kubernetes blogs". Something like: "The following sections describe the official Kubernetes blogs and the type of content that each blog covers. Anyone can write a blog post and submit it for review. With only a few special case exceptions, we only publish content that hasn't been submitted or published anywhere else." |
||||||||||||||||||
|
|
||||||||||||||||||
| ## Article updates and maintenance {#maintenance} | ||||||||||||||||||
|
|
||||||||||||||||||
| The Kubernetes project does not maintain older articles for its blogs. This means that any | ||||||||||||||||||
| published article more than one year old will normally **not** be eligible for issues or pull | ||||||||||||||||||
| requests that ask for changes. To avoid establishing precedent, even technically correct pull | ||||||||||||||||||
| requests are likely to be rejected. | ||||||||||||||||||
|
|
||||||||||||||||||
| However, there are exceptions like the following: | ||||||||||||||||||
|
|
||||||||||||||||||
| * (updates to) articles marked as [evergreen](#maintenance-evergreen) | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: capitalize the first letter of each list item |
||||||||||||||||||
| * removing or correcting articles giving advice that is now wrong and dangerous to follow | ||||||||||||||||||
| * fixes to ensure that an existing article still renders correctly | ||||||||||||||||||
|
|
||||||||||||||||||
| For any article that is over a year old and not marked as _evergreen_, the website automatically | ||||||||||||||||||
| displays a notice that the content may be stale. | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Evergreen articles {#maintenance-evergreen} | ||||||||||||||||||
|
|
||||||||||||||||||
| You can mark an article as evergreen by setting `evergreen: true` in the front matter. | ||||||||||||||||||
|
|
||||||||||||||||||
| We only mark blog articles as maintained (`evergreen: true` in front matter) if the Kubernetes project | ||||||||||||||||||
| 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. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## {{% heading "whatsnext" %}} | ||||||||||||||||||
|
|
||||||||||||||||||
| * Discover the official blogs: | ||||||||||||||||||
| * [Kubernetes blog](/blog/) | ||||||||||||||||||
| * [Kubernetes contributor blog](https://k8s.dev/blog/) | ||||||||||||||||||
|
|
||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A link to what we publish might be good here |
||||||||||||||||||
| * Read about [reviewing blog pull requests](/docs/contribute/review/reviewing-prs/#blog) | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This guide is valid for both contributor site and main blog?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,109 @@ | ||||||||
| --- | ||||||||
| title: Helping as a blog writing buddy | ||||||||
| slug: writing-buddy | ||||||||
| content_type: concept | ||||||||
| weight: 70 | ||||||||
| --- | ||||||||
|
|
||||||||
| <!-- 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. | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was thinking that if the reviews are done by a single team, then it doesn't make a lot of sense to keep as Comms-specific programme that to a large extend is also based on similar principles. Picking up Spotlights as an example, we have a similar approach to help authors get started, part of the shadowing aspect is helping in the same sort of thing. I think that the answer to this is similar to other changes that need to be made: keep the Comms-specific aspects and remove things that are a repetition or even conflicting.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If the text is:
then I don't see a Contributor Comms reference to remove.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, not here. By harmonising I meant changing the Comms content to be aligned. I'll include that in the |
||||||||
|
|
||||||||
| When people contributor to either blog as an author, the Kubernetes project pairs up authors | ||||||||
| as _writing buddies_. This page explains how to fulfil the buddy role. | ||||||||
|
|
||||||||
| You should make sure that you have at least read an outline of [article submission](/docs/contribute/blog/submission/) | ||||||||
| before you read on within this page. | ||||||||
|
Comment on lines
+16
to
+17
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure this suggestion makes sense if I accept it. |
||||||||
|
|
||||||||
| <!-- body --> | ||||||||
|
|
||||||||
| ## Buddy responsibilities | ||||||||
|
|
||||||||
| As a writing buddy, you: | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggest avoiding letting the intro sentence run into the list items
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What's the thinking behind that feedback? It makes sense to me as-is, but I did write it so am not going to be a good judge. |
||||||||
|
|
||||||||
| * help the blog team get articles ready to merge and to publish | ||||||||
| * support your buddy to produce content that is good to merge | ||||||||
| * provide a review on the article that your buddy has written | ||||||||
|
|
||||||||
|
|
||||||||
| When the team pairs you up with another author, the idea is that you both support each other by | ||||||||
| reviewing the other author's draft article. | ||||||||
| Most people reading articles on the Kubernetes blog are not experts; the content should | ||||||||
| try to make sense for that audience, or at least to support non-expert readers appropriately. | ||||||||
|
|
||||||||
| The blog team are also there to help you both along the journey from draft to publication. | ||||||||
| They will either be directly able to approve your article for publication, or can arrange for | ||||||||
| the approval to happen. | ||||||||
|
|
||||||||
| ## Supporting the blog team | ||||||||
|
|
||||||||
| Your main responsibility here is to communicate about your capacity, availability and progress | ||||||||
| in a reasonable timeline. If many weeks go by and your buddy hasn't heard from you, it makes | ||||||||
| the overall work take more time. | ||||||||
|
|
||||||||
| ## Supporting your buddy | ||||||||
|
|
||||||||
| There are two parts to the process | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's not quite right; it makes it sound as if these two choices are all you need to make, when actually the process continues past the tabs. |
||||||||
|
|
||||||||
| {{< tabs name="buddy_support" >}} | ||||||||
| {{% tab name="Collaborative editing" %}} | ||||||||
| **(This is the recommended option)** | ||||||||
|
|
||||||||
| The blog team recommend that the main author for the article sets up collaborative editing | ||||||||
| using either a Google Doc or HackMD (their choice). The main author then shares that document | ||||||||
| with the following people: | ||||||||
|
|
||||||||
| * Any co-authors | ||||||||
| * You (their writing buddy) | ||||||||
| * Ideally, with a nominated | ||||||||
| person from the blog team. | ||||||||
|
|
||||||||
| As a writing buddy, you then read the draft text and either directly make suggestions or provide | ||||||||
| feedback in a different way. The author of the blog is very commonly also **your** writing buddy in turn, so they will provide the | ||||||||
| same kind of feedback on the draft for your blog article. | ||||||||
|
|
||||||||
| Your role here is to recommend the smallest set of changes that will get the article look good | ||||||||
| for publication. If there's a diagram that really doesn't make sense, or the writing is really | ||||||||
| unclear: provide feedback. If you have a slight different of opinion about wording or punctuation, | ||||||||
| skip it. Let the article author(s) write in their own style, provided that they align to | ||||||||
| the [blog guidelines](/docs/contribute/blog/guidelines/). | ||||||||
|
|
||||||||
| After this is ready, the lead author will open a pull request and use Markdown to submit the | ||||||||
| article. You then provide a [review](#pull-request-review). | ||||||||
| {{% /tab %}} | ||||||||
| {{% tab name="Markdown / Git editing" %}} | ||||||||
| Some authors prefer to start with | ||||||||
| [collaborative editing](#buddy-support-0); others like to go straight into | ||||||||
| GitHub. | ||||||||
|
|
||||||||
| Whichever route they take, your role is to provide feedback that lets the blog team provide | ||||||||
| a simple signoff and confirm that the article can merge as a draft. See | ||||||||
| [submitting articles to Kubernetes blogs](/docs/contribute/blog/submission/) for what the authors | ||||||||
| need to do. | ||||||||
|
|
||||||||
| Use GitHub suggestions to point out any required changes. | ||||||||
|
|
||||||||
| Once the Markdown and other content (such as images) look right, you provide a | ||||||||
| formal [review](#pull-request-review). | ||||||||
| {{% /tab %}} | ||||||||
| {{< /tabs >}} | ||||||||
|
|
||||||||
|
|
||||||||
| ## Pull request review | ||||||||
|
|
||||||||
| Follow the [blog](/docs/contribute/review/reviewing-prs/#blog) section of _Reviewing pull requests_. | ||||||||
|
|
||||||||
| When you think that the open blog pull request is good enough to merge, add the `/lgtm` comment to the pull request. | ||||||||
|
|
||||||||
| 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. | ||||||||
|
|
||||||||
| Either you or the article author(s) should let the blog team know that there is an article | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. how? |
||||||||
| ready for signoff. It should already be marked as `draft: true` in the front matter, as | ||||||||
| explained in the submission guidance. | ||||||||
|
|
||||||||
| ## Subsequent steps | ||||||||
|
|
||||||||
| For you as a writing buddy, **there is no step four**. Once the pull request is good to merge, | ||||||||
| the blog team (or, for the contributor site, the contributor comms team) take things from there. | ||||||||
| 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. | ||||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,169 @@ | ||||||||||
| --- | ||||||||||
| title: Blog guidelines | ||||||||||
| content_type: concept | ||||||||||
| weight: 40 | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| <!-- overview --> | ||||||||||
|
|
||||||||||
| These guidelines cover the main Kubernetes blog and the Kubernetes | ||||||||||
| contributor blog. | ||||||||||
|
|
||||||||||
| All blog content must also adhere to the overall policy in the | ||||||||||
| [content guide](/docs/contribute/style/content-guide/). | ||||||||||
|
|
||||||||||
| # {{% heading "prerequisites" %}} | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there a mistake here, or is the single |
||||||||||
|
|
||||||||||
| Make sure you are familiar with the introduction sections of | ||||||||||
| [contributing to Kubernetes blogs](/docs/contribute/blog/), not just to learn about | ||||||||||
| the two official blogs and the differences between them, but also to get an overview | ||||||||||
| of the process. | ||||||||||
|
|
||||||||||
| ## Original content | ||||||||||
|
|
||||||||||
| The Kubernetes project accepts **original content only**, in English. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we trying to convey that localized blogs don't need to be original content?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No; the point I want to make is that PRs to add a new article must be in English to be accepted. |
||||||||||
|
|
||||||||||
| {{< note >}} | ||||||||||
| The Kubernetes project cannot accept content for the blog if it has already been submitted | ||||||||||
| or published outside of the Kubernetes project. | ||||||||||
|
|
||||||||||
| The official blogs are not available as a medium to repurpose existing content from any third | ||||||||||
| party as new content. | ||||||||||
| {{< /note >}} | ||||||||||
|
|
||||||||||
| This restriction even carries across to promoting other Linux Foundation and CNCF projects. | ||||||||||
| Many CNCF projects have their own blog. These are often a better choice for posts about a specific | ||||||||||
| project, even if that other project is designed specifically to work with Kubernetes (or with Linux, | ||||||||||
| etc). | ||||||||||
|
|
||||||||||
| ## Relevant content | ||||||||||
|
|
||||||||||
| 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. | ||||||||||
| For articles submitted to the main blog that are not | ||||||||||
| [mirror articles](/docs/contribute/blog/mirroring/), hyperlinks in the article should commonly | ||||||||||
| be to the official Kubernetes documentation. When making external references, links should be | ||||||||||
| diverse - for example, a submission shouldn't contain only links back to a single company's blog. | ||||||||||
|
|
||||||||||
| The official Kubernetes blogs are **not** the place for vendor pitches or for articles that promote | ||||||||||
| a specific solution from outside Kubernetes. | ||||||||||
|
|
||||||||||
| 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. | ||||||||||
|
|
||||||||||
| The [content guide](/docs/contribute/style/content-guide/) applies unconditionally to blog articles | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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"?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||||||||||
| and the PRs that add them. Bear in mind that some restrictions in the guide state that they are only relevant to documentation; those marked restrictions don't apply to blog articles. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The content guide that's linked here doesn't clearly mark what's docs only and what applies to other content as well |
||||||||||
|
|
||||||||||
| ## Localization | ||||||||||
|
|
||||||||||
| The website is localized into many languages; English is the “upstream” for all the other | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| localizations. Even if you speak another language and would be happy to provide a localization, | ||||||||||
| that should be in a separate pull request (see [languages per PR](/docs/contribute/new-content/#languages-per-pr)). | ||||||||||
|
Comment on lines
+61
to
+62
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Copyright and reuse | ||||||||||
|
|
||||||||||
| You must write [original content](#original-content) and you must have permission to license | ||||||||||
| that content to the Cloud Native Computing Foundation (so that the Kubernetes project can | ||||||||||
| legally publish it). | ||||||||||
| This means that not only is direct plagiarism forbidden, you cannot write a blog article if | ||||||||||
| you don't have permission to meet the CNCF copyright license conditions (for example, if your | ||||||||||
| employer has a policy about intellectual property that restricts what you are allowed to do). | ||||||||||
|
|
||||||||||
| The [license](https://github.com/kubernetes/website/blob/main/LICENSE) for the blog allows | ||||||||||
| commercial use of the content for commercial purposes, but not the other way around. | ||||||||||
|
|
||||||||||
| ## Special interest groups and working groups | ||||||||||
|
|
||||||||||
| Topics related to participation in or results of Kubernetes SIG activities are always on | ||||||||||
| topic (see the work in the [Contributor Comms Team](https://github.com/kubernetes/community/blob/master/communication/contributor-comms/blogging-resources/blog-guidelines.md#contributor-comms-blog-guidelines) | ||||||||||
| for support on these posts). | ||||||||||
|
Comment on lines
+78
to
+80
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure what the guideline is here. I think that we're telling the reader to keep articles about SIG participation or SIG work focused on that topic? The linked file doesn't seem to expand on it. |
||||||||||
|
|
||||||||||
| The project typically [mirrors](/docs/contribute/blog/mirroring/) these articles to both blogs. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since the author needs to add a PR to mirror the article before their canonical post merges, consider rewording as follows:
Suggested change
|
||||||||||
|
|
||||||||||
|
|
||||||||||
| ## National restrictions on content | ||||||||||
|
|
||||||||||
| The Kubernetes website has an Internet Content Provider (ICP) licence from the government of China. Although it's unlikely to be a problem, Kubernetes cannot publish articles that would be blocked by the Chinese government's official filtering of internet content. | ||||||||||
|
|
||||||||||
| ## Blog-specific content guidance {#what-we-publish} | ||||||||||
|
|
||||||||||
| As well as the general [style guide](/docs/contribute/style/style-guide/), blog articles should (not must) align to | ||||||||||
| the [blog-specific style recommendations](/docs/contribute/blog/article-submission/#article-content). | ||||||||||
|
|
||||||||||
| The remainder of this page is additional guidance; these are not strict rules that articles | ||||||||||
| must follow, but reviewers are likely to (and should) ask for edits to articles that are | ||||||||||
| obviously not aligned with the recommendations here. | ||||||||||
|
|
||||||||||
| ### Diagrams and illustrations {#illustrations} | ||||||||||
|
|
||||||||||
| For [illustrations](/docs/contribute/blog/article-submission/#illustrations) - including diagrams or charts - use the [figure shortcode](https://gohugo.io/content-management/shortcodes/#figure) | ||||||||||
| where feasible. You should set an `alt` attribute for accessibility. | ||||||||||
|
|
||||||||||
| Use vector images for illustrations, technical diagrams and similar graphics; SVG format is recommended as a strong preference. | ||||||||||
|
|
||||||||||
| Articles that use raster images for illustrations are more difficult to maintain and in some | ||||||||||
| cases the blog team may ask authors to revise the article before it could be published. | ||||||||||
|
Comment on lines
+100
to
+106
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think that this entire section can stay in the other page, since it's part of "blog-specific content guidance" |
||||||||||
|
|
||||||||||
| ### Timelessness | ||||||||||
|
|
||||||||||
| Blog posts should aim to be future proof | ||||||||||
|
|
||||||||||
| - Given the development velocity of the project, SIG Docs prefers _timeless_ writing: content that | ||||||||||
| won't require updates to stay accurate for the reader. | ||||||||||
| - It can be a better choice to add a tutorial or update official documentation than to write a | ||||||||||
| high level overview as a blog post. | ||||||||||
| - Consider concentrating the long technical content as a call to action of the blog post, and | ||||||||||
| focus on the problem space or why readers should care. | ||||||||||
|
Comment on lines
+116
to
+117
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What does this mean to an author? I read it as "don't write the long tech content in the post, link to it as a call to action" but it could also mean "don't make the implementation details the primary focus of the article" |
||||||||||
|
|
||||||||||
|
|
||||||||||
| ### Content examples | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider a more descriptive heading, like "Examples of appropriate content" |
||||||||||
|
|
||||||||||
| Here are some examples of content that is appropriate for the | ||||||||||
| [main Kubernetes blog](/docs/contribute/blog/#main-blog): | ||||||||||
|
|
||||||||||
| * Announcements about new Kubernetes capabilities | ||||||||||
| * Explanations of how to achieve an outcome using Kubernetes; for example, tell us about your | ||||||||||
| low-toil improvement on the basic idea of a rolling deploy | ||||||||||
| * Comparisons of several different software options that have a link to Kubernetes and cloud native. It's | ||||||||||
| OK to have a link to one of these options so long as you fully disclose your conflict of | ||||||||||
| interest / relationship. | ||||||||||
| * Stories about problems or incidents, and how you resolved them | ||||||||||
| * Articles discussing building a cloud native platform for specific use cases | ||||||||||
| * Your opinion about the good or bad points about Kubernetes | ||||||||||
| * Announcements and stories about non-core Kubernetes, such as the Gateway API | ||||||||||
| * [Post-release announcements and updates](#post-release-comms) | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The link is not reaching the intended target. |
||||||||||
| * Messages about important Kubernetes security vulnerabilities | ||||||||||
| * Kubernetes projects updates | ||||||||||
| * Tutorials and walkthroughs | ||||||||||
| * Thought leadership around Kubernetes and cloud native | ||||||||||
| * The components of Kubernetes are purposely modular, so writing about existing integration | ||||||||||
| points like CNI and CSI are on topic. Provided you don't write a vendor pitch, you can also write | ||||||||||
| about what is on the other end of these integrations. | ||||||||||
|
Comment on lines
+140
to
+142
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Seems like this shouldn't be a list item (at least with its current structure) |
||||||||||
|
|
||||||||||
|
|
||||||||||
| Here are some examples of content that is appropriate for the Kubernetes | ||||||||||
| [contributor blog](/docs/contribute/blog/#contributor-blog): | ||||||||||
|
|
||||||||||
| * articles about how to test your change to Kubernetes code | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: uppercase the start of each item |
||||||||||
| * content around non-code contribution | ||||||||||
| * discussions about alpha features where the design is still under discussion | ||||||||||
| * "Meet the team" articles about working groups, special interest groups, etc. | ||||||||||
| * a guide about how to write secure code that will become part of Kubernetes itself | ||||||||||
| * articles about maintainer summits and the outcome of those summits | ||||||||||
|
|
||||||||||
| ### Examples of content that wouldn't be accepted {#what-we-do-not-publish} | ||||||||||
|
|
||||||||||
| However, the project will not publish: | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The project will not publish content like the following: |
||||||||||
|
|
||||||||||
| * vendor pitches | ||||||||||
| * an article you've published elsewhere, even if only to your own low-traffic blog | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| * large chunks of example source code with only a minimal explanation | ||||||||||
| * updates about an external project that works with our relies on Kubernetes (put those on | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| the external project's own blog) | ||||||||||
| * articles about using Kubernetes with a specific cloud provider | ||||||||||
| * articles that criticise specific people, groups of people, or businesses | ||||||||||
| * articles that have important technical mistakes or misleading details (for example: if you | ||||||||||
| recommend turning off an important security control in production clusters, because it can | ||||||||||
| be inconvenient, the Kubernetes project is likely to reject the article). | ||||||||||
|
|
||||||||||
There was a problem hiding this comment.
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