[Qgis-community-team] QGIS Docs in GIT

[yjacolin at free.fr]

Hello,

I have some experience with other translation I made for other project (ie MapServer, OpenLayers, GDAL-OGR, GeoServer).

Currently I have my own repository here https://github.com/yjacolin/GeoDocFr for OpenLayers and GDAL-OGR. MS translation is in the SVN trunk.

For GDAL-OGR I have for each section one page and some metadata at the end of the file, see sourcecode of https://github.com/yjacolin/GeoDocFr/blob/master/gdal/gdal/gdal_translate.rst (by default github render rst file in html for my github). Metadata are mainly date, authors and commit number. This way I know from which commit I have to begin the diff. GDAL-OGR follow the svn trunk. OpenLayers also.

For OL, I am following commit ML so I know when a change has been made in the doc dir but there too few changes in the doc.
For GDAL-OGR, I take sometime regularly to update the doc using commit number because there is too much changes.

GDAL-OGR keep historic information in the doc, new feature are tagged with "(from version 1.9)" for instance. So for me it is not a problem to not follow exactly the release of GDAL-OGR. People can know which new feature will be in the next release.

QGIS is a little bit different. But I think documentation release mean we will have a commit number (a start and end of the english update process). Start will be the commit number of the previous release, end will be the last change just before the release.

Translation process can occurs either in the same time as the english release is updated (not so good imho) or after the release. 

One issue: if you tag an english release, french documentation won't be up to date. When we will tag the french release, english doc will be the future release. I don't know if git allow a tag for a specific directory in the repository. If so it will be the good way. This is the main problem we need to address.

I don't know if it helps, anyway :)

Y.

----- Mail original -----
De: "Otto Dassau" <dassau at gbd-consult.de>
À: qgis-community-team at lists.osgeo.org
Envoyé: Samedi 12 Novembre 2011 09:43:39
Objet: Re: [Qgis-community-team] QGIS Docs in GIT

Hi Jean Roc, all,

Am Fri, 11 Nov 2011 23:27:53 +0100
schrieb MORREALE Jean Roc <jr.morreale at enoreth.net>:

> Le 10/11/2011 23:30, Tim Sutton a écrit :
> > Hi Otto&  other community members
> >
> > I have migrated the documentation to git. Please have a play around
> > and see if everything is as expected before you start doing any
> > serious work. Otto and I will probably do some more tweaks over the
> > hackfest this weekend. The repository is available here:
> >
> > git at github.com:qgis/QGIS-Documentation.git
> >
> > Best regards
> >
> > Tim
> >
> 
> Hi, this is great. I'll create a french_fr folder at the root level when 
> the translation of the manual 1.7 is over.
> 
> I guess we will not longer create branches for a new version but only 
> add git tag, right ?

what I have in mind / on the todo list is:

- create QGIS-Documentation repository (done)
- add trunk from svn (done)

then, we probably should migrate also the tags and branches to keep all the
work we have done so far in the new git repository. Or does it make more
sense to leave it in svn or to create a backup and close svn docs repo? I
don't know but would prefer to still have it all available in the git
environment.

then we need to define how to structure the docs repo in the future. How
should it be managed?

in svn:

- english master in trunk
- english tagged versions in tags
- translation in branches

in git: 

- ?

And we need to update all the howto documentation in the wiki. 

Is that all?

Regards
Otto











 





_______________________________________________
Qgis-community-team mailing list
Qgis-community-team at lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/qgis-community-team