General Guidelines for all articles

• Have a Prerequisites section to inform readers what would they need for following the tutorial

  • Mention any language or tool that needs to be installed for following the tutorial along with its version
  • Give out links to download it
  • Check out an example here.

• Headlines should be action-oriented, for example:

  • Creating a sample app
  • Implementing GraphQL in Angular
  • Modifying ALLOWED_HOSTS in the Django Settings

• Have the tutorial’s code sample on GitHub with instructions on how to run the application

• Have a : before a code snippet

  

  Source: https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-on-ubuntu-12-04-lts-precise-pangolin-with-rvm

For images

• Update Image File Name to something relevant and consistent. Try to include the article’s topic in short and then append a relevant title for the pic. For example, if the article is on angular graphql and the pic is about metrics monitoring, you can have image names as angualr_graphql_metrics_monitoring
• Provide alt text and caption for images

  • What is alt text? Alt-text is the written copy that appears in place of an image on a webpage if the image fails to load on a user's screen. This text helps screen-reading tools describe images to visually impaired readers and allows search engines to better crawl and rank your website.

  • For example, alt text for the below image: Flamegraph visualizing a trace into its constituent span. The trace data is also visualized with the help of a Gantt chart showing latency data.

    

Product Tutorials (Monitoring with SigNoz)

For writing the product tutorial, you will first need to do two things

• Install SigNoz
• Create a sample app in the relevant technology For example, if you are writing about monitoring nodejs apps with SigNoz, you will need to create a sample nodejs app and publish it on GitHub.

Below you can find detailed instructions for each section of the article.

If you have any questions, feel free to reach out to [email protected] You can also join our slack community and reach out to Ashu.

Install SigNoz