Re: Where do I stick development documentation?

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Aug 12, 2010, 02:39 UTC
Message-ID: <20100812023922.GB19174@burratino>
In-Reply-To: <AANLkTi=dS1DYJ3MB-Du34sVPy8Qw8VNck=Lx54DtSfO0@mail.gmail.com>

Ævar Arnfjörð Bjarmason wrote:

Show 9 quoted lines

> There's some documentation aimed at developing that I'd like to see /
> write in Git at some point.
> 
> Developing:
> 
>    * How to work with Gettext
> 
>    * How to write portable code, i.e. constructs to avoid in C / shell
>      script etc (these keep coming up).

Maybe:

 Documentation/technical/api-gettext.txt
 Documentation/CodingGuidelines
 Documentation/PlatformNotes

or some variations on the theme?

>    * How to deal with gettext / submit po files / keep them up to date
>      etc.

gittranslation.7?

>    * Core git concepts (that need to be translated), maybe I could
>      adopt the gitglossary to this task, but it'd need to be a bit
>      more structured, i.e. describe core data concepts first, then
>      some other terms.

That sounds good. Once we develop infrastructure for translating manpages, we could encourage translators to do gitglossary first to standardize terminology.

>      Actually, on that point, do we have documentation that describes
>      git's data model in one place? I.e. everything from blobs to
>      trees, how raw commit objects etc. look. Something like "Git for
>      computer scientists".

Hopefully some pic wizard can convert that to nroff. :)

I think Tommi Virtanen should be easy to reach in case anyone wants to try adapting the article somehow.

Hope that helps, Jonathan