Add contribution guidelines for blog posts #7646

zacharysarah · 2018-03-05T22:55:44Z

Fixes #5823
Ref: #7247

🛑 DO NOT MERGE UNTIL #7247 MERGES 🛑

This PR adds contribution guidelines for blog posts once #7247 merges.

k8sio-netlify-preview-bot · 2018-03-05T22:57:32Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 2c081f1

https://deploy-preview-7646--kubernetes-io-master-staging.netlify.com

zacharysarah · 2018-03-05T22:58:35Z

@kbarnard10 👋 Please review this PR!

Do you want to migrate the guidelines for Kubernetes posts from the Google form? I think it would be a good idea. If you agree, please post a link to the form so I can scrape the guidelines and add them. 👍

kbarnard10 · 2018-03-06T21:04:55Z

@zacharysarah Blog form is here: https://docs.google.com/forms/d/1Uxd44-7qLrc4cQQeVu15vxN2P8H9dL9587UCCeFm1TY/edit

bradtopol · 2018-03-08T00:29:38Z

docs/home/contribute/writing-a-blog-post.md

+
+## Add images
+
+Add any image files the post contains to `/images/`. The preferred


@zacharysarah Perhaps we should recommend a naming convention for images to avoid naming conflicts? Or could they create subfolders under images to avoid this problem?

👍 to @bradtopol's suggestion - I know from reading the mega-PR that the images don't always line up, and some names will be easily/commonly re-used - so at least suggesting a naming convention and being able to link them together will be important.

Also it would be good to explain how images that are placed in /images/ should be referenced. Perhaps providing an example. Suppose your article include image1.jpg. Once you have placed the image in /images/ you can reference it as follows:

@heckj @bradtopol Good feedback--added!

heckj

please take all Q's with 🍶 - I don't know the intended audience, so I'm asking questions and making suggestions from a conservative/minimal knowledge point of view.

heckj · 2018-03-08T00:34:33Z

docs/home/contribute/writing-a-blog-post.md

+```
+For example:
+```
+2015-03-20-Welcome-to-the-Kubernetes-Blog!.md


possibly dumb question - is punctuation acceptable in these titles/names? Wasn't sure if the ! would freak out something in the toolchain or not...

The punctuation doesn't bother Jekyll but I'm happy to scrub them from the mega-pr if they might conflict with something in the wider chain

@tehut Let's scrub special characters from filenames. I don't see an immediate conflict either, but better safe than sorry. 👍

heckj · 2018-03-08T00:35:37Z

docs/home/contribute/writing-a-blog-post.md

+```
+---
+layout: blog
+title: Welcome to the Kubernetes Blog!


Another (possibly dumb) Q: Is there any requirement for the title and the filename to match?

Not at all dumb, in fact my intuition on this was all wrong. The front matter is optional and particularly helpful if you want to include non-standard characters.

jekyll/jekyll-help#124

heckj · 2018-03-08T00:37:09Z

docs/home/contribute/writing-a-blog-post.md

+---
+```
+
+## Create a new pull request (PR)


you address creating a PR before adding any content - in a logical progress, I'd think adding in the content would come first, and depending on the savvy of the bloggers, how to commit it and push it to their forked repo... I don't know the bloggers - will this be somthing they need detailed?

@heckj I wondered the same thing! I think you're right that file naming considerations are secondary to actual content.

The large majority of K8s bloggers are developers, but a link to our contrib guidelines on forking is a good idea. 👍

UPDATE: I forgot I already added one!

heckj · 2018-03-08T00:39:15Z

docs/home/contribute/writing-a-blog-post.md

+
+## Add images
+
+Add any image files the post contains to `/images/`. The preferred


👍 to @bradtopol's suggestion - I know from reading the mega-PR that the images don't always line up, and some names will be easily/commonly re-used - so at least suggesting a naming convention and being able to link them together will be important.

heckj · 2018-03-08T00:40:32Z

docs/home/contribute/writing-a-blog-post.md

+
+Add any image files the post contains to `/images/`. The preferred
+image format is SVG.
+


