[Qgis-psc] Draft call for documentation contributors

Tim Sutton tim at kartoza.com
Mon Dec 4 09:49:36 PST 2017


Hi Yves and Harissou

Thank you so much for your inputs - I have updated and published the blog post here based on your feedback:

https://wordpress.com/post/blog.qgis.org/1929

Regards

Tim

> On 04 Dec 2017, at 14:30, Yves Jacolin <yjacolin at free.fr> wrote:
> 
> Hello Tim,
> 
> Big thanks to you and all the PSC. I have a lot of frustration about documentation as I don't have as much time as I would like for working on this. I really want to improve this but for now this call for contributors is warmly welcome! Unfortunately, I can't go to the next hackfest (I have a "customer" sprint plus a QGIS training at the same time).
> 
> About your article, we have also a documentation for doc writer that could help new contributors (http://docs.qgis.org/2.18/en/docs/documentation_guidelines/ <http://docs.qgis.org/2.18/en/docs/documentation_guidelines/>). Here a proposition:
> 
> If you need some help how to start, you can read the <link>documentation for contributors</link>. You can also contact the team for custom help (link to community mailing list).
> Y.
> 
> Le 04/12/2017 à 12:52, DelazJ a écrit :
>> Hi Tim,
>> Thanks for this draft. Some first thoughts:
>> - When mentioning the "Sphinx based documentation", maybe could we add link to documentation guidelines
>> - we could also mention that there some issue reports that are tagged "easy" to lower the barrier for beginners (if needed). Btw, it could be nice if some doc team members could review the list and check whether there could be more "easy"-tagged issues (I tried but i don't know all the areas of QGIS, hence can't always evaluate whether an issue is easy to fix or not).
>> - I saw a call recently (from Alexandre?) arguing that writing doc is a good way to learn new features. Maybe we could also use that argument to show them other nice side of writing.
>> 
>> Sorry to just come with "suggestions" instead of "rewriting".
>> 
>> Regards,
>> Harrissou
>> 
>> 2017-12-03 22:21 GMT+01:00 Tim Sutton <tim at kartoza.com <mailto:tim at kartoza.com>>:
>> Hi Yves and Harrisou
>> 
>> I have drafted a blog article to try to get more documentation help in for the QGIS 3.0 release. Could you guys review it and let me know if there is anything else you would like to add / change (text below).
>> 
>> Also just a reminder that there is budget for  supporting documentation - please use it if you can think of ways that money will productively improve and streamline the documentation process. Andreas can provide more details of available funs if needed. Draft text follows:
>> 
>> 
>> 
>> ————
>> 
>> Documentation for QGIS 3.0 - call for contributions!
>> 
>> Dear QGIS users, enthusiasts and fine people out there. QGIS 3.0 is coming very soon....we are in a 'soft freeze' state at the moment while we wait for some critical last pieces of code to get finalised. Then we go into hard freeze and prepare to roll out our next major release. Those of you that have been playing with the '2.99' builds will surely have noticed that QGIS 3.0 is going to feature a huge number of improvements and new features - both in the user interface and in the API and code internals.
>> 
>> But we have a BIG problem:
>> we need your help to document and describe all those fine new features!
>> 
>> Yes fine reader now is the time to break out of the 'passive user of QGIS' mould you might find yourself in and lend a hand. We have an issue tracker with an issue for each of the new features <https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22QGIS+3.0%22> that has landed in QGIS 3.0. Even if you do not know how to use our Sphinx based documentation system, you can help tremendously by preparing the prose that should be used to describe new features and attaching it to the issue list linked to above. If you do that, the documentation team can do more editorial work and less  'writing from scratch' work. If you want to see the QGIS Documentation <http://docs.qgis.org/2.18/en/docs/user_manual/> up-to-date for the version 3.0 release, please do get involved and help Yves Jacolin and the documentation team!
>> 
>> 
>> 
>> 
>> ———————
>> 
>> Regards
>> 
>> 
>> 
>>  <qgis-icon-60x60.png>
>> 
>> 
>> 
>> ---
>> 
>> Tim Sutton
>> QGIS Project Steering Committee Chair
>> tim at qgis.org <mailto:tim at qgis.org>
>> 
>> 
>> 
>> 
>> 
> 
> _______________________________________________
> Qgis-psc mailing list
> Qgis-psc at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-psc

—







Tim Sutton

Co-founder: Kartoza
Project chair: QGIS.org

Visit http://kartoza.com <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

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20171204/a50c80d9/attachment.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-psc/attachments/20171204/a50c80d9/attachment.jpg>


More information about the Qgis-psc mailing list