Been to a conference recently? Worked on something cool? Got something else Mattermost-related you want to post about? Writing a blog post is a great way to share your experience with the community.
Blog posts can cover a wide range of topics, such as:
Once you’ve got the topic in mind - what it’s about, what you want to achieve with the post, and what the next steps are - it’s sometimes helpful to start writing the conclusion and expand to your jumping off point to introduce your topic/idea/discovery draws.
Make a note of your intended audience, so you can decide whether to use very technical terms/jargon, or spend time unpacking terminology.
These are some ideas of the parts of a blog post. They’re not mandatory and not all blog posts will include every aspect. What works for some posts won’t work for others.
Some popular blogs that are worth reading include:
The /site/content/blog/ folder also has some good examples.
The steps below outline the process involved in creating the blog post file from a cloned repo, and then submitting the PR.
YYYY-MM-DD-<your-blog-post-title>.mdas the filename.
Paste this template into your file
--- title: <user readable title of your blog post, e.g. My Blog Post> description: "<brief description of the post less than 160 characters in length>" heading: "<the heading that appears at the top of the page content>" slug: <URL name of your blog post, e.g. my-blog-post> date: YYYY-MM-DDT12:00:00-04:00 author: <FirstName LastName> github: <your GitHub username> community: <your community.mattermost.com username> --- <intro to blog post> #### <some heading> <some content> #### <another heading> <some more content>
Write your blog post.
(Optional) If you wrote the blog post with someone else, you can also add a second author by adding
community_2 to the front matter.
Submit a pull request to https://github.com/mattermost/mattermost-developer-documentation and assign two dev reviews and an editor review from @amyblais or @justinegeffen.
Once merged it should show up on developers.mattermost.com/blog within 10-15 minutes. When it shows up, post about it in the Developers channel on community.mattermost.com.