From 4d45f67b19fcfa5cd2f64d12909b041b44f3731b Mon Sep 17 00:00:00 2001 From: Paul Schweigert Date: Fri, 17 Dec 2021 07:33:25 -0500 Subject: [PATCH] update instructions on creating blog posts (#4587) --- blog/README.md | 12 +++++++----- .../what-to-contribute/creating-blog-posts.md | 13 ++++++------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/blog/README.md b/blog/README.md index 6252a5ec3..4e8863b67 100644 --- a/blog/README.md +++ b/blog/README.md @@ -11,8 +11,9 @@ nav: - Eventing: - Code samples: - Reference: - - "Join the Community ➠": - Blog: + - Case studies: + - Community: ``` Currently, we maintain two different copies of the navigation. @@ -35,12 +36,12 @@ Note here that each link assumes that the present working directory is `docs/doc The Blog and Community pages instead use absolute links to their sections: ```yaml - - "Join the Community ➠": /community/ + - Blog: /blog/ - Case Studies: - deepc: about/case-studies/deepc.md - Outfit7: about/case-studies/outfit7.md - Puppet: about/case-studies/puppet.md - - Blog: /blog/ + - Community: /community/ ``` Note that the Blog link is `/blog/` and not `blog/` (and similar for the community site). @@ -60,14 +61,15 @@ nav: - Eventing: /docs/eventing/ - Code samples: /docs/samples/ - Reference: /docs/reference/ - - "Join the Community ➠": /community/ - - Case studies: /docs/about/case-studies/deepc - Blog: - index.md - Releases: - releases/announcing-knative-v0-26-release.md - releases/announcing-knative-v0-25-release.md - releases/announcing-knative-v0-24-release.md + ... + - Case studies: /docs/about/case-studies/deepc + - Community: /community/ ``` A couple of key points: diff --git a/contribute-to-docs/what-to-contribute/creating-blog-posts.md b/contribute-to-docs/what-to-contribute/creating-blog-posts.md index f29ca4cfb..538c8aa12 100644 --- a/contribute-to-docs/what-to-contribute/creating-blog-posts.md +++ b/contribute-to-docs/what-to-contribute/creating-blog-posts.md @@ -21,25 +21,24 @@ Anyone can write a blog post and submit it for review. Commercial content is not To submit a blog post: 1. [Sign the Contributor License Agreements](https://github.com/knative/community/blob/main/CONTRIBUTING.md#contributor-license-agreements) if you have not yet done so. -1. Familiarize yourself with the Markdown format for existing blog posts in the [docs repository](https://github.com/knative/docs/tree/main/blog). Blog posts are categorized into different directories. You can explore the directories to find examples. +1. Familiarize yourself with the Markdown format for existing blog posts in the [docs repository](https://github.com/knative/docs/tree/main/blog/docs). Blog posts are categorized into different directories. You can explore the directories to find examples. 1. Write your blog post in a text editor of your choice. 1. (Optional) If you need help with markdown, check out [StakEdit](https://stackedit.io/app#) or read [GitHub's formatting syntax](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) for more information. -1. Choose a directory in the [docs repository](https://github.com/knative/docs/tree/main/blog), and click **Create new file**. -1. Paste your content into the editor and save it. Name the file in the following way: *[BLOG] Your proposed title* , but don’t put the date in the file name. The blog reviewers will work with you on the final file name, and the date on which the blog will be published. -1. When you save the file, GitHub will walk you through the pull request (PR) process. +1. Update the navigation files as described on the [Updating the Blog](https://github.com/knative/docs/blob/main/blog/README.md) page. +1. Open a pull request (PR) for your blog post. 1. A reviewer is assigned to all pull requests automatically. The reviewer checks your submission, and works with you on feedback and final details. When the pull request is approved, the blog will be scheduled for publication. 1. Ping editorial team members on Slack [#docs](https://knative.slack.com/archives/C9CV04DNJ) channel with a link to your recently created PR. -### Blog Guidelines +## Blog Guidelines -#### Suitable content: +### Suitable content: - **Original content only** - Knative [new feature releases and project updates](#communicating-new-project-releases) - Tutorials and demos - Use cases - Content that is specific to a vendor or platform about Knative installation and use -#### Unsuitable Content: +### Unsuitable Content: - Blogs that do not address Knative in any way - Content that doesn't interact with Knative APIs or interfaces - Vendor pitches