[Qgis-community-team] About documentation : line size

[DelazJ]

Hi,
It would be worth stating this somewhere in the Documentation guidelines.
Not all people willing to help in the documentation are coders.

More generally, there's an ongoing work to put more _developer's_
documentation in QGIS-Website (
http://qgis.org/en/site/getinvolved/development/qgisdevelopersguide.html).
I think we should use this to also add/mix information about how being a
good contributer in documentation and website sides (since you need to know
git, rst... and rules: where should I report the issues? Even where are the
repo is not really evident when you are beginner...). Most of the
informations about reporting issues in the website is about QGIS
application.
At the other hand, there's already a Documentation Guidelines (
http://docs.qgis.org/testing/en/docs/documentation_guidelines/index.html -
only used for documentation and not for the website afaics) that doesn't
really cover the above aspects but help about rules in Documenting.
Should it be removed and its content mixed in QGIS-website? A rst guru to
write the guidelines about using ReStructuredText?
I think it's a good step to have all these resources at a single place.
Any comments?


2015-12-16 14:18 GMT+01:00 Alexander Bruy <alexander.bruy at gmail.com>:

> Hi Yves,
>
> I strongly agree that we need to keep some reasonable line
> size in the all documentation. Editing very long lines is difficult
> as well as examining changes in them.
>
>
> 2015-12-16 12:24 GMT+02:00 Yves Jacolin <yjacolin at free.fr>:
> > Hello,
> >
> > In code source there is some "standards" and good practice as limite the
> line
> > length to 80 letters.
> >
> > Is it something we want to do also in documentation? I would say yes, we
> want
> > as all documentation seems to follow this rule but there is some PR which
> > change this.
> >
> > Any though?
> >
> > Thanks,
> >
> > Y.
> > _______________________________________________
> > 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
>
>
>
> --
> Alexander Bruy
> _______________________________________________
> 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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20151217/a0c0afb6/attachment.html>