<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>Hi Felicity,</p>
<p>A number of comments inserted into the doc below. My comments are
in italics and proceeded by <i>Cameron: ...</i><br>
</p>
<div id="content" class="wiki" style="position: relative; color:
rgb(0, 0, 0); font-family: Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif; font-size: 13px; font-style:
normal; font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; white-space:
normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width:
0px; background-color: rgb(255, 255, 255); text-decoration-style:
initial; text-decoration-color: initial;">
<div class="wikipage searchable" style="padding-left: 18px;">
<div id="wikipage" class="trac-content" style="padding: 0.5em
1em 0.5em 28px; margin: 0.3em auto 0.3em -18px; border: 1px
solid rgb(228, 228, 228); border-radius: 0.5em; box-shadow:
rgb(238, 238, 238) 0.2em 0.3em 1.5em; clear: both;">
<h1 id="Howtodocumentthequickstart" style="font-family: Arial,
Verdana, "Bitstream Vera Sans", Helvetica,
sans-serif; font-weight: bold; letter-spacing: -0.018em;
break-after: avoid; font-size: 19px; margin: 0.15em 1em
0.5em -18px;">How to document the quickstart</h1>
<h2 id="Whatisaquickstart" style="font-family: Arial, Verdana,
"Bitstream Vera Sans", Helvetica, sans-serif;
font-weight: bold; letter-spacing: -0.018em; break-after:
avoid; font-size: 16px; margin-left: -18px; border-bottom:
1px solid rgb(221, 221, 221); box-shadow: rgb(242, 242, 242)
0.1em 0.4em 0.7em 0px; padding: 0.2em 0.3em 0.1em;">What is
a quickstart?</h2>
<p>The Quickstart is designed for a new user to run through a
specific scenario. It uses numbered steps with screen shots
to create a procedure to demonstrate one or more of the
application's core functions. It should be able to be
completed in 5 to 10 minutes, and will leave the user with
an understanding of how to launch the application and get a
feel for what it can do.</p>
<p><i>Cameron: Nice intro.</i><br>
</p>
<h2 id="Wheretofindthequickstarts" style="font-family: Arial,
Verdana, "Bitstream Vera Sans", Helvetica,
sans-serif; font-weight: bold; letter-spacing: -0.018em;
break-after: avoid; font-size: 16px; margin-left: -18px;
border-bottom: 1px solid rgb(221, 221, 221); box-shadow:
rgb(242, 242, 242) 0.1em 0.4em 0.7em 0px; padding: 0.2em
0.3em 0.1em;">Where to find the quickstarts</h2>
<p>The quickstarts are located at:</p>
<p><a class="ext-link"
href="https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/quickstart"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/quickstart</a></p>
<p><i>Cameron: The quickstarts are <b>stored</b> at ...</i></p>
<p><i>Cameron: We should also list where the quickstarts are
published to.</i></p>
<h2 id="Writingaquickstart" style="font-family: Arial,
Verdana, "Bitstream Vera Sans", Helvetica,
sans-serif; font-weight: bold; letter-spacing: -0.018em;
break-after: avoid; font-size: 16px; margin-left: -18px;
border-bottom: 1px solid rgb(221, 221, 221); box-shadow:
rgb(242, 242, 242) 0.1em 0.4em 0.7em 0px; padding: 0.2em
0.3em 0.1em;">Writing a quickstart</h2>
<p>Write in a friendly, conversational style similar to the
way a teacher would talk a class through an example. The<span> </span><a
class="missing wiki" style="color: rgb(153, 153, 136);">QuickStarts?</a><span> </span>for
R and<span> </span><a class="missing wiki" style="color:
rgb(153, 153, 136);">GeoServer?</a><span> </span>do this
very well.</p>
<p><i>Cameron: It looks like hyperlinks for Quickstarts and
GeoServer are broken, and I assume you'd prefer to be
linking to R.</i><br>
</p>
<ul>
<li>Write in reStructured text (reSt) format. Docutils
provides a good reference for writing in reSt format<span> </span><a
class="ext-link"
href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html</a></li>
<li>Documentation is built using sphinx. You can use a
browser-based sphinx editor to preview your work. For
example,<span> </span><a class="ext-link"
href="https://livesphinx.herokuapp.com/"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>https://livesphinx.herokuapp.com/</a></li>
</ul>
<p>Make a copy of the quickstart template and use it as a base
to create your own quickstart:<span> </span><a
class="ext-link"
href="https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/quickstart/_template_quickstart.rst"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/quickstart/_template_quickstart.rst</a>.</p>
<p><i>Cameron:
Note, when looking at templates at this URL, comments are
not visible unless you view source (which is not obvious).
As this is a template, I'd be inclined to move
instructions out of the invisible commented ".. Writing
Tips" into visible "Writing Tips:..." with obvious
formatting show it is a comment. <br>
</i></p>
<p><i>Cameron: I see that the example is using specific udig
references. I suggest we move this to a generic example.
While we could consider a defining a new imaginary
project, I think we can relatively easily adjust the udig
example to be a "generic desktop GIS" application. Keep
almost the same as before, and just remove udig specific
references. While creating generic screen shots would be
ideal, I suggest stick with the existing udig screenshots
for the moment.<br>
</i></p>
<h3 id="Writingtips" style="font-family: Arial, Verdana,
"Bitstream Vera Sans", Helvetica, sans-serif;
font-weight: bold; letter-spacing: -0.018em; break-after:
avoid; font-size: 14px; margin-left: -18px; border-bottom:
1px dashed rgb(221, 221, 221); padding: 0.2em 0.3em 0.1em;">Writing
tips</h3>
<p><i>Cameron: I see that you have duplicated the same writing
tips in both the wiki and in the template. I'm strongly
against duplication of text. Reasons:</i></p>
<p><i>Cameron: 1. It becomes a maintenance nightmare.
Maintainers need to update docs in two places, creating
more work. <br>
</i></p>
<p><i>Cameron: 2. Incidental fixes will regularly only be
applied to one version of the docs, resulting in the docs
becoming inconsistent and often contradictory. (It appears
there are already a few inconsistencies.)<br>
</i></p>
<p><i>Cameron:3. By writing the same information in two
places, we are setting up the reader to read the same
information twice. While there are some advantages to
having the information presented differently, I think
overall it is a net loss in value.</i></p>
<p><i>Cameron: So, I propose we only store writing tips within
the template, and don't duplicate in the wiki as well.<br>
</i></p>
<p><strong>Overview section</strong></p>
<p>This section is required and has no heading. Start with a
sentence describing what the application is and does. Next,
describe what will be covered in the Quick Start. Choose a
few features to show. If you're showing one or two things,
write that in sentence format. If it's three or more, use a
bullet list. <br>
</p>
<p><i>Cameron: Nice description, especially when followed by
an example.</i><br>
</p>
<p>Optionally, you can also manage expectations about the
length of the Quick Start - how much time should the user
expect to commit to this activity?</p>
<p><i>Cameron: The above is in the template but not the wiki.
I'd suggest we shouldn't add an optional statement for
this. Either be specific about how much time is expected,
or not. I'd err on specifying time, but suggest for the
moment that we follow what most people have done to date.
I've seen both options argued. Specify time: Helps people
know how long the piece is. Don't specify time: People
might feel silly if they take too long.</i><br>
</p>
<p>Mention any prerequisites that are required to complete the
Quickstart, for example, internet connection or data to test
with.</p>
<p><i>Cameron: I suggest there should be a heading
"Prerequisites", which is optionally included.</i><br>
</p>
<p><strong>Contents list</strong></p>
<p>Use headings in your document to automatically generate a
table of contents. The headings should start with verbs, and
should be the same or similar to what you have said the
Quickstart will cover.</p>
<p><i>Cameron: I suggest we don't assume people understand
what a "verb" is. Use: "Headings should start with verbs <b>(action
words)</b>, ..."</i><br>
</p>
<p><strong>Main body of the quickstart</strong></p>
<p>Use headings to create sections and structure in the
quickstart. The heading title for the first section is
"Start application name". Include about three to five
sections, each with a heading and numbered steps,
screenshots and code blocks as required.</p>
<p>Use numbered steps to describe what to do. Steps start with
a verb or action word.</p>
<p><i>Cameron: Suggest "Steps start with a verb <b>(an action
word)</b>". </i><br>
</p>
<p>Include only one action per step. A description of the
expected result is not a new step. Refer to the Google
Developer Style guide if you need guidance:<span> </span><a
class="ext-link"
href="https://developers.google.com/style"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>https://developers.google.com/style</a></p>
<p>For images, use a scale of 50% from a 1024x768 display
(preferred) or 70% from a 800x600 display. Markup the
graphic with red circles to highlight any particular areas
of note on the GUI (if required). Store images here:<span> </span><a
class="ext-link"
href="https://github.com/OSGeo/OSGeoLive-doc/tree/master/images/projects/1024x768/"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>https://github.com/OSGeo/OSGeoLive-doc/tree/master/images/projects/1024x768/</a></p>
<p><i>Cameron: I wrote this original suggestion for screenshot
sizes and after seeing plenty feel I made the wrong
suggestion. I find that reducing the size by 50% will
often make text too small to read. A size reduction of 70%
is better. For the moment, lets keep our current
recommendation in order to stay in line with most
quickstarts, but keep this in mind for future (eg for
TheGoodDocsProject).</i><br>
</p>
<p>Notes are optional. You can use them to provide
descriptions and background information without getting in
the way of instructions. Notes are rendered in the margin in
some printed formats.</p>
<p>Tips are optional. You can use them to provide extra useful
information or other ways of performing an action like
keyboard shortcuts or drag and drop. Tips are rendered in
the margin in some printed formats.</p>
<p><strong>Things to try section</strong></p>
<p>This section is optional. Suggest one or several activities
for people to try out on their own. Present a list of ideas
for people to try out. Start off very specific with
something most people can do based on the materials as
presented. Continue on with a challenge that involves a
small bit of research. It is recommended that research be
limited to something that can be found in documentation
packaged on OSGeoLive, as users might not be connected to
the Internet.</p>
<p><strong>What next? section</strong></p>
<p>This section is required. Provide links to any further
documentation or tutorials. If your project has no further
documentation, include a link to your project's website or
wiki or include a contact email or mailing list to join.</p>
<p><i>Cameron: The following sections are not in the template
document. We should either move the content from the wiki
to the template, or reference the wiki from the template.
I'm mildly in favour of referencing the wiki from the
template. We probably should reference the wiki from the
top of the template, as well as the bottom.</i><br>
</p>
<h3 id="Notesaboutmarkup" style="font-family: Arial, Verdana,
"Bitstream Vera Sans", Helvetica, sans-serif;
font-weight: bold; letter-spacing: -0.018em; break-after:
avoid; font-size: 14px; margin-left: -18px; border-bottom:
1px dashed rgb(221, 221, 221); padding: 0.2em 0.3em 0.1em;">Notes
about markup</h3>
<p>Section headings - Use 80 characters above and below the
quickstart title. You need 80 because the title uses a slug
and we don't know how many characters the application name
is. <br>
</p>
<p><i>Cameron: I realise the term "slug" is defined below, but
it probably should be expanded here.</i><br>
</p>
<p>All other section headings characters need only be as long
as the heading.</p>
<p>Sphinx inline markup:</p>
<ul>
<li>use :guilabel: for buttons and field names</li>
<li>use :menuselection: for selecting menu items. This
typically looks something like, From the menu, choose
:menuselection:<code style="color: rgb(102, 0, 0); border:
1px solid rgb(238, 221, 204); border-radius: 0.25em;
padding: 0px 0.3em; background: rgb(250, 250, 250);">View
--> Zoom --> Zoom Out</code>.</li>
</ul>
<p>Use the asterisk symbol for unordered lists, and the hash
symbol for numbered steps.</p>
<p>Use the following for images:</p>
<dl class="wiki">
<dt style="font-weight: bold;">.. image</dt>
<dd>/images/projects/<slug>/image_name.png :scale: 70
%</dd>
</dl>
<p>Links:</p>
<ul>
<li>External<span> </span><code style="color: rgb(102, 0,
0); border: 1px solid rgb(238, 221, 204); border-radius:
0.25em; padding: 0px 0.3em; background: rgb(250, 250,
250);">link title
<a class="moz-txt-link-rfc2396E" href="http://this/is/the/external_link.html"><http://this/is/the/external_link.html></a></code><span
class="underline" style="text-decoration: underline;"><span> </span>(note
the back ticks ` and the 2 underscores at the end)</span></li>
<li>Internal :doc:<code style="color: rgb(102, 0, 0);
border: 1px solid rgb(238, 221, 204); border-radius:
0.25em; padding: 0px 0.3em; background: rgb(250, 250,
250);">../overview/<other_slug>_overview</code>.</li>
</ul>
<p>Code block</p>
<p>::</p>
<blockquote>
<p>Code starts here, (note the blank line between the<span> </span><code
style="color: rgb(102, 0, 0); border: 1px solid rgb(238,
221, 204); border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">::</code><span> </span>and
the code More code</p>
</blockquote>
<h3 id="Dataforsampleprocedures" style="font-family: Arial,
Verdana, "Bitstream Vera Sans", Helvetica,
sans-serif; font-weight: bold; letter-spacing: -0.018em;
break-after: avoid; font-size: 14px; margin-left: -18px;
border-bottom: 1px dashed rgb(221, 221, 221); padding: 0.2em
0.3em 0.1em;">Data for sample procedures</h3>
<p>To reduce disk space and maintain consistency between
applications, all Quickstarts should make use of the common
#Example_Datasets that are loaded with OSGeoLive. If the
datasets don't cover your requirements, discuss this with us
and we may add another suitable common dataset.</p>
<h3 id="OSGeoLivenotation" style="font-family: Arial, Verdana,
"Bitstream Vera Sans", Helvetica, sans-serif;
font-weight: bold; letter-spacing: -0.018em; break-after:
avoid; font-size: 14px; margin-left: -18px; border-bottom:
1px dashed rgb(221, 221, 221); padding: 0.2em 0.3em 0.1em;">OSGeoLive
notation</h3>
<p><i>Cameron: Terminology could be tweaked slightly here to
be clearer. (Vicky should be able to help here).<br>
</i></p>
<p><i>Cameron: </i><i>Define <slug>. I'm assuming it is
the projectname, as used for filenames, which is defined
in projects_info.csv.<br>
</i></p>
<p><i>Cameron: What is the difference between "variables" and
"sphinx variables"</i></p>
<p><i>Cameron: Define @OSGEO_KIND@ I assume it is a grouping
of similar project types, like Desktop GIS.<br>
</i></p>
<ul>
<li>Words surrounded by<span> </span><code style="color:
rgb(102, 0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em; background:
rgb(250, 250, 250);">< ></code><span> </span>are
to be defined by the person documenting the project
<ul>
<li><code style="color: rgb(102, 0, 0); border: 1px
solid rgb(238, 221, 204); border-radius: 0.25em;
padding: 0px 0.3em; background: rgb(250, 250, 250);"><slug></code><span> </span>is
the slug name defined on<span> </span><code
style="color: rgb(102, 0, 0); border: 1px solid
rgb(238, 221, 204); border-radius: 0.25em; padding:
0px 0.3em; background: rgb(250, 250, 250);">projects_info.csv</code><span> </span>file</li>
</ul>
</li>
<li>The project quickstartfile name is<span> </span><code
style="color: rgb(102, 0, 0); border: 1px solid rgb(238,
221, 204); border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);"><slug>_quickstart.rst</code><span> </span>for
example<span> </span><code style="color: rgb(102, 0, 0);
border: 1px solid rgb(238, 221, 204); border-radius:
0.25em; padding: 0px 0.3em; background: rgb(250, 250,
250);">udig_quickstart.rst</code></li>
<li>Words surrounded by<span> </span><code style="color:
rgb(102, 0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em; background:
rgb(250, 250, 250);">@ @</code><span> </span>are
variables</li>
<li>Words surrounded by<span> </span><code style="color:
rgb(102, 0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em; background:
rgb(250, 250, 250);">| |</code><span> </span>are Sphinx
variables</li>
</ul>
<table class="wiki" style="border: 1px solid rgb(204, 204,
204); border-collapse: collapse; border-spacing: 0px;
box-shadow: rgb(238, 238, 238) 0px 0px 1em;">
<tbody>
<tr style="font: 13px Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif;">
<th style="font: 13px Verdana, Arial, "Bitstream
Vera Sans", Helvetica, sans-serif; border: 1px
solid rgb(187, 187, 187); padding: 0.1em 0.25em;
background-color: rgb(247, 247, 247);">Variable</th>
<th style="font: 13px Verdana, Arial, "Bitstream
Vera Sans", Helvetica, sans-serif; border: 1px
solid rgb(187, 187, 187); padding: 0.1em 0.25em;
background-color: rgb(247, 247, 247);">Example</th>
<th style="font: 13px Verdana, Arial, "Bitstream
Vera Sans", Helvetica, sans-serif; border: 1px
solid rgb(187, 187, 187); padding: 0.1em 0.25em;
background-color: rgb(247, 247, 247);">Action</th>
</tr>
<tr style="font: 13px Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif;">
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">@LOGO_<slug>@</td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;"><code style="color: rgb(102,
0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">@LOGO_udig@</code></td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">Gets the logo image of the
project if it exists</td>
</tr>
<tr style="font: 13px Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif;">
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">@OSGEO_KIND_<slug>@</td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;"><code style="color: rgb(102,
0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">@OSGEO_KIND_udig@</code></td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em; text-align: right;">Gets the
logo of the kind of project within OSGeo as defined
into<span> </span><code style="color: rgb(102, 0, 0);
border: 1px solid rgb(238, 221, 204); border-radius:
0.25em; padding: 0px 0.3em; background: rgb(250,
250, 250);">projects_info.csv</code></td>
</tr>
<tr style="font: 13px Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif;">
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">@NAME_<slug>@</td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;"><code style="color: rgb(102,
0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">@NAME_udig@</code></td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">Gets the name of the project
as defined into<span> </span><code style="color:
rgb(102, 0, 0); border: 1px solid rgb(238, 221,
204); border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">projects_info.csv</code></td>
</tr>
<tr style="font: 13px Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif;">
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">@QUICKSTART_<slug>@</td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;"><code style="color: rgb(102,
0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">@QUICKSTART_udig@</code></td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">Will generate a link to the
quickstart if defined into<span> </span><code
style="color: rgb(102, 0, 0); border: 1px solid
rgb(238, 221, 204); border-radius: 0.25em; padding:
0px 0.3em; background: rgb(250, 250, 250);">projects_info.csv</code></td>
</tr>
<tr style="font: 13px Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif;">
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">@SCREENSHOT_<slug>@</td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;"><code style="color: rgb(102,
0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">@SCREENSHOT_udig@</code></td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">Places the screenshot to a
given standard size</td>
</tr>
<tr style="font: 13px Verdana, Arial, "Bitstream Vera
Sans", Helvetica, sans-serif;">
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">|version-<slug>|</td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;"><code style="color: rgb(102,
0, 0); border: 1px solid rgb(238, 221, 204);
border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">|version-udig|</code></td>
<td style="border: 1px solid rgb(204, 204, 204);
padding: 0.1em 0.25em;">Project's version defined into<span> </span><code
style="color: rgb(102, 0, 0); border: 1px solid
rgb(238, 221, 204); border-radius: 0.25em; padding:
0px 0.3em; background: rgb(250, 250, 250);">projects_info.csv</code></td>
</tr>
</tbody>
</table>
<p>Most of those variable points to data collected into a file
called<span> </span><code style="color: rgb(102, 0, 0);
border: 1px solid rgb(238, 221, 204); border-radius:
0.25em; padding: 0px 0.3em; background: rgb(250, 250,
250);">projects_info.csv</code><span> </span>that you can
find at the root of the documentation folder:<span> </span><a
class="ext-link"
href="https://github.com/OSGeo/OSGeoLive-doc/blob/b1d9cce02535fd75e9b891ebaea379103ab831bb/projects_info.csv"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>https://github.com/OSGeo/OSGeoLive-doc/blob/b1d9cce02535fd75e9b891ebaea379103ab831bb/projects_info.csv</a></p>
<p>It is a good idea to fill the projects_info.csv file first
before writing your quickstart. How to fill<span> </span><code
style="color: rgb(102, 0, 0); border: 1px solid rgb(238,
221, 204); border-radius: 0.25em; padding: 0px 0.3em;
background: rgb(250, 250, 250);">projects_info.csv</code><span> </span>is
explained here :<span> </span><a class="ext-link"
href="https://trac.osgeo.org/osgeolive/wiki/How%20to%20configure%20a%20project%20documentation"
style="text-decoration: none; color: rgb(187, 0, 0);
border-bottom: 1px dotted rgb(187, 187, 187);"><span
class="icon" style="background:
url("../extlink.gif") left center no-repeat;
padding-left: 15px;"></span>https://trac.osgeo.org/osgeolive/wiki/How%20to%20configure%20a%20project%20documentation</a></p>
</div>
<div class="trac-modifiedby" style="margin: 0.3em 0.5em; color:
rgb(136, 136, 136); font-size: 10.4px; font-style: italic;
text-align: right; float: right;"><span><a
href="https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file?action=diff&version=10"
title="Version 10 by flicstar: Removed the 'Example file
structure' section because it is duplicated in the
template." style="text-decoration: none; color: inherit;
border-bottom: 1px dotted rgb(187, 187, 187);">Last
modified</a><span> </span><a class="timeline"
href="https://trac.osgeo.org/osgeolive/timeline?from=2019-11-19T19%3A51%3A32-08%3A00&precision=second"
title="See timeline at 19 Nov 2019 19:51:32"
style="text-decoration: none; color: inherit;
border-bottom: 1px dotted rgb(187, 187, 187);">2 days ago</a></span></div>
</div>
</div>
<div id="altlinks" style="clear: both; margin-top: 0.4em;
text-align: center; color: rgb(0, 0, 0); font-family: Verdana,
Arial, "Bitstream Vera Sans", Helvetica, sans-serif;
font-size: 13px; font-style: normal; font-variant-ligatures:
normal; font-variant-caps: normal; font-weight: 400;
letter-spacing: normal; orphans: 2; text-indent: 0px;
text-transform: none; white-space: normal; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
background-color: rgb(255, 255, 255); text-decoration-style:
initial; text-decoration-color: initial;">
<h3 style="font-family: Arial, Verdana, "Bitstream Vera
Sans", Helvetica, sans-serif; font-weight: bold;
letter-spacing: normal; break-after: avoid; font-size: 12px;
margin: 0px;">Download in other formats:</h3>
</div>
<div class="moz-cite-prefix">On 21/11/19 4:14 pm, Felicity Brand
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CAEz4wU0-TuUfqMaZUs5-U_JBLFeBN89FmPGA24mZtiNgS2H6tQ@mail.gmail.com">
<pre class="moz-quote-pre" wrap="">Hello,
I have done some work updating the 'How to document the quickstart
file' page on the wiki and the template for the quickstart.
They should go hand-in-hand (I have linked from each to each other.)
I'm not sure where users might start, so I was trying to cover
different angles of entry.
I would appreciate a review of the page and the template - preferably
by the end of next week which is the conclusion of the Season of Docs
period.
<a class="moz-txt-link-freetext" href="https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file">https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file</a>
Thanks
Felicity
_______________________________________________
osgeolive mailing list
<a class="moz-txt-link-abbreviated" href="mailto:osgeolive@lists.osgeo.org">osgeolive@lists.osgeo.org</a>
<a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/osgeolive">https://lists.osgeo.org/mailman/listinfo/osgeolive</a>
</pre>
</blockquote>
<pre class="moz-signature" cols="72">--
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant
M +61 (0) 419 142 254</pre>
</body>
</html>