I think we ought to consider adding a bit of detail on how to reference an image from within Markdown with an example blog post (and the image in SVG format, since we're groovy with that). I don't know if this is obvious to the blog editors or not - so 🍶

As soon as you both reviewed this, I realized how many image1.jpg submission conflicts we'd get... 🙀

heckj · 2018-03-08T00:42:53Z

docs/home/contribute/writing-a-blog-post.md

+
+When you [create a new pull request](/docs/home/contribute/create-pull-request/), include the following in the PR description:
+
+- Desired publishing date


Is there any expectation on feedback/back and forth/etc for reviewing the blog posts and getting them published?

Is it cool to say "post this as soon as you're happy with the content", or do all posts have a pre-selected publication date and reviews need to be resolved before then?

are there different reviewers/editors for the blog section of the site, and if so - how should a contributor communicate with them (is there an @name team grouping that can be used)?

Is there any expectation on feedback/back and forth/etc for reviewing the blog posts and getting them published?

@kbarnard10 👋 How much expectation setting would you like to do here for the feedback process?

Is it cool to say "post this as soon as you're happy with the content", or do all posts have a pre-selected publication date and reviews need to be resolved before then?

Another good question for @kbarnard10. How much more would you like to say about publishing dates?

are there different reviewers/editors for the blog section of the site, and if so - how should a contributor communicate with them (is there an @name team grouping that can be used)?

There are, in #7610. Adding an alias would be a repo setting rather than a repo content setting. I've started @kubernetes/kubernetes-blog-maintainers. I'll add @kbarnard10 and @SarahKConway once they join the K8s org.

bradtopol · 2018-03-08T02:56:50Z

docs/home/contribute/writing-a-blog-post.md

+
+When you [create a new pull request](/docs/home/contribute/create-pull-request/), include the following in the PR description:
+
+- Desired publishing date


This line and the Note rendered on the same line. It looks funny/hard to read to me.

bradtopol · 2018-03-08T03:00:53Z

@zacharysarah Overall looks very good. I just made a few comments inline. Hope they help

heckj · 2018-03-12T22:49:15Z

👍 from me!

heckj · 2018-03-12T22:49:26Z

/approve

bradtopol · 2018-03-14T15:04:29Z

this looks great to me as well. So @heckj @zacharysarah if I add a /lgtm the do not merge label will still keep the PR from merging correct? Also If I have added the /lgtm and you remove the do not merge label will it automatically merge or would I need to re add a /lgtm to kick off the merging process?

heckj · 2018-03-14T15:06:37Z

@bradtopol If you added an /lgtm here, it wouldn't merge until the do-not-merge/work-in-progress label was removed. Prow reacts to any changes in comments (or labels!), so if everything was already set, just removing the label should be sufficient to kick off the automation/bot that would cause the PR to merge.

zacharysarah · 2018-03-14T20:33:36Z

@bradtopol What @heckj said. ☝️

zacharysarah · 2018-04-03T21:55:01Z

/lgtm

k8s-ci-robot · 2018-04-03T21:55:02Z

@zacharysarah: you cannot LGTM your own PR.

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

zacharysarah · 2018-04-03T21:56:44Z

@zacharysarah: you cannot LGTM your own PR.

I'm so glad to hear it! 😅 @bradtopol Would you mind checking this over again, please?

abitrolly · 2018-04-04T02:13:30Z

How about adding README.md with backlink to those docs here as well - https://github.com/kubernetes/website/tree/master/blog ?

zacharysarah · 2018-04-05T22:22:08Z

@abitrolly That's a great idea for a follow up PR.

@bradtopol Bump for review

zparnold · 2018-04-06T20:20:52Z

/lgtm

Didn't realize the server relative path for the link. Makes sense. Once merged it'll work. 😄

k8s-ci-robot · 2018-04-06T20:20:59Z

@zparnold: changing LGTM is restricted to assignees, and only kubernetes org members may be assigned issues.

In response to this:

/lgtm

Didn't realize the server relative path for the link. Makes sense. Once merged it'll work. 😄

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

heckj · 2018-04-10T21:51:25Z

/lgtm

k8s-ci-robot · 2018-04-10T21:51:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: heckj, zacharysarah, zparnold

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [heckj,zacharysarah]

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

@heckj

* Add contrib guidelines for blog posts * Add form guidelines * Add TOC entry * Renamed file * Feedback from @heckj and @bradtopol * Revised submission guidelines to include form

Add contrib guidelines for blog posts

eb234cf

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 5, 2018

k8s-ci-robot requested review from tengqm and xiangpengzhao March 5, 2018 22:55

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 5, 2018

zacharysarah self-assigned this Mar 5, 2018

Add form guidelines

7b9b18d

bradtopol reviewed Mar 8, 2018

View reviewed changes

heckj reviewed Mar 8, 2018

View reviewed changes

heckj mentioned this pull request Mar 8, 2018

Blog Migration: Continuation of WIP PR #7144 #7247

Merged

bradtopol reviewed Mar 8, 2018

View reviewed changes

zacharysarah added 2 commits March 12, 2018 13:19

Merge branch 'master' into how-to-blog

6996cdf

Add TOC entry

aae2656

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 12, 2018

zacharysarah added 2 commits March 12, 2018 13:25

Renamed file

8d5581b

Feedback from @heckj and @bradtopol

65a227d

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 12, 2018

Revised submission guidelines to include form

2c081f1

zacharysarah changed the title ~~[WIP] Add contribution guidelines for blog posts~~ Add contribution guidelines for blog posts Apr 3, 2018

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 Apr 3, 2018

k8s-ci-robot assigned heckj Apr 10, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 10, 2018

k8s-ci-robot merged commit 62229dc into kubernetes:master Apr 10, 2018


		## Add images

		Add any image files the post contains to `/images/`. The preferred


		Add any image files the post contains to `/images/`. The preferred
		image format is SVG.


		When you [create a new pull request](/docs/home/contribute/create-pull-request/), include the following in the PR description:

		- Desired publishing date

Add contribution guidelines for blog posts #7646

Add contribution guidelines for blog posts #7646

Conversation

zacharysarah commented Mar 5, 2018

k8sio-netlify-preview-bot commented Mar 5, 2018 • edited Loading

zacharysarah commented Mar 5, 2018

kbarnard10 commented Mar 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heckj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tehut Mar 9, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zacharysarah Mar 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradtopol commented Mar 8, 2018

heckj commented Mar 12, 2018

heckj commented Mar 12, 2018

bradtopol commented Mar 14, 2018

heckj commented Mar 14, 2018

zacharysarah commented Mar 14, 2018

zacharysarah commented Apr 3, 2018

k8s-ci-robot commented Apr 3, 2018

zacharysarah commented Apr 3, 2018

abitrolly commented Apr 4, 2018

zacharysarah commented Apr 5, 2018

zparnold commented Apr 6, 2018

k8s-ci-robot commented Apr 6, 2018

heckj commented Apr 10, 2018

k8s-ci-robot commented Apr 10, 2018

k8sio-netlify-preview-bot commented Mar 5, 2018 •

edited

Loading

tehut Mar 9, 2018 •

edited

Loading

zacharysarah Mar 12, 2018 •

edited

Loading