<div dir="ltr"><div>Hi All,</div><div><br></div><div>So I could tick off at least one of my actions straight away, I've created a new section in <a href="https://wiki.osgeo.org/wiki/Season_of_Docs_Ideas_2019#GeoNetwork">https://wiki.osgeo.org/wiki/Season_of_Docs_Ideas_2019#GeoNetwork</a> to show examples of portal-specific user guidance. If you know of any others, please add them.</div><div><br></div><div>Thanks</div><div><br></div><div>Jo<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Jun 27, 2019 at 11:36 AM Jo Cook <<a href="mailto:jo.k.cook@gmail.com">jo.k.cook@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>Hi All,</div><div><br></div><div>We had a very productive call to kick off work on the Geonetwork Season of Docs initiative today- thanks to all who attended. Here are my notes and the actions I captured:</div><div><br></div><div>Present:</div><div>Jo, Cameron, Maria, Paul, Byron</div><div><br></div><div>Notes:<br></div><div><br></div><div>1) We need a way for users to informally comment on the existing documentation, where a github issue is maybe not the best method, or to allow people who are not comfortable with github to contribute. We also have a need for people with little or no programming experience to review the Quick Start guide, to ensure it is complete, accessible, and does what it's supposed to. For the qgis project, a google doc version of the documentation has been useful, which people can then add comments to. </div><div><br></div><div>Actions: <br></div><div>* Jo to create google docs version of the quick start guide, add it to the season of docs wiki, and circulate for comment.</div><div>* All- publicize this to get as much feedback as possible</div><div><br></div><div>2) We need to review the current documentation to quickly flag up areas that are incomplete, missing, or outdated. This seems like a big task, but if the documentation is broken down to it's sub-heading level, and different people take different sections, it should be manageable. Problems should be submitted as github issues.<br></div><div><br></div><div>Actions:</div><div>* Byron to create spreadsheet of documentation headings (to sub-heading level, eg User Guide | Harvesting would be one entry), add a link to it from the Season of Docs wiki and share it widely.</div><div>* All- share it widely to ensure we cover all elements</div><div><br></div><div>3) Is there a way that we can add a comment option in sphinx for ongoing informal capturing of feedback after this initiative finishes? The problem with feedback is finding somewhere for the messages to go to. Note that after the call, I found an option to embed disqus comment forms in sphinx (<a href="https://pypi.org/project/sphinxcontrib-disqus/" target="_blank">https://pypi.org/project/sphinxcontrib-disqus/</a>) which is not ideal but might be a way forward.</div><div><br></div><div>4) Areas requiring a lot of attention are schema plugins and layout customisation. Hopefully this should be improved as part of the documentation review above.</div><div><br></div><div>5) How can we ensure that new features, or Pull Requests that relate to a big interface or usage change are flagged up at the time? For example, looking at the changelog for 3.6.0 (<a href="https://geonetwork-opensource.org/manuals/trunk/en/overview/change-log/version-3.6.0.html" target="_blank">https://geonetwork-opensource.org/manuals/trunk/en/overview/change-log/version-3.6.0.html</a>) there are some new features that should be documented. We don't want this to add to the burden of the developers, so how can we minimise the work for them?</div><div><br></div><div>Actions:</div><div>* Jo volunteers to review the changelog for new releases to flag up what needs documenting.</div><div>* Paul to ask the rest of the developers how we can best ensure new features are flagged up and documented.</div><div><br></div><div>6) Are there any user guides for specific (customised) portals that we could use for examples and for improving the generic user guide?<br></div><div><br></div><div>Actions:</div><div>* Jo to send link to Scottish Spatial Data Infrastructure</div><div>* All- any other examples?</div><div><br></div><div>++++++++++++++++++++++</div><div><br></div><div>I think those are the key points and actions- correct me if I'm wrong! We're hoping to make this a regular fortnightly call at this time, people can dip in and out as they wish.</div><div><br></div><div>Thanks again to everyone that attended</div><div><br></div><div>Jo<br></div><div><br>-- <br><div dir="ltr" class="gmail-m_6972423419933493886gmail_signature">------------------------<br><a href="http://about.me/jocook" target="_blank">http://about.me/jocook</a></div></div></div>
</blockquote></div><br clear="all"><br>-- <br><div dir="ltr" class="gmail_signature">------------------------<br><a href="http://about.me/jocook" target="_blank">http://about.me/jocook</a></div>