Better Documentation for Contributors?

motiv-labs / janus

An API Gateway written in Go

https://hellofresh.gitbooks.io/janus

MIT License

2.77k stars 319 forks source link

Better Documentation for Contributors? #475

Open Leonardo-Ferreira opened 3 years ago

Leonardo-Ferreira commented 3 years ago

I'm new here and I'd like to contribute and find the documentation "lacking". It would be nice to have a basic walkthrough for a developer, something like: clone the code, then copy the file janus/devHelpers/Janus and place it in /etc/Janus/, put that other file on that other location and run the code with the flag "start". You will be able to call http://localhost/echo and get "echo" back.

you know? first steps to get people compiling and debugging real quick, no fuss...

jtesser commented 3 years ago

Hi @Leonardo-Ferreira

We would welcome contribution. Our current gitbook is published here https://motivlabs.gitbook.io/janus/ We do need some better quick start stuff and examples for sure.

Leonardo-Ferreira commented 3 years ago

yeah... took me while to get things running... now im trying to retrace my steps in order to make a guide