[Qgis-community-team] FOSS4G UK QGIS Documentation Workshop

[DelazJ]

Hi Nick,

Thanks for this initiative. Good to know. We'll try to be responsive to the
PRs so that they really see how quickly and easily they can contribute to
the project. I guess you already know about the step-by-step guidelines [1]
(which shows that git is not a requirement for anyone willing to step in
documentation); there are also some video materials [2] Alexandre Neto has
recently pushed online that can be of interest for people.

About using Ubuntu, we have decided months ago that it's no longer a
requirement. If you browse the docs we already have a mixture of different
platforms. So good to do with what your attendees have. Guidelines were not
updated accordingly. Should be fixed after [3].
<https://github.com/qgis/QGIS-Documentation/pull/4229>

About the easy tags, that's too bad! I've closed a bunch of them few days
ago. I'd have known... Anyways, what would be the QGIS version of your
audience? Browsing the list of "easy"-tagged issues, many are of 3.10
milestone, meaning QGIS master. I'm not sure it's what people will be
using. So it could be nice if we can do some efforts to tag more "easy"
issues in older releases beforehand. "Processing Alg" tagged issues [3] are
not necessarily set as easy but they could be; most of the times, it's
about copy-pasting an older one and do the few tweaks relative to the alg.

Régis, I think Documentation (and translation, for non english communities)
are workshops we should try to always have in our meetings (foss4g FR but
also QGIS FR)

Have fun, and yes, tell us how you go.

[1]
https://docs.qgis.org/testing/en/docs/documentation_guidelines/first_contribution.html
[2] https://www.youtube.com/watch?v=PCiohDt-OBk for the part 1
[3]https://github.com/qgis/QGIS-Documentation/pull/4229
[4]
https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+label%3A%22Processing+Alg%22

Regards,
Harrissou

Le jeu. 12 sept. 2019 à 08:17, Régis Haubourg <regis.haubourg at gmail.com> a
écrit :

> Hi Nick,
> Great move. I think I will push the idea of documentation and translation
> workshops for the next foss4g FR. If we can achieve nice material, we could
> even go to something that can be used by all user groups with osgeolive
> easily. My idea would be to attempt to have local user groups,
> universities, engineer schools use it everywhere.
> Tell us how it goes!
>
> Concerning the Ubuntu use, I have no opinion at this stage.
> Régis
>
> Le mer. 11 sept. 2019 à 19:10, Nick Bearman <
> nick at geospatialtrainingsolutions.co.uk> a écrit :
>
>> Hello,
>>
>> I am running a short (90 min) session on QGIS Documentation
>> <https://b-rowlingson.gitlab.io/workshopbookings/contributing-to-qgis-documentation/>
>> at the FOSS4G UK 2019 Conference in Edinburgh
>> <https://uk.osgeo.org/foss4guk2019/>. The session is next Friday and I
>> wanted to give you (QGIS Documentation Team) the heads up (as I plan to
>> actually get people to do some editing for QGIS Documentation in the
>> session) and ask a couple of questions.
>>
>> *Firstly, apologies for the late notice of this - I have been manically
>> busy so have not been able to put as much time into this as I would have
>> liked. *
>> *Secondly, just for background I have been following the discussions from
>> Cameron / Andreas / Regis / Matteo / Anita / Harrissou / Alexandre and
>> others on SeasonOfDocs and QGIS, which has been very interesting. Thanks
>> all for your comments, and sorry I could not take part more in this. *
>>
>> It is a fairly short session and I want people to get something tangible
>> out of this. I am planning to start off with an explanation of the QGIS
>> Documentation, why it is important to contribute and so on. The attendees
>> in the session are likely not to have any experience of Git, so I am
>> planning on walking them through the process of making a fork, editing a
>> file and submitting a PR on an example repository, so they get used to the
>> principles. Then I will explain how QGIS Documentation on GitHub works, and
>> I would ideally like to be able to get them to actually make an edit and
>> submit a PR on the real documentation. I have seen the list of Easy issues (
>> https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+label%3AEasy)
>> and am going to suggest they each try one of those. There are quite a few
>> screenshots / new features ones so will direct them towards these.
>>
>> One thing I would like to highlight / question is that on
>> https://docs.qgis.org/testing/en/docs/documentation_guidelines/writing.html#managing-screenshots page,
>> the info for screenshots implies that a Ubuntu operating system is required
>> to make screenshots. Is this the case? I can see how this is a nice to have
>> for consistency, but I think this is a blocker for anyone who wants to
>> contribute screenshots who doesn't use Ubuntu (and I think that is a large
>> chunk of people). There is some infrastructure for screenshots already, so
>> should I advise newbies to have a go at screenshots (neglecting the
>> requirement for Ubuntu/Unity), or are there better areas for them to focus
>> on?
>>
>> After they have made a change, I will ask them to tag me (@nickbearman)
>> in the PR comments, so I can track contributions and help/comment as
>> required.
>>
>> I have also been asked to lead a session on QGIS Documentation on the
>> Saturday hackathon, so I hope to get some larger bits done myself as well.
>>
>> I hope this is useful as a heads up for you. Do you have any suggestions
>> for newbie issues to recommend them? I'm also open to any other comments
>> and suggestions that people would like to make.
>>
>> Best wishes,
>> Nick.
>>
>> --
>> Nick Bearman
>> 01209 808910 | 07717745715
>> nick at geospatialtrainingsolutions.co.uk
>>
>> Due to my own life/work balance, you may get emails from me outside of
>> normal working hours. Please do not feel any pressure to respond outside of
>> your own working pattern.
>> _______________________________________________
>> Qgis-community-team mailing list for organizing community resources such
>> as documentation, translation etc..
>> Qgis-community-team at lists.osgeo.org
>> https://lists.osgeo.org/mailman/listinfo/qgis-community-team
>
> _______________________________________________
> Qgis-community-team mailing list for organizing community resources such
> as documentation, translation etc..
> Qgis-community-team at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-community-team
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20190912/f915df81/attachment.html>