[Qgis-community-team] Move documentation guidelines to Website

DelazJ delazj at gmail.com
Thu Jan 2 09:23:21 PST 2020


Hi Alexandre,
Thanks for taking care of this.

I'm OK with detaching the static docs from our doc release mechanism. But
i'm really unsure whether the website is the right place for them.
I regularly feel lost when I browse our website. I personally find it
crowded, hard to guess under which header i can find an information, and
I'm not sure that moving these docs will not just... hide them among tons
of other things --> conclusion,: QGIS website needs more love, cleanup
first (or a split? but this is not the topic here although...)

I think the static docs deserve to be close to the release-based
documentation, as they share more together: I think they should be listed
at https://www.qgis.org/en/docs/index.html and should use the same theme as
the docs. So i think, if they have to move to another repository, maybe a
new repo based on the doc's one. This means that we should maybe postpone
the split, update docs sphinx thingies first and then extracts folders of
interest to that "duplicate" repository. The hard work would be done in the
docs repo and all is about fixing references.
If we go that way, the next point would be which name, url to use to
publish these docs... no idea!

I don't know whether I've been helpful here but...

Regards,
Harrissou





Le jeu. 2 janv. 2020 à 18:09, Paolo Cavallini <cavallini at faunalia.it> a
écrit :

> Thanks Alexandre for this. I'd be in favour of take this chance to
> converge towards a simple, more vanilla sphinx structure, if possible.
> Cheers.
>
> Il 02/01/20 01:08, Alexandre Neto ha scritto:
> > Hi everyone,
> >
> > I have started working on reducing the QGIS-Documentation "docs".
> >
> > "My" idea would be to remove any static documents, that is, any document
> > that doesn't really change with a new version of QGIS.
> >
> > I am starting with the Documentation Guidelines. Unfortunately, the move
> > is not as simple as copy-pasting some folder from one repo to another.
> > That's because the two sphinx project uses different extensions, folder
> > structure, etc...
> >
> > So, before I carry on with it, I wanted to know if there are any
> > objections to the move.
> >
> > Next, it would be the developers guide.
> >
> > Thanks,
> >
> > Alexandre Neto
> >
> > _______________________________________________
> > 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
> >
>
> --
> Paolo Cavallini - www.faunalia.eu
> QGIS.ORG Chair:
> http://planet.qgis.org/planet/user/28/tag/qgis%20board/
> _______________________________________________
> 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/20200102/9fdbf0e7/attachment.html>


More information about the Qgis-community-team mailing list