# Commiting doc folder to svn

**URL:** <https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787>\
**Category:** Rails\
**Created:** [September 30, 2010, 6:55am UTC](https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787 "2010-09-30T06:55:55Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [September 30, 2010, 6:55am UTC](https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787/1 "2010-09-30T06:55:55Z")

</div>

Hi  
I would like to know expert opinion on this. Should I commit folders  
like doc/app into svn? What is the general strategy

Thanks  
Tom

---

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [September 30, 2010, 4:06pm UTC](https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787/2 "2010-09-30T16:06:05Z")

</div>

Tom M. wrote:

> Hi  
> I would like to know expert opinion on this. Should I commit folders  
> like doc/app into svn? What is the general strategy

Nothing should ever be committed to svn… [http://git-scm.com/](http://git-scm.com/) 🙂

However, yes I most definitely version control my application  
documentation.

---

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [September 30, 2010, 4:52pm UTC](https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787/3 "2010-09-30T16:52:41Z")

</div>

Robert W. wrote:

> Tom M. wrote:
> 
> > Hi  
> > I would like to know expert opinion on this. Should I commit folders  
> > like doc/app into svn? What is the general strategy
> 
> Nothing should ever be committed to svn… [http://git-scm.com/](http://git-scm.com/) 🙂

Agreed!

> However, yes I most definitely version control my application  
> documentation.

Are you referring to files generated by rdoc, or other files? The  
latter definitely go into version control, but I’m not sure if the  
former should…

Best,  
–Â  
Marnen Laibow-Koser  
[http://www.marnen.org](http://www.marnen.org)  
removed\_email\_address@domain.invalid

---

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [September 30, 2010, 6:30pm UTC](https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787/4 "2010-09-30T18:30:54Z")

</div>

Marnen Laibow-Koser wrote:

> Robert W. wrote:
> 
> > However, yes I most definitely version control my application  
> > documentation.
> 
> Are you referring to files generated by rdoc, or other files? The  
> latter definitely go into version control, but I’m not sure if the  
> former should…

Oh, I wasn’t thinking about RDoc docs. So yea, I was referring to other  
docs/READMEs.

I would consider RDoc documentation to be a build product. The RDoc  
source is already under version control with the code. It would be  
redundant to version control the generated output.

---

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [October 1, 2010, 6:47am UTC](https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787/5 "2010-10-01T06:47:48Z")

</div>

Hi  
I was asking about should I commit to svn the folder generated by

rake doc:app

```
        ie doc/app folder completely
```

---

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [September 30, 2010, 9:11pm UTC](https://www.ruby-forum.com/t/commiting-doc-folder-to-svn/195787/6 "2010-09-30T21:11:02Z")

</div>

Robert W. wrote:

> Marnen Laibow-Koser wrote:
> 
> > Robert W. wrote:
> > 
> > > However, yes I most definitely version control my application  
> > > documentation.
> > 
> > Are you referring to files generated by rdoc, or other files? The  
> > latter definitely go into version control, but I’m not sure if the  
> > former should…
> 
> Oh, I wasn’t thinking about RDoc docs. So yea, I was referring to other  
> docs/READMEs.

Right.

> I would consider RDoc documentation to be a build product. The RDoc  
> source is already under version control with the code. It would be  
> redundant to version control the generated output.

That’s my opinion too.

## Best,

Marnen Laibow-Koser  
[http://www.marnen.org](http://www.marnen.org)  
removed\_email\_address@domain.invalid