OpenWISP
Add gitter badge to netjsonconfig documentation
In this task you will learn how to add images to a ReStructuredText document.
ReStructuredText is a structured documentation format very popular in the python community because its powerful semantic structure.
Gitter is a popular chat platform used in the open source community, we use it in conjunction with IRC (a bridge is in place between our #openwisp
freenode IRC chat room and gitter).
Proceed as follows:
- star and fork the netjsonconfig repository
- get the gitter badge image URL and target URL from the ansible-openwisp2 repository
- add the badge in the README of netjsonconfig using ReStructuredText syntax
- perform the same operation in the documentation index page (
docs/source/index.rst
) - build the documentation locally with python-sphinx to ensure the result is good enough
Don't forget to join the OpenWISP gitter chat to ask questions to your mentors
Task tags
Students who completed this task
Aryan Bhasin