[SeasonOfDocs] Suggested plan for Swapnil's SeasonOfDocs/GeoNetwork work

[Byron Cochrane]

Hi All,

Sorry about the slow response. Been a bit overloaded with things to get done by the end of Thursday this week.
Friday would be about the only availability I have this week for a meeting. Jo at least should be in this call. Paul and others more involved would also be useful. My bandwidth for unpaid work is a bit maxed out right now but will contribute what I can.

Francois Prunayre (a core GN developer) organised a documentation codesprint a few weeks ago and made some good progress against my spreadsheet. Several people from our group participated including Jo Cook, Maria Arias de Reyna, and Paul van Genuchten. I was not able to participate to any significant degree myself.  Jo should be able to give good feedback on how that progressed. I would think that this document codesprint, its progress and results should be a good point for relaunching our efforts here. I would think it useful to contact Francois to get his perspective on a way forward.

I have also been looking for an excuse to contact Simon Pigot (another GN core developer - Aus based).  He seems to be getting somewhat active again. I could contact him to get his thoughts?

Cheers,
Byron Cochrane






OpenWork Ltd
Nelson, New Zealand
byron at openwork.nz
+64 21 794 501
https://www.openwork.nz/

“The whole problem with the world is that fools and fanatics are so certain of themselves, yet wiser people so full of doubt” - Bertrand Russell

> On 12/12/2019, at 11:29 PM, Cameron Shorter <cameron.shorter at gmail.com> wrote:
> 
> I had a chat with Swapnil today. I'm mindful that the doc task for GeoNetwork is huge, and that there is more than one person is going to be able to do in 3 months. So lets be strategic in how we make use of Swapnil's time.
> 
> My suggestions:
> 
> * Swapnil has had problems getting GeoNetwork installed on Windows 10. I've suggested installing on Ubuntu or Lubuntu, probably in VirtualBox, maybe also look at OSGeoLive installed into VirtualBox. (Some GeoNetwork folks might be able to give better advise.
> 
> * I think that Swapnil should start to build up a best practices recommended architecture for an Open Source docset (based on https://www.divio.com/blog/documentation/ )
> 
> * He should then audit existing docs against best practices to create a gap analysis. (For OSGeoLive work, Felicity gave a 5 start rating to all 50 Quickstarts she worked on. Maybe do something similar).
> 
> * This should lead to a very large potential body of documentation work to be done, from which Swapnil should focus on specific parts.
> 
> * Focus should be on helping amplify the writing effectiveness of existing volunteer writers.
> 
> * This might involve providing writing templates (which are starting to emerge in TheGoodDocsProject)
> 
> * We should also provide a checklist about what docs should have before they are considered "done". The GeoNetwork Project Steering Committee probably should consider that a feature is not considered complete until it has docs which meet the minimal requirements of this checklist.
> 
> * I know Byron (and others?) have started a doc audit and built a spreadsheet.
> 
> * Would it be possible to get Byron, Swapnil, me (and others?) onto a call within the next week? Byron, what is your availability like? Maybe a weekday evening, or most times during this weekend should work for me. (Byron is in New Zealand, Swapnil and I are both in the same timezone in Melbourne/Sydney). Anyone else want to be included in this call?
> 
> -- 
> 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/20191216/27336b5c/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: openwork_favicon__white96x96.png
Type: image/png
Size: 1113 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20191216/27336b5c/attachment.png>