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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contribution guidelines for blog posts #7646

Merged
merged 7 commits into from Apr 10, 2018

Conversation

@zacharysarah
Copy link
Contributor

commented Mar 5, 2018

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

This comment has been minimized.

Copy link
Collaborator

commented Mar 5, 2018

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

Built with commit 2c081f1

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

@zacharysarah

This comment has been minimized.

Copy link
Contributor Author

commented Mar 5, 2018

@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. 馃憤

@zacharysarah zacharysarah self-assigned this Mar 5, 2018

@kbarnard10

This comment has been minimized.


## Add images

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

This comment has been minimized.

Copy link
@bradtopol

bradtopol Mar 8, 2018

Contributor

@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?

This comment has been minimized.

Copy link
@heckj

heckj Mar 8, 2018

Member

馃憤 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.

This comment has been minimized.

Copy link
@bradtopol

bradtopol Mar 8, 2018

Contributor

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:

This comment has been minimized.

Copy link
@zacharysarah

zacharysarah Mar 12, 2018

Author Contributor

@heckj @bradtopol Good feedback--added!

@heckj
Copy link
Member

left a comment

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.

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

This comment has been minimized.

Copy link
@heckj

heckj Mar 8, 2018

Member

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

This comment has been minimized.

Copy link
@tehut

tehut Mar 9, 2018

Contributor

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

This comment has been minimized.

Copy link
@zacharysarah

zacharysarah Mar 12, 2018

Author Contributor

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

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

This comment has been minimized.

Copy link
@heckj

heckj Mar 8, 2018

Member

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

This comment has been minimized.

Copy link
@tehut

tehut Mar 9, 2018

Contributor

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.

image

jekyll/jekyll-help#124

---
```

## Create a new pull request (PR)

This comment has been minimized.

Copy link
@heckj

heckj Mar 8, 2018

Member

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?

This comment has been minimized.

Copy link
@zacharysarah

zacharysarah Mar 12, 2018

Author Contributor

@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!


## Add images

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

This comment has been minimized.

Copy link
@heckj

heckj Mar 8, 2018

Member

馃憤 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.


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

This comment has been minimized.

Copy link
@heckj

heckj Mar 8, 2018

Member

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 馃嵍

This comment has been minimized.

Copy link
@zacharysarah

zacharysarah Mar 12, 2018

Author Contributor

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


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

- Desired publishing date

This comment has been minimized.

Copy link
@heckj

heckj Mar 8, 2018

Member
  • 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)?

This comment has been minimized.

Copy link
@zacharysarah

zacharysarah Mar 12, 2018

Author Contributor

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.


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

- Desired publishing date

This comment has been minimized.

Copy link
@bradtopol

bradtopol Mar 8, 2018

Contributor

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

@bradtopol

This comment has been minimized.

Copy link
Contributor

commented Mar 8, 2018

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

zacharysarah added some commits Mar 12, 2018

@k8s-ci-robot k8s-ci-robot added size/L and removed size/M labels Mar 12, 2018

zacharysarah added some commits Mar 12, 2018

@heckj

This comment has been minimized.

Copy link
Member

commented Mar 12, 2018

馃憤 from me!

@heckj

This comment has been minimized.

Copy link
Member

commented Mar 12, 2018

/approve

@bradtopol

This comment has been minimized.

Copy link
Contributor

commented Mar 14, 2018

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

This comment has been minimized.

Copy link
Member

commented Mar 14, 2018

@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

This comment has been minimized.

Copy link
Contributor Author

commented Mar 14, 2018

@bradtopol What @heckj said. 鈽濓笍 :bowtie:

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

@zacharysarah

This comment has been minimized.

Copy link
Contributor Author

commented Apr 3, 2018

/lgtm

@k8s-ci-robot

This comment has been minimized.

Copy link

commented Apr 3, 2018

@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

This comment has been minimized.

Copy link
Contributor Author

commented Apr 3, 2018

@zacharysarah: you cannot LGTM your own PR.

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

@abitrolly

This comment has been minimized.

Copy link
Contributor

commented Apr 4, 2018

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

@zacharysarah

This comment has been minimized.

Copy link
Contributor Author

commented Apr 5, 2018

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

@bradtopol Bump for review

@zparnold

This comment has been minimized.

Copy link
Member

commented Apr 6, 2018

/lgtm

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

@k8s-ci-robot

This comment has been minimized.

Copy link

commented Apr 6, 2018

@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

This comment has been minimized.

Copy link
Member

commented Apr 10, 2018

/lgtm

@k8s-ci-robot

This comment has been minimized.

Copy link

commented Apr 10, 2018

[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:

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 merged commit 62229dc into kubernetes:master Apr 10, 2018

4 checks passed

cla/linuxfoundation zacharysarah authorized
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details
tide In merge pool.
Details

zacharysarah added a commit that referenced this pull request Apr 16, 2018

Add contribution guidelines for blog posts (#7646)
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.