Is it a good idea to keep documentation in the VCS?
Posted
by Jj
on Stack Overflow
See other posts from Stack Overflow
or by Jj
Published on 2010-05-13T21:07:59Z
Indexed on
2010/05/13
21:14 UTC
Read the original article
Hit count: 239
At work we just moved to Mercurial for our VCS from SVN.
In SVN we used to have a "docs" folder next to "trunk", in "docs" we would keep all our file documentation, client files, diagrams, mockups, etc. (we use a wiki(Redmine) for internal documentation).
Now in a DVCS enviroment we don't need a "trunk" folder, so we drop the code at the root of the repo, and now having a "docs" folder inside the repo feels weird being at the same level that the code.
This has taken me to reconsider if it is a good idea to keep those files in the VCS, we have a "documents" section in Redmine, but I have never used it because it is a pain to have to download a file each time I want to open it and I can't access the file when I'm offline.
What best practices have you guys found to manage these kind of non-code files?
© Stack Overflow or respective owner