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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blog post guidance update #93

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Blog post guidance update #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e5bc49
fixes typos
stockholmux Jun 28, 2024
c65b1a7
fixes poor grammar
stockholmux Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING-BLOG-POST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand All @@ -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.
Expand Down