Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Why separate doc from code repository ? #2

Open
gst opened this issue Aug 24, 2015 · 2 comments
Open

Why separate doc from code repository ? #2

gst opened this issue Aug 24, 2015 · 2 comments

Comments

@gst
Copy link

gst commented Aug 24, 2015

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
Copy link
Contributor

mohierf commented Mar 14, 2018

@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
Copy link
Contributor

mohierf commented Jul 9, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants