[Qgis-developer] [Qgis-community-team] Moving the install instructions to a more sexy, visible, coherent and translatable page in qgis.org

Tim Sutton tim at kartoza.com
Tue May 17 23:24:05 PDT 2016


Hi


After rereading the thread I think I am +1 for moving to RST in the QGIS Docs repo with the following thinking:

* all the good stuff Junior mentioned like translatability, visibility etc.
* when we hit release freeze we could copy the latest output from sphinx (maybe generated as plain text file?) to INSTALL.txt and remove the sources for the install docs from the QGIS code tree. That way the QGIS sources always contain the current notes for that release and the doc sources contain only the most recent procedure.
* we could add a note in the docs sources saying ‘these instructions are for the current state of the develop branch only, for version specific install procedures, please see the INSTALL.txt in the source tree for that release’

I think that workflow is not too much different from the current system. Of course someone needs to volunteer to get all the processes above into place :-P

@Jürgen regarding your comments below, I used to use apt-get build-dep too but I actually like the explicit package list your script generates more in some ways because it is deterministic compared to build-dep which will only reflect the deps from the current latest package in apt sources.

Regards


Tim

> On 17 May 2016, at 19:50, Richard Duivenvoorde <rdmailings at duif.net> wrote:
> 
> 
> Personally I'm ok with moving to rst / docs with the following arguments:
> - it can be translated
> - it is easier searchable (google)
> - it will hopefully kept uptodate by more people because they try the
> instructions and report back
> 
> Only reason NOT doing it was because in an earlier hackfest (when I
> already put them to rst), I thought Juergen told me something about
> scripts which kept the files uptodate.
> 
> IF only the apt-get lines are truely updated in that way, I'm ok with
> moving.
> 
> Plz others speak out.
> 
> Regards,
> 
> Richard
> 
> On 17-05-16 11:46, DelazJ wrote:
>> Hi all,
>> So, is any decision taken about this? Does it seem feasible?
>> 
>> Regards,
>> Harrissou
>> 
>> 
>> 2016-04-25 17:19 GMT+02:00 Jürgen E. <jef at norbit.de <mailto:jef at norbit.de>>:
>> 
>>    Hi Richard,
>> 
>>    On Sat, 23. Apr 2016 at 16:53:46 +0200, Richard Duivenvoorde wrote:
>>> @jef: maybe you can elaborate a little more on this?
>> 
>>    You're probably referring to scripts/scandeps.pl
>>    <http://scandeps.pl>.  That updates the apt-get
>>    install lines in doc/linux.t2t from the packaging files in debian/
>> 
>>    But that's about it.  I'm not sure those are actually necessary -
>>    I'd try to
>>    keep specific versions from the descriptions if possible.  As that's
>>    what tend
>>    to outdate quickly and point to the packaging files instead, because
>>    those are
>>    actually used and maintained.
>> 
>>    BTW I for instance don't go through manually setting up the build
>>    with cmake
>>    for development, but produce packages once (or sometimes even kill
>>    the build
>>    half way) and keep using that build directory for development (both
>>    on linux
>>    and windows).
>> 
>>    On Debian that complains about what dependencies are missing anyway
>>    - so having
>>    the apt-get install list above isn't necessary.  You could also just
>>    add the
>>    nightly repository for the distribution you target and run apt-get
>>    build-dep
>>    qgis and achieve the same.
>> 
>> 
>> 
>>    Jürgen
>> 
>>    --
>>    Jürgen E. Fischer           norBIT GmbH             Tel.
>>    +49-4931-918175-31 <tel:%2B49-4931-918175-31>
>>    Dipl.-Inf. (FH)             Rheinstraße 13          Fax.
>>    +49-4931-918175-50 <tel:%2B49-4931-918175-50>
>>    Software Engineer           D-26506 Norden
>>     http://www.norbit.de
>>    QGIS release manager (PSC)  Germany                    IRC: jef on
>>    FreeNode
>> 
>>    _______________________________________________
>>    Qgis-developer mailing list
>>    Qgis-developer at lists.osgeo.org <mailto:Qgis-developer at lists.osgeo.org>
>>    List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
>>    Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer
>> 
>> 
>> 
>> 
>> _______________________________________________
>> Qgis-community-team mailing list for organizing community resources such as documentation, translation etc..
>> Qgis-community-team at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>> 
> 
> _______________________________________________
> Qgis-developer mailing list
> Qgis-developer at lists.osgeo.org
> List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer

—






Tim Sutton

Co-founder: Kartoza
Project chair: QGIS.org

Visit http://kartoza.com to find out about open source:

Desktop GIS programming services
Geospatial web development
GIS Training
Consulting Services

Skype: timlinux
IRC: timlinux on #qgis at freenode.net


Kartoza is a merger between Linfiniti and Afrispatial

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20160518/7e04c7ee/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: KartozaNewLogoThumbnail.jpg
Type: image/jpeg
Size: 6122 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20160518/7e04c7ee/attachment-0001.jpg>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 455 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20160518/7e04c7ee/attachment-0001.sig>


More information about the Qgis-developer mailing list