Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.15 KB

GUIDELINES.md

File metadata and controls

44 lines (28 loc) · 2.15 KB
Raw

Guidelines to submit the blog in Knowledge Hub

Here are some guidelines that you must follow while writing the blog for the Knowledge Hub:

  1. First of all create a directory in blog by your blog name for eg: my-first-blog.

  2. The blog should have the cover image with the aspect ratio of 3:2, we recommend using image size of 1200px x 800px and the minimum image size can be 600px x 400px and image should be named as header.jpg.

  3. Create index.md file in your blog folder and mention the author details in the file. The blog should be google docs and it's (public)link should be given in the file.

    • id (required): The name of the author, it should be the same as the name in the meta tags of the blog.
    • bio (optional): A short intro about you.
    • social profiles (optional): You need to mention the id of your social profiles, supported social profiles will be GitHub, StackOverflow, LinkedIn, medium, twitter. Note: For StackOverflow, you need to add your id which is in number, for eg: https://stackoverflow.com/users/12117041/kashan-siddiqui for this URL id will be 12117041.

    This is an example of the author info

    id: Kashan Siddiqui
bio: A short intro about me
blog-link:
github:
stackoverflow:
linkedin:
medium:
twitter:

Some tips that you can keep in mind while writing the blog.

  • Keep post's language simple and easy to understand, we are making our blogs for the mass and our audience doesn't need to be only native English speakers

  • Use short paragraphs, break down longer paragraphs into smaller one, people lose their interest more while reading a long paragraph

  • Use headers to structure your post, use large headers for the main heading and smaller for sub-sections in it

  • Try to use complete words then abbreviations, spell out an acronym that isn’t well-known

  • Try to use images/screenshots in your post to example things better, images are also visible when you share the post in social media

  • Always provide a GitHub demo link whenever you post contains the code.

  • Simplicity, Ease of Implementation of the content, developer-friendly and effectiveness