[ciphershed] Re: Doc directory?

  • From: "Alain Forget" <aforget@xxxxxxx>
  • To: <ciphershed@xxxxxxxxxxxxx>
  • Date: Tue, 17 Jun 2014 16:29:58 -0400

But the documentation is *about the code*, and so they're intrinsically linked. 
In fact, when the code changes, the corresponding documentation should 
definitely change as well (in the same commit, one could argue!). 

I haven't worked with git before, and I haven't had the chance to get my hands 
dirty in the code yet, so could you explain why it would be so messy/bad to 
have them together-ish?

Why would we want different people to have write access to either the code or 
documentation? (See changing both the code and documentation in tandem, so 
they're both correct and up-to-date)

Alain

-----Original Message-----
From: ciphershed-bounce@xxxxxxxxxxxxx [mailto:ciphershed-bounce@xxxxxxxxxxxxx] 
On Behalf Of Rocki Hack
Sent: Tuesday, June 17, 2014 16:24
To: ciphershed@xxxxxxxxxxxxx
Subject: [ciphershed] Re: Doc directory?

Think about git...
Having all the documentation commits between the actual code commits is very 
messy.

A other good reason is that you can give write access to different people!

Keep it independent from the code.



2014-06-17 22:15 GMT+02:00 Alain Forget <aforget@xxxxxxx>:


        Hm, I think a separate repository might be going a bit too far. 
Wouldn't putting it in a "/doc" directory implicitly keep it separated from the 
code?
        
        Alain
        

        -----Original Message-----
        From: ciphershed-bounce@xxxxxxxxxxxxx 
[mailto:ciphershed-bounce@xxxxxxxxxxxxx] On Behalf Of Rocki Hack
        Sent: Tuesday, June 17, 2014 16:12
        To: ciphershed@xxxxxxxxxxxxx
        Subject: [ciphershed] Re: Doc directory?
        
        Documentation is important but separate it from the code.
        
        Otherwise this will end in completely messed up commit history.
        
        What about create a second repository only for documentation?
        
        
        
        2014-06-17 15:56 GMT+02:00 Niklas Lemcke - 林樂寬 <compul@xxxxxxxxxxxxxx>:
        
        
                On Tue, 17 Jun 2014 09:32:29 -0400
                "Alain Forget" <aforget@xxxxxxx> wrote:
        
                > I second that motion (and thank you very much for tackling 
documentation!).
        
        
                I second that motion :P (the thank you)
        
        
                >
                > -----Original Message-----
                > From: ciphershed-bounce@xxxxxxxxxxxxx 
[mailto:ciphershed-bounce@xxxxxxxxxxxxx] On Behalf Of Niklas Lemcke - ???
                > Sent: Tuesday, June 17, 2014 09:09
                > To: ciphershed@xxxxxxxxxxxxx
                > Subject: [ciphershed] Re: Doc directory?
                >
                > sounds good and intuitive to me.
                >
                > On Tue, 17 Jun 2014 09:01:39 -0400
                > "Jason Pyeron" <jpyeron@xxxxxxxx> wrote:
                >
                > > I am working on source/project code related documentation 
right now, I will be
                > > commiting it to my local repo with the ultimate intention 
of making a pull
                > > request.
                > >
                > > My instinct is to create a directory "/doc" and organize 
under that. Is that an
                > > approvable name? Other input is welcome.
                > >
                > > -Jason
                > >
                > > --
                > > 
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
                > > -                                                           
    -
                > > - Jason Pyeron                      PD Inc. 
http://www.pdinc.us -
                > > - Principal Consultant              10 West 24th Street 
#100    -
        
                > > - +1 (443) 269-1555 x333 
<tel:%2B1%20%28443%29%20269-1555%20x333>  
<tel:%2B1%20%28443%29%20269-1555%20x333>             Baltimore, Maryland 21218  
 -
        
                > > -                                                           
    -
                > > 
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
                > > This message is copyright PD Inc, subject to license 
20080407P00.
                > >
                >
                >
                >
        
        
        
                --
                Niklas
        
                At the time of writing, no warrants have ever been served to 
me, Niklas
                Lemcke, nor am I under any personal legal compulsion concerning 
the
                CipherShed project. I do not know of any searches or seizures 
of my
                assets.
        
        
        
        
        
        




Other related posts: