From 7e5bc49816bc58d9aff11b115dde429870446c84 Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Fri, 28 Jun 2024 10:33:44 -0600 Subject: [PATCH 1/2] fixes typos Signed-off-by: Kyle J. Davis --- CONTRIBUTING-BLOG-POST.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING-BLOG-POST.md b/CONTRIBUTING-BLOG-POST.md index 11fbeff..ec2bdc6 100644 --- a/CONTRIBUTING-BLOG-POST.md +++ b/CONTRIBUTING-BLOG-POST.md @@ -7,7 +7,7 @@ The contribution model is lightweight, transparent, and uses well-understood ope Before you begin, it’s a good idea to setup an environment to write, test, and contribute your blog post. First, [fork the website repo](https://github.com/valkey-io/valkey-io.github.io), then clone the website to your local environment. -The general workflow is to write your post locally in a branch, confirm that it looks the way you want , then contribute your changes as a pull request. +The general workflow is to write your post locally in a branch, confirm that it looks the way you want, then contribute your changes as a pull request. The README has instructions on how to get up-and-running with Zola, the software used to build and test the website. @@ -27,7 +27,7 @@ Write your blog post in markdown. Generally, you’ll be better off sticking to headings, links, paragraphs and code blocks (there is no prohibition of using other markdown features though). A few writing tips: -1. Blog posts should be consumable in one setting. +1. Blog posts should be consumable in one sitting. Aim for 500-1,200 words. 2. Blog posts should cover a topic entirely. 1. If you start writing and realize that your post will be super long, consider refining your topic. From c65b1a7f8c958bc6b2625a9c66ba00e856fd4c7e Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Fri, 28 Jun 2024 10:34:42 -0600 Subject: [PATCH 2/2] fixes poor grammar Signed-off-by: Kyle J. Davis --- CONTRIBUTING-BLOG-POST.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING-BLOG-POST.md b/CONTRIBUTING-BLOG-POST.md index ec2bdc6..8a816b4 100644 --- a/CONTRIBUTING-BLOG-POST.md +++ b/CONTRIBUTING-BLOG-POST.md @@ -40,7 +40,7 @@ Aim for 500-1,200 words. There is a ton of things to say about Valkey without venturing into comparisons with other products and projects. 6. Have a call-to-action. What do you want your readers to do next after they finish your blog post? The call-to-action can be something like asking a users to contribute, try some sample code, or come to an event. -You can even just invite users to reader related content. +You can even just invite readers to consume related content. 7. Speak for yourself. Blog posts are attributed to a person, not the project, so feel free to have opinions and write in the first (I) or second (you) grammatical person. Unless you have specific authority (and you probably don’t!), avoid speaking for groups of people.