[Qgis-community-team] Fwd: training manual update
Janneke van Dijk
janneke.qgis at gmail.com
Thu Feb 23 12:24:12 PST 2017
Next try, it seems the message body too big.
-------- Forwarded Message --------
Subject: training manual update
Date: Thu, 23 Feb 2017 16:36:09 +0300
From: Janneke van Dijk <janneke.qgis at gmail.com>
To: qgis-community-team at lists.osgeo.org
Dear Harissou, dear list,
Let's see if this now works via the list, indeed better to keep it public.
I will use 2.18.3 as reference. I'm working on Windows, not sure what to
do with the screenshots as the 'standard' is to use linux for
uniformity, but VM is not working very smoothly for me. Any suggestions?
I'll have some time tomorrow to get into it, will start from the
beginning and see what it brings. Is there a practical way to discuss
proposed changes, something similar to comments in Word? Or does that
come for each change following a PR?
I'm sure I'll have plenty of questions tomorrow...
Janneke
Hi Janneke,
2017-02-21 17:33 GMT+01:00 Janneke van Dijk <jvandijk at chanzo.nl
<mailto:jvandijk at chanzo.nl>>:
Hi Harissou,
Thanks for your extended explanation!
So, I've got a github account, set it up with source tree, cloned
the repo.
Good. If you have question on github/git, do not hesitate either.
I had a look at the open issues you mentioned, but with none of them
it's completely clear to me what should be done (I guess I was
hoping there was a very concrete and clear issue to be starting with
and get me over my cold water fear....). In addition, should these
be done bearing in mind 2.14 or 2.18? (not sure if it makes a
difference).
Yes.. To be honest, the easiest issues have been fixed and those
available mostly require to have a global overview of the manual or a
precise knowledge of the context - I guess it's the main reason they are
not yet tackled
About the release to focus on, I'd say: "Just forget 2.14"; it's now an
old release and our main target is to release a doc few weeks after a
ltr is released (hopefully, for 3.2?), so we should not spend energy on
such an old release.
As it is my plan for the next few days to go systematically through
the training manual, it would make sense to me to either make
necessary changes/updates as I encounter them, or somehow keep track
of them.
Yes do it that way, and if you find issues you can't fix alone, please
report it and we'll try together.
To make the changes as I encounter them, I would need to know what
version to change it for, wouldn't I? If it were for 2.18, would I
still have to wait until further notice, or could I get started
already? As I'm completely new to github and collaborating this way
I have no idea what the most efficient/useful workflow would be in
this situation.
Of course, if it doesn't make sense to get started already I'd
better wait until further notice.
Target 2.18, please. There are imo less changes between 2.18 and 3.0
than between 2.0 and 2.18. So the doc would still be more up to date
when time comes for a newer release. Some points that we'd need to check
in the manual:
- steps to reach some tools
- screenshots (some instructions at
http://docs.qgis.org/testing/en/docs/documentation_guidelines/writing.html#managing-screenshots)
In your first message, you mentioned that you were struggling to reach
qgis-community list. Any news on this issue? I think it'd be nice to
discuss doc contribution steps (and especially beginners integration) in
that list to attract more users and help demystify things.
I've been contacted recently by another user willing to contribute so
maybe we are at a period where we can catch more writers.... and
"coaching" in mailing-list sounds more long-term efficient (and helpful
for more people) than chatting in a restricted group: let's be open... :)
If there are any points I didn't address let me know...
Looking forward to writing doc with you,
Harrissou
thanks for your advice,
Janneke
On 20-Feb-17 19:17, DelazJ wrote:
> Hi Janneke,
>
> Thanks for offering your help. The Training Manual is indeed from
> an old release and would really deserve some love and time (few
> fixes these last years). So, if you wish to improve/update it, I
> can ensure you that you are more than welcome. Everybody is
> welcome to contribute to QGIS (including documentation,
> translation, bug reports and fixes...)
>
> What are the plans... ?
> * Except for fixes, we no longer work on QGIS 2.14 documentation
>
> * For QGIS Documentation, I think that due to some recent news,
> there will probably be a 2.18 (LTR?) doc release.
> When? Don't know yet. But unless there's enough activity in the
> repo to fix remaining bugs, I'd say maybe middle march (this is
> actually the deadline *I set to myself *to stop contributing to
> the 2.x bug fixes). Of course, we can extend that if need be.
>
> That means that with the 2.18 doc release, we'd embed a Training
> manual which could be updated or no, depending on contributions.
> However, I'm not enough involved in this chapter to tell you if
> you should better rework it from a 2.18 perspective or wait for a
> 3.0. In a recent discussion in psc-list, Paolo Cavallini (cc-ed)
> offered to maintain the Processing part of the manual
> (https://lists.osgeo.org/pipermail/qgis-psc/2017-January/005048.html
> <https://lists.osgeo.org/pipermail/qgis-psc/2017-January/005048.html>).
> Maybe he has a better overview and can help you decide.
>
> Meanwhile, given that you are ready to help now, there still are
> some issues in the QGIS-Documentation repo that need to be tackled
> (https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+label%3A%22Training+Manual%22
> <https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+label%3A%22Training+Manual%22>).
>
> * we might be waiting for a consensus or an authoritative
> decision (?) to begin working on QGIS 3 doc (so no plans for the
> moment)
>
> As I have already mentioned, you are welcome. Feel free to ping
> any of us if you need some help. Note that we've set up a doc
> guidelines to help people contribute at
> http://docs.qgis.org/testing/en/docs/documentation_guidelines/index.html
> <http://docs.qgis.org/testing/en/docs/documentation_guidelines/index.html>.
> The http://qgis.org/en/site/getinvolved/document.html
> <http://qgis.org/en/site/getinvolved/document.html> page might
> also be of interest. Use it and never hesitate to ask for
> clarifications so that we guide you or send feedbacks so that we
> improve it.
>
> Regards,
>
> Harrissou
>
>
> 2017-02-20 12:50 GMT+01:00 Janneke van Dijk <jvandijk at chanzo.nl
> <mailto:jvandijk at chanzo.nl>>:
>
> Dear all,
>
> I'm struggling contacting the community list directly, so I'm
> trying directly to the three of you now (advised by Richard).
>
> As far as I can tell the Training Manual is based on 2.0
> (http://docs.qgis.org/testing/en/docs/training_manual/introduction/preparation.html
> <http://docs.qgis.org/testing/en/docs/training_manual/introduction/preparation.html>).
> Are there plans to update it to 2.14/2.18/3? I may be able to
> contribute time for this, but I will need some help getting
> started. Let me know if I can contribute.
>
> Thanks,
>
> Janneke
>
>
> --
>
> Janneke van Dijk
> Geographical Information Systems specialist
> mobile: +255 784 684835 <tel:+255%20784%20684%20835>
> email: jvandijk at chanzo.nl <mailto:jvandijk at chanzo.nl>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20170223/e4108ea2/attachment.html>
More information about the Qgis-community-team
mailing list