[SeasonOfDocs] [Qgis-community-team] [OSGeoLive 13.0] QGIS 3.4 overview and quickstart overhaul

Cameron Shorter cameron.shorter at gmail.com
Fri Jun 21 16:53:19 PDT 2019


Advice that Hamish Bowen provided a few years back, and is now included 
in OSGeoLive writing tips is:

https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20a%20project

Header logo:

  * Stored
    here:​https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/images/projects/<project>/
  * Filename should be "logo-<project>.png"
  * Should have a transparent background (not white)
  * Stored in size 125x125 pixels (for use in Project Overview
    andQuickStarts?)
  * For PNGs run a program like​pngcrush
    <http://packages.ubuntu.com/pngcrush>or​optipng
    <http://packages.ubuntu.com/optipng>to reduce the size of the image
    without degrading quality. For example:

optipng -o5 image.png

  * Preferably also available as SVG, stored as "logo-<project>.svg"

On 22/6/19 9:47 am, Jared Morgan wrote:
> Would it be possible to automate the process?
>
> https://blog.codeship.com/automating-screenshots-in-documentation/
>
> There is good prior art in this space for Python bots.
>
> Jared Morgan
> M: +61413005479
> Google+ 
> <https://plus.google.com/u/0/117309635670089895654/posts/p/pub> | 
> Twitter <http://twitter.com/!#/jaredmorgs> | Facebook 
> <http://facebook.com/jaredmorgs>
>
>
>
>
> On Fri, 21 Jun 2019 at 10:42, Ori Gudes <o.gudes at unsw.edu.au 
> <mailto:o.gudes at unsw.edu.au>> wrote:
>
>     Talking about “capturing screenshots of QGIS” I have been do it a
>     lot (lately) and would be interested to know about efficient ways
>     to improve this process.
>
>     Thanks Ori
>
>     *Dr. Ori Gudes*
>     *Research Fellow, City Futures Research Centre*
>     Built Environment
>
>     UNSW SYDNEY NSW 2052 AUSTRALIA
>     T: +61 (2) 93855255
>
>
>     E: o.gudes at unsw.edu.au <mailto:o.gudes at unsw.edu.au>
>     W: cityfutures.net.au <http://www.cityfutures.net.au/>
>
>     *List of publications
>     <https://www.dropbox.com/s/dffaa4qzb1py5kj/Publications_Gudes26042019.pdf?dl=0>
>     * (updated April 2019)
>
>     *From:*SeasonOfDocs <seasonofdocs-bounces at lists.osgeo.org
>     <mailto:seasonofdocs-bounces at lists.osgeo.org>> *On Behalf Of
>     *Andrew Jeffrey
>     *Sent:* Friday, 21 June 2019 10:31 AM
>     *To:* Cameron Shorter <cameron.shorter at gmail.com
>     <mailto:cameron.shorter at gmail.com>>
>     *Cc:* qgis-community <qgis-community-team at lists.osgeo.org
>     <mailto:qgis-community-team at lists.osgeo.org>>; Osgeolive
>     <osgeolive at lists.osgeo.org <mailto:osgeolive at lists.osgeo.org>>;
>     SeasonOfDocs at lists.osgeo.org <mailto:SeasonOfDocs at lists.osgeo.org>
>     *Subject:* Re: [SeasonOfDocs] [Qgis-community-team] [OSGeoLive
>     13.0] QGIS 3.4 overview and quickstart overhaul
>
>     Hi Cameron,
>
>     Having a poke around on the Osgeo Live website and when it comes
>     to virtual machines all I can seem to find is V12.0.
>
>     Is there a version 13 pre-release so that people interested in
>     improving the Quickstarts can use it for capturing screenshots of
>     QGIS (or any app) in the OS that the Ogeo live will be using?
>
>     Thanks
>
>     Andrew
>
>     On Mon, Jun 3, 2019 at 9:31 PM Cameron Shorter
>     <cameron.shorter at gmail.com <mailto:cameron.shorter at gmail.com>> wrote:
>
>         Hi Belinda and Liam,
>
>         It was great to have breakfast with you this morning and
>         discuss how you might want to get involved in SeasonOfDocs.
>
>         As promised, here is an email thread with ideas so far about
>         updating Quickstarts/Overviews for QGIS which will be a really
>         good starting point for you both (with your QGIS background).
>
>         The How to Get started with OSGeoLive docs is halfway through
>         transitioning from an old system to new (sorry for the mess):
>
>         Old:
>         https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
>
>         New:
>         https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20a%20project
>
>         If you get stuck, which is highly likely, feel free to ask one
>         of us CCed.
>
>         Good luck, Cameron
>
>         On Sat, 25 May 2019 at 06:20, Cameron Shorter
>         <cameron.shorter at gmail.com <mailto:cameron.shorter at gmail.com>>
>         wrote:
>
>             Hi Harrissou, my comments are inline:
>
>             On Fri, 24 May 2019 at 19:48, DelazJ <delazj at gmail.com
>             <mailto:delazj at gmail.com>> wrote:
>
>                 Hi all,
>
>                 Nicolas, what's the deadline for the release?
>
>             Our OSGeoLive schedule is here:
>             https://docs.google.com/spreadsheets/d/1kO6zzmLFfprZGgp5x7Sjwi-EVN6NTGDR4KXvFVtNpR0/edit?hl=en_GB&hl=en_GB#gid=0
>
>             English versions of Project Overviews and Quickstarts are
>             to be updated and reviewed by  9 July 2019
>
>                 I think you hit two items that are not covered even in
>                 our official documentation so tackling these would
>                 benefit to both docs:
>
>                 - the Overview: we have a list of features at [1] but
>                 it's also not fully updated at the moment [2}
>
>                 - the Quickstart (something we don't have): but we
>                 neither finished updating our screenshots [3] - some
>                 might already be available to pick in the repo though.
>
>                 What I want to say, refering to our own undone
>                 changes, is that this is an opportunity to fix two
>                 important features for both projects.
>
>             I agree Harrissou, aligning QGIS and OSGeoLive core
>             documentation would be excellent. It is something I'm
>             hoping we can trail in our SeasonOfDocs initiative with
>             QGIS and GeoNetwork, and later introduce to other OSGeo
>             projects.
>
>                 And afaics it doesn't require specific advanced
>                 skills, so I'd invite people willing to help in
>                 documentation to give it a try. Could be a good
>                 starting point. The visual changelogs might also help
>                 to find some main features [4].
>
>             Yes, these are less complicated tasks and a good starting
>             point. I've been learning from tech writers that we should
>             be careful to avoid words like "easy", or "just do ....".
>             Tasks which developers find easy (like using git or RST)
>             have a high barrier-to-entry for experienced writers (such
>             as an ex-English teacher who came to our last FOSS4G
>             community day).
>
>             Our Howto-write-OSGeoLive docs have become harder to
>             follow as we have been automating our build process. (I'm
>             hoping we will improve this as part of SeasonOfDocs).
>             Links from: https://trac.osgeo.org/osgeolive
>
>                 About OSGeoLive, am I right that there's no html doc
>                 online and if i want to view the docs I have to either
>                 run the dvd/usb/VM or build it myself as explained in
>                 the ReadMe [5]?
>
>             You can see docs from our latest release here:
>             http://live.osgeo.org/en/overview/overview.html
>
>                 Regarding the quickstart (/talking about the concept
>                 of quickstart since I haven't seen the OSGeoLive's one
>                 and don't know if it duplicates things we already
>                 have/), I wonder if it's not something we can consider
>                 having next or within QGIS docs. There might be ways
>                 to bridge both resources, actually just display on
>                 QGIS Docs website the quickstart from OSGeoLive-Docs.
>                 Sphinx-gurus? And that would help QGIS documenters be
>                 more concerned (talking about me at least) with
>                 OSGeoLive docs, bridge the projects and there might be
>                 more advantages.
>
>             Yes, I really like this idea, and would be interested to
>             see how we can pursue this.
>
>                 Regards,
>
>                 Harrissou
>
>                 [1]
>                 https://docs.qgis.org/3.4/en/docs/user_manual/preamble/features.html
>
>                 [2] https://github.com/qgis/QGIS-Documentation/issues/2286
>
>                 [3] https://github.com/qgis/QGIS-Documentation/issues/2441
>
>                 [4]
>                 https://qgis.org/en/site/forusers/visualchangelogs.html
>
>                 [5]
>                 https://github.com/OSGeo/OSGeoLive-doc#building-osgeolive-documentation
>
>                 Le jeu. 23 mai 2019 à 09:33, Nicolas Roelandt
>                 <roelandtn.pro at gmail.com
>                 <mailto:roelandtn.pro at gmail.com>> a écrit :
>
>                     Hi dear QGIS community members,
>
>                     OSGeoLive has reached alpha2 stage with QGIS 3.4.6
>                     installed. [1]
>
>                     OSGeoLive 12.0 was with QGIS 2.18 and the current
>                     documentation was written for this version.
>
>                     At OSGeoLive, we think that the new version of
>                     QGIS is a good opportunity to rework on the QGIS
>                     overview [2] and quickstart [3] and reflects its
>                     new functionnalities. So we are looking for
>                     volunteers to help us improve the docs and take
>                     new screenshots.
>
>                     You can work directly on the files or interact in
>                     the dedicated ticket [4] or within our mailing
>                     list [5].
>
>                     Thanks for your help from the OSGeoLive Community.
>
>                     Yours sincerely,
>
>                     Nicolas Roelandt
>
>                     OSGeoLive PSC
>
>                     OSGeo-fr board
>
>                     OSGeo charter member
>
>                     [1]
>                     http://osgeo-org.1560.x6.nabble.com/OSGeoLive-13-0-status-alpha2-td5405559.html
>
>                     [2]
>                     https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/overview/qgis_overview.rst
>
>                     [3]
>                     https://github.com/OSGeo/OSGeoLive-doc/blob/master/doc/quickstart/qgis_quickstart.rst
>
>                     [4]
>                     https://trac.osgeo.org/osgeolive/ticket/2136#ticket
>
>                     [5] osgeolive at lists.osgeo.org
>                     <mailto:osgeolive at lists.osgeo.org>
>
>                     _______________________________________________
>                     Qgis-community-team mailing list for organizing
>                     community resources such as documentation,
>                     translation etc..
>                     Qgis-community-team at lists.osgeo.org
>                     <mailto: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
>                 <mailto:Qgis-community-team at lists.osgeo.org>
>                 https://lists.osgeo.org/mailman/listinfo/qgis-community-team
>
>
>         -- 
>
>         Cameron Shorter
>
>         Technology Demystifier
>
>         Open Technologies and Geospatial Consultant
>
>         M +61 (0) 419 142 254
>
>         _______________________________________________
>         SeasonOfDocs mailing list
>         SeasonOfDocs at lists.osgeo.org <mailto:SeasonOfDocs at lists.osgeo.org>
>         https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>
>     _______________________________________________
>     SeasonOfDocs mailing list
>     SeasonOfDocs at lists.osgeo.org <mailto:SeasonOfDocs at lists.osgeo.org>
>     https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>
-- 
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant

M +61 (0) 419 142 254

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190622/6ce39532/attachment-0001.html>


More information about the SeasonOfDocs mailing list