diff --git a/_data/docs-home.yml b/_data/docs-home.yml index 2458cf4ec5..a0b66d11e2 100644 --- a/_data/docs-home.yml +++ b/_data/docs-home.yml @@ -19,6 +19,7 @@ toc: - docs/home/contribute/style-guide.md - docs/home/contribute/includes.md - docs/home/contribute/localization.md + - docs/home/contribute/blog-post.md - title: Updating Automatically Generated Reference Pages section: diff --git a/docs/home/contribute/blog-post.md b/docs/home/contribute/blog-post.md new file mode 100644 index 0000000000..aed3d25442 --- /dev/null +++ b/docs/home/contribute/blog-post.md @@ -0,0 +1,132 @@ +--- +title: Writing a Blog Post +reviewers: +- zacharysarah +- kbarnard10 +- sarahkconway +--- + +{% capture overview %} +This page shows you how to submit a post for the [Kubernetes blog](https://kubernetes.io/blog). + +You’ll receive a response within 5 business days on whether your submission is approved and information about next steps, if any. +{% endcapture %} + +{% capture prerequisites %} +To create a new blog post, you can either: + +- Fill out the [Kubernetes Blog Submission](https://docs.google.com/forms/d/e/1FAIpQLSch_phFYMTYlrTDuYziURP6nLMijoXx_f7sLABEU5gWBtxJHQ/viewform) form. + +or: + +- Open a pull request against this repository as described in +[Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/) +{% endcapture %} + +{% capture steps %} +## Kubernetes blog guidelines + +All content must be original. The Kubernetes blog does not post material previously published elsewhere. + +Suitable Content (with examples): + +- User case studies (Yahoo Japan, Bitmovin) +- New Kubernetes capabilities (5-days-of-k8s) +- Kubernetes projects updates (kompose) +- Updates from Special Interest Groups (SIG-OpenStack) +- Tutorials and walkthroughs (PostgreSQL w/ StatefulSets) +- Thought leadership around Kubernetes (CaaS, the foundation for next generation PaaS) +- Kubernetes Partner OSS integration (Fission) + +Unsuitable Content: + +- Vendor product pitches +- Partner updates without an integration and customer story +- Syndicated posts (language translations are permitted) + +## Create a blog post with a form + +Open the [Kubernetes Blog Submission](https://docs.google.com/forms/d/e/1FAIpQLSch_phFYMTYlrTDuYziURP6nLMijoXx_f7sLABEU5gWBtxJHQ/viewform) form, fill it out, and click Submit. + +## Create a post by opening a pull request + +### Add a new Markdown file + +Add a new Markdown (`*.md`) to `/blog/_posts/`. + +Name the file using the following format: +``` +YYYY-MM-DD-Title.md +``` +For example: +``` +2015-03-20-Welcome-to-the-Kubernetes-Blog.md +``` + +### Add front matter to the file + +Add the following block to the top of the new file: +``` +--- +layout: blog +title: +date: <date> +--- +``` + +For example: +``` +--- +layout: blog +title: Welcome to the Kubernetes Blog! +date: Saturday, March 20, 2015 +--- +``` + +### Create a new pull request (PR) + +When you [create a new pull request](/docs/home/contribute/create-pull-request/), include the following in the PR description: + +- Desired publishing date +**Note:** PRs must include complete drafts no later than 15 days prior to the desired publication date. +{: .note} +- Author information: + - Name + - Title + - Company + - Contact email + +### Add content to the file + +Write your post using the following guidelines. + +### Add images + +Add any image files the post contains to `/images/blog/`. + +The preferred image format is SVG. + +Add the proposed date of your blog post to the title of any image files the post contains: +``` +YYYY-MM-DD-image.svg +``` +For example: +``` +2018-03-01-cncf-color.svg +``` + +Please use [reference-style image links][ref-style] to keep posts readable. + +Here's an example of how to include an image in a blog post: + +``` +Check out the ![CNCF logo][cncf-logo]. + +[cncf-logo]: /images/blog/2018-03-01-cncf-color.svg +``` + +{% endcapture %} + +{% include templates/task.md %} + +[ref-style]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#images diff --git a/images/blog/2018-03-01-cncf-color.svg b/images/blog/2018-03-01-cncf-color.svg new file mode 100644 index 0000000000..c04343849e --- /dev/null +++ b/images/blog/2018-03-01-cncf-color.svg @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 21.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) --> +<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" + viewBox="0 0 414 73" style="enable-background:new 0 0 414 73;" xml:space="preserve"> +<style type="text/css"> + .st0{fill:#446CA9;} + .st1{fill:#76C4D5;} +</style> +<g> + <path d="M101.2,32c3.3,0,5.9-1.3,8-3.9l4.2,4.4c-3.4,3.8-7.3,5.7-11.9,5.7c-4.6,0-8.3-1.4-11.3-4.3c-3-2.9-4.4-6.5-4.4-10.9 + c0-4.4,1.5-8.1,4.5-11c3-2.9,6.7-4.4,11.1-4.4c4.9,0,9,1.9,12.2,5.6l-4.1,4.7c-2.1-2.6-4.7-3.9-7.8-3.9c-2.5,0-4.6,0.8-6.4,2.4 + c-1.8,1.6-2.7,3.8-2.7,6.6s0.8,5,2.5,6.7C96.8,31.1,98.8,32,101.2,32z"/> + <polygon points="118.7,37.8 118.7,8.1 125.3,8.1 125.3,31.9 138,31.9 138,37.8 "/> + <path d="M167,33.7c-3,2.9-6.7,4.4-11.1,4.4c-4.4,0-8.1-1.5-11.1-4.4c-3-2.9-4.5-6.6-4.5-10.9s1.5-8,4.5-10.9 + c3-2.9,6.7-4.4,11.1-4.4c4.4,0,8.1,1.5,11.1,4.4c3,2.9,4.5,6.6,4.5,10.9S170,30.8,167,33.7z M164.7,22.8c0-2.6-0.9-4.9-2.5-6.8 + c-1.7-1.9-3.8-2.8-6.3-2.8c-2.5,0-4.6,0.9-6.3,2.8c-1.7,1.9-2.6,4.1-2.6,6.8s0.9,4.9,2.6,6.8c1.7,1.9,3.8,2.8,6.3,2.8 + c2.5,0,4.6-0.9,6.3-2.8S164.7,25.5,164.7,22.8z"/> + <path d="M185,30.2c1.1,1.4,2.6,2.1,4.5,2.1c1.9,0,3.4-0.7,4.4-2.1c1.1-1.4,1.6-3.3,1.6-5.6V8.1h6.6v16.6c0,4.3-1.2,7.6-3.6,9.9 + c-2.4,2.3-5.4,3.5-9.1,3.5c-3.7,0-6.8-1.2-9.2-3.5c-2.4-2.3-3.6-5.6-3.6-9.9V8.1h6.6v16.4C183.3,26.9,183.9,28.8,185,30.2z"/> + <path d="M231.7,12c2.8,2.6,4.3,6.2,4.3,10.8s-1.4,8.3-4.1,11c-2.8,2.7-7,4-12.6,4H209V8.1h10.5C224.8,8.1,228.9,9.4,231.7,12z + M226.9,29.7c1.6-1.5,2.4-3.8,2.4-6.7c0-2.9-0.8-5.2-2.4-6.7c-1.6-1.6-4.1-2.4-7.5-2.4h-3.7V32h4.2C222.9,32,225.2,31.2,226.9,29.7 + z"/> + <polygon points="273.7,8.1 280.4,8.1 280.4,37.8 273.7,37.8 259.6,19.2 259.6,37.8 252.9,37.8 252.9,8.1 259.2,8.1 273.7,27.3 "/> + <path d="M308.8,37.8l-2.8-6.4h-12.5l-2.8,6.4h-7.1l12.8-29.7h6.4l12.8,29.7H308.8z M299.9,17l-3.7,8.6h7.4L299.9,17z"/> + <polygon points="329.8,13.9 329.8,37.8 323.1,37.8 323.1,13.9 314.7,13.9 314.7,8.1 338.2,8.1 338.2,13.9 "/> + <rect x="343" y="8.1" width="6.6" height="29.7"/> + <polygon points="367.9,27 375.5,8.1 382.7,8.1 370.7,37.8 365.1,37.8 353.2,8.1 360.4,8.1 "/> + <polygon points="407.6,8.1 407.6,14 392.8,14 392.8,20.2 406.1,20.2 406.1,25.8 392.8,25.8 392.8,32 408.1,32 408.1,37.8 + 386.2,37.8 386.2,8.1 "/> + <path d="M93.6,63.1c1.8,0,3.3-0.7,4.5-2.2l2.4,2.5c-1.9,2.1-4.1,3.2-6.7,3.2s-4.7-0.8-6.3-2.4c-1.7-1.6-2.5-3.7-2.5-6.1 + c0-2.5,0.8-4.5,2.5-6.2s3.8-2.5,6.2-2.5c2.7,0,5,1,6.9,3.1l-2.3,2.6c-1.2-1.5-2.6-2.2-4.4-2.2c-1.4,0-2.6,0.5-3.6,1.4 + c-1,0.9-1.5,2.1-1.5,3.7s0.5,2.8,1.4,3.7C91.1,62.7,92.3,63.1,93.6,63.1z"/> + <path d="M117,64.1c-1.7,1.6-3.8,2.5-6.2,2.5s-4.5-0.8-6.2-2.5c-1.7-1.6-2.5-3.7-2.5-6.1s0.8-4.5,2.5-6.1c1.7-1.6,3.8-2.5,6.2-2.5 + s4.5,0.8,6.2,2.5c1.7,1.6,2.5,3.7,2.5,6.1S118.7,62.5,117,64.1z M115.8,58c0-1.5-0.5-2.8-1.4-3.8c-1-1-2.1-1.6-3.5-1.6 + s-2.6,0.5-3.5,1.6c-1,1-1.4,2.3-1.4,3.8s0.5,2.7,1.4,3.8c1,1,2.1,1.6,3.5,1.6s2.6-0.5,3.5-1.6C115.3,60.8,115.8,59.5,115.8,58z"/> + <polygon points="137.6,55.9 133.1,65.1 130.9,65.1 126.4,55.9 126.4,66.4 122.7,66.4 122.7,49.8 127.7,49.8 132,58.9 136.3,49.8 + 141.3,49.8 141.3,66.4 137.6,66.4 "/> + <path d="M156.9,51.3c1.2,1,1.8,2.5,1.8,4.6s-0.6,3.6-1.8,4.5c-1.2,1-3,1.4-5.5,1.4h-2.2v4.6h-3.7V49.8h5.9 + C153.9,49.8,155.7,50.3,156.9,51.3z M154.2,57.8c0.4-0.5,0.7-1.2,0.7-2.2s-0.3-1.6-0.9-2c-0.6-0.4-1.5-0.6-2.7-0.6h-2.1v5.6h2.5 + C152.9,58.6,153.7,58.3,154.2,57.8z"/> + <path d="M166,62.1c0.6,0.8,1.5,1.2,2.5,1.2s1.9-0.4,2.5-1.2c0.6-0.8,0.9-1.8,0.9-3.2v-9.2h3.7v9.3c0,2.4-0.7,4.3-2,5.6 + c-1.3,1.3-3,1.9-5.1,1.9s-3.8-0.7-5.1-2s-2-3.2-2-5.6v-9.3h3.7V59C165.1,60.3,165.4,61.4,166,62.1z"/> + <polygon points="186.5,53 186.5,66.4 182.8,66.4 182.8,53 178.1,53 178.1,49.8 191.2,49.8 191.2,53 "/> + <rect x="194" y="49.8" width="3.7" height="16.7"/> + <polygon points="213.4,49.8 217.1,49.8 217.1,66.4 213.4,66.4 205.5,56 205.5,66.4 201.8,66.4 201.8,49.8 205.2,49.8 213.4,60.5 + "/> + <path d="M232.1,58h3.7v5.9c-1.7,1.8-3.9,2.8-6.9,2.8c-2.4,0-4.5-0.8-6.2-2.4c-1.7-1.6-2.5-3.7-2.5-6.1c0-2.5,0.8-4.5,2.5-6.2 + s3.7-2.5,6.1-2.5c2.4,0,4.5,0.8,6.2,2.4l-1.9,2.8c-0.7-0.7-1.4-1.1-2.1-1.3c-0.6-0.2-1.3-0.4-2-0.4c-1.4,0-2.6,0.5-3.6,1.4 + c-1,1-1.5,2.2-1.5,3.8c0,1.6,0.5,2.8,1.4,3.8c0.9,0.9,2,1.4,3.3,1.4c1.3,0,2.4-0.2,3.2-0.7L232.1,58L232.1,58z"/> + <polygon points="256.8,49.8 256.8,53 249.1,53 249.1,56.6 256.5,56.6 256.5,59.9 249.1,59.9 249.1,66.4 245.4,66.4 245.4,49.8 "/> + <path d="M274,64.1c-1.7,1.6-3.8,2.5-6.2,2.5c-2.5,0-4.5-0.8-6.2-2.5c-1.7-1.6-2.5-3.7-2.5-6.1s0.8-4.5,2.5-6.1 + c1.7-1.6,3.8-2.5,6.2-2.5c2.5,0,4.5,0.8,6.2,2.5c1.7,1.6,2.5,3.7,2.5,6.1S275.7,62.5,274,64.1z M272.7,58c0-1.5-0.5-2.8-1.4-3.8 + c-1-1-2.1-1.6-3.5-1.6s-2.6,0.5-3.5,1.6c-1,1-1.4,2.3-1.4,3.8s0.5,2.7,1.4,3.8c1,1,2.1,1.6,3.5,1.6s2.6-0.5,3.5-1.6 + C272.3,60.8,272.7,59.5,272.7,58z"/> + <path d="M284.1,62.1c0.6,0.8,1.5,1.2,2.5,1.2c1,0,1.9-0.4,2.5-1.2c0.6-0.8,0.9-1.8,0.9-3.2v-9.2h3.7v9.3c0,2.4-0.7,4.3-2,5.6 + c-1.3,1.3-3,1.9-5.1,1.9s-3.8-0.7-5.1-2c-1.3-1.3-2-3.2-2-5.6v-9.3h3.7V59C283.1,60.3,283.5,61.4,284.1,62.1z"/> + <polygon points="309.2,49.8 312.9,49.8 312.9,66.4 309.2,66.4 301.3,56 301.3,66.4 297.6,66.4 297.6,49.8 301,49.8 309.2,60.5 "/> + <path d="M329.7,52c1.6,1.5,2.4,3.5,2.4,6.1c0,2.6-0.8,4.6-2.3,6.1c-1.5,1.5-3.9,2.3-7.1,2.3H317V49.8h5.9 + C325.9,49.8,328.2,50.5,329.7,52z M327,61.9c0.9-0.9,1.4-2.1,1.4-3.7c0-1.6-0.5-2.9-1.4-3.8c-0.9-0.9-2.3-1.3-4.2-1.3h-2.1v10.1 + h2.4C324.8,63.1,326.1,62.7,327,61.9z"/> + <path d="M346.7,66.4l-1.5-3.6h-7l-1.5,3.6h-4l7.2-16.7h3.6l7.2,16.7H346.7z M341.7,54.7l-2.1,4.8h4.2L341.7,54.7z"/> + <polygon points="358.5,53 358.5,66.4 354.7,66.4 354.7,53 350,53 350,49.8 363.2,49.8 363.2,53 "/> + <rect x="365.9" y="49.8" width="3.7" height="16.7"/> + <path d="M387.7,64.1c-1.7,1.6-3.8,2.5-6.2,2.5c-2.5,0-4.5-0.8-6.2-2.5c-1.7-1.6-2.5-3.7-2.5-6.1s0.8-4.5,2.5-6.1 + c1.7-1.6,3.8-2.5,6.2-2.5c2.5,0,4.5,0.8,6.2,2.5c1.7,1.6,2.5,3.7,2.5,6.1S389.4,62.5,387.7,64.1z M386.5,58c0-1.5-0.5-2.8-1.4-3.8 + c-1-1-2.1-1.6-3.5-1.6s-2.6,0.5-3.5,1.6c-1,1-1.4,2.3-1.4,3.8s0.5,2.7,1.4,3.8c1,1,2.1,1.6,3.5,1.6s2.6-0.5,3.5-1.6 + C386,60.8,386.5,59.5,386.5,58z"/> + <polygon points="405,49.8 408.8,49.8 408.8,66.4 405,66.4 397.1,56 397.1,66.4 393.4,66.4 393.4,49.8 396.9,49.8 405,60.5 "/> + <polygon class="st0" points="14.5,46.7 5.4,46.7 5.4,68.1 26.7,68.1 26.7,58.9 14.5,58.9 "/> + <polygon class="st0" points="60.3,46.8 60.3,58.9 48.1,58.9 48.1,58.8 48.1,68.1 69.4,68.1 69.4,46.7 60.2,46.7 "/> + <polygon class="st0" points="5.4,25.4 14.6,25.4 14.5,25.3 14.5,13.2 14.5,13.2 26.7,13.2 26.7,13.2 26.7,4 5.4,4 "/> + <polygon class="st0" points="48.1,4 48.1,13.2 60.3,13.2 60.3,25.4 69.4,25.4 69.4,4 "/> + <polygon class="st1" points="46.9,25.4 34.7,13.2 48.1,13.2 48.1,4 26.7,4 26.7,13.2 38.9,25.4 "/> + <polygon class="st1" points="35.9,46.7 27.9,46.7 38,56.8 40,58.9 35.9,58.9 26.7,58.9 26.7,68.1 48.1,68.1 48.1,58.8 42,52.8 "/> + <polygon class="st1" points="60.3,25.4 60.3,34.5 60.3,38.7 58.2,36.6 48.1,26.5 48.1,34.6 54.1,40.6 60.2,46.7 69.4,46.7 + 69.4,25.4 "/> + <polygon class="st1" points="26.7,37.5 14.6,25.4 5.4,25.4 5.4,46.7 14.5,46.7 14.5,33.4 26.7,45.6 "/> +</g> +</svg>