search

Alignak-monitoring / alignak-doc

Alignak framework documentation
1 stars 4 forks source link

Why separate doc from code repository ? #2

Open gst opened 9 years ago

gst commented 9 years ago

I find it shocking ; imho a documentation should be attached/stored along to what it is documenting..

So that if/when an API/feature/whatever is changed/introduced then the relevant documentation should also be changed/introduced ; in the same branch or even commit.

Most (very well maintained) opensource software projects are doing this, I can give plenty of them very good : Django, celery, requests, flask, tornado, ansible, sentry, scrapy, ipython, boto, etc, etc etc (and etc..) ..

In fact this is really very common (and best) practice to include the documentation of a software in the same repository than the source code itself..

mohierf commented 6 years ago

@ddurieux : this very old issue still makes sense to me. Maintaining code and doc is complicated with two different repos!

Do you agree with merging back to hte main Alignak repo ?

mohierf commented 6 years ago

@ddurieux : what is your idea about this ? Merging back the doc to the main repository ...