Uninett / Argus

Argus is an alert aggregator for monitoring systems
GNU General Public License v3.0
19 stars 14 forks source link

docs: make documentation on how to use the API. "First steps with Argus" #224

Open katsel opened 3 years ago

katsel commented 3 years ago

Put together a very basic tutorial of things to do after having set up Argus!

Intended for onboarding new developers, showcasing some basic features and principles, and give users and devs practical examples of how to get things done.

Could include:

If it is going to be me doing this, this will be console-based and with cURL. Open to suggestions.

katsel commented 3 years ago

An "how to use the API" tutorial will be needed now that drf-spectacular is implemented. It should mention where to find the auto-generated spectacular-api-docs in the API. We may need to discuss

include the auto-generated API-docs on readthedocs too.