[Qgis-community-team] Documentation writers meeting during HF

[DelazJ]

 Hi all,

Matteo, you were quicker than me. Since I won't be at the hackfest, i was
preparing a kind of wishlist; They are not necessarily things to discuss
(some of them have been long standing and sometimes longly debated) but I
hope most of them get done. HF is unfortunately the single moment where
many people will get involved in docs improvement so let's take that
advantage to fix things that complicate doc writers life.

#. Fix the help button in QGIS being broken each time the link in the doc
has moved or changed a bit, with nobody noticing it: see [0] with all the
links that mention it, as places it has been rediscussed
#. Review the doc site look (template, css, ) - see from [1]
#. Review the doc build instructions in the readme file of the repository
and ensure they work for all platforms (I personally abandon doc building
on Windows though it's my working env - I don't think that travis should be
the place to check our changes)
#. Fix script to clean the repo from obsolete/unused image files ( see [2]
and some of the other backend tagged issue reports [3])
#. Fix automatic screenshot generation [4]
#. and, a bit aside though related to writing, Add translation guidelines
for desktop translators and make them accessible to all as a welcome
message on Transifex, or in the signature of the translation group. see [5]
and a quick tip at [6]
#. Close 2.16 and 2.18 milestones issues

I'd also like to react on the stale bot activation. I really don't
understand what it's needed for, if I understood the discussion that was
held at the time:
- if the PR is from a person with commit rights, if not reviewed and IF he
reminds the others but failed to get their review (did we ever get to
this?), he/she simply has to merge, no need for a bot
- if the PR is from any other contributor, closing it because none of the
reviewers has time will simply make people frustrated. What would have
resolved the closure of the PR? What should it resolve actually? Most of
the PR allow maintainers to push changes to them so if it's a good but
abandoned PR, better keep it along and complete and merge it when a
maintainer feels interested.
For me, the problem of the queue in doc repo is not in the Pull request tab
but in the Issues one.
Of course I don't want to hijack this thread with that issue, simply wanted
to express my opinion regarding this imho risky decision.

[0]
https://github.com/qgis/QGIS-Documentation/pull/2258#issuecomment-352246124
[1]
https://github.com/qgis/QGIS-Documentation/pull/3112#issuecomment-436201322
[2] https://github.com/qgis/QGIS-Documentation/issues/3205
[3] https://github.com/qgis/QGIS-Documentation/labels/Backend
[4] https://github.com/qgis/QGIS/pull/8041
[5] https://github.com/qgis/QGIS-Website/issues/592
[6] https://github.com/qgis/QGIS/pull/9331

Have a nice QGIS week,
Harrissou

Le mar. 5 mars 2019 à 12:30, Richard Duivenvoorde <rdmailings at duif.net> a
écrit :

> On 05/03/2019 10.58, matteo wrote:
> > Hi guys,
> >
> > I want to propose the doc writer and contributors have a meeting during
> > the hackfest. Several topics to discuss, here a short list on my mind:
> >
> > * branching the new LTR release
> > * direct integration of transifex and github [0]
> > * PR cue (stale bot...)
> > * helping new contributors
> > * cleaning issues list
> > * pyqgis cookboox (integration of pyqgis samples of Thomas Gratier [1]
> >
> > Other ideas?
> >
> > Who is coming to the Hackfest?
>
> Hi Mattea,
>
> I am, and I'm in the workshop area now.
>
> Yep, let's just plan a meeting, maybe Thursday morning?
>
> After showing somebody the trick to write some docs I'm even more
> convinced that we REALLY REALLY need the help of developers.
> I do  not want to point to somebody, but just open some of the doc
> writer issues:
>
> https://github.com/qgis/QGIS-Documentation/milestone/10
>
> then try to place yourself in the shoes of a (less technical) doc writer
> and try to figure out what is meant by the short sentence OR what
> exactly is build... OR how to create a quick screenshot (without the
> sometimes specially prepared data the developer had).
>
> I do not want to sound negative, but I think it's almost not doable.
>
> Doc writer really need more help/information/screenshots to get going.
>
> But let's discuss in the meeting (but I hope also some devs read this :-) )
>
> Regards,
>
> Richard Duivenvoorde
> _______________________________________________
> 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/20190305/18e3aa49/attachment-0001.html>