STYLE_GUIDE.md

Blogs Style Guide

Welcome to the Kubesimplify Blogs Style Guide. We are here to help you write the best possible content for Kubesimplify and showcase your learnings!

Let us start with an important disclaimer:

We accept original and unpublished blogs only!

Best Practices

Here are some simple but very essential best practices to keep in mind:

• Each blog should have around 5+ minutes of read time.
• Format the blogs by using proper headings, for consistency.
• Check the Grammar and spellings. Use Language Tool or similar tools.
• Multiple lines of code should be in a code block.
  • For example:

    package main
    import "fmt"
    
    func main() {
        fmt.Println("hello world")
    }
    

• Use bold when needed and try to avoid italics.
• Space after "." and "," is a must.
• Use Images, Screenshots, diagrams wherever it makes sense to use them.
• Make sure that readers are able to copy the code used in the blog, regardless of it being a simple shell command.
• "Credit the sources" if you use any.
• Avoid sharing screenshots, images or code that contains personal, private or any sensitive information.
• Use arrows, boxes, etc in the screenshots if it makes things easy for the reader to identify.
• Creating a custom Thumbnail/Cover images related to the blog content are better than just random images.
• Add Tags, and choose Generate table of contents option (provided by Hashnode).

Useful Tools

Here is a list of some useful tools that may come in handy during the blog writing process:

• Thumbnail Creators:
  • blogcover.vercel.app
  • cover-image-generator.netlify.app
  • gimp.org
  • inkscape.org
• For Images:
  • pexels.com
  • unsplash.com
  • pixabay.com
• For Spelling and Grammar checking:
  • languagetool.org
  • Grammarly
• For Diagrams/Image Editing
  • excalidraw.com
• Flameshot is an opensource screenshot tool with options to blur, write or edit the images. Super useful!
• Use Hemingway to identify how easy or hard the blog is for the readers.

  Please use this before you make a PR. You don't have to be perfect, but try avoiding super hard sentences.

Resources

Invest some time reading and watching content related to writing. This video and blog are by Quincy Larson, founder of FreeCodeCamp.

• Quincy Larson's Video
• Quincy Larson's Blog

Conclusion

We appreciate your interest in contributing to Kubesimplify Blogs. By following the guidelines and best practices outlined in this document, you can help us maintain high-quality blogs with informative content.

If you have any questions or feedback, please feel free to reach out to us at [email protected] or the #kblogs channel on our discord community.