<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>Google Doc works for me too.<br>
</p>
<div class="moz-cite-prefix">On 22/8/19 11:41 pm, Clarence Cromwell
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CAJ5hSbaz8SDZdxxuABkEdMMNZ1q48OF26kb4XMGDsgeU+SnwYA@mail.gmail.com">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<div dir="ltr">I'm in favor of a Google doc, so everyone can
contribute or make comments. </div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Wed, Aug 21, 2019 at 11:47
PM Felicity Brand <<a href="mailto:felicitybrand@gmail.com"
moz-do-not-send="true">felicitybrand@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">Thanks Clarence! I think I had an action item
on me to make a google doc to get this started.
<div><br>
</div>
<div>What I can do is grab the ideas you've shared here, put
them in a google doc and add my ideas too...</div>
<div><br>
</div>
<div>Or is there another way? Like, is a google doc the best
way? Should I be doing something in one of our github
repos instead?</div>
<div><br>
</div>
<div>Felicity</div>
<div><br>
</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Thu, Aug 22, 2019 at
2:11 PM Clarence Cromwell <<a
href="mailto:clarencewcromwell@gmail.com"
target="_blank" moz-do-not-send="true">clarencewcromwell@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>We have to start somewhere. If the quickstart is
going to be our first template, here are some ideas to
include in it. I will also look at examples of some of
the quickstarts I've worked on to see if they give me
any more ideas. </div>
<div><br>
</div>
<div>Can anyone add to this?</div>
<br>
<div>My ideas to contribute to a quickstart template. </div>
<div><br>
</div>
<div>1.) The main body should follow these guidelines. </div>
<div><br>
</div>
<div>* It should be a clear, concise, step-by-step
tutorial (A set of numbered steps)</div>
<div>* It should describe the easiest way to use the
API, as opposed to the most optimized production modes
or most advanced uses </div>
<div>* It should be explaining the basic operations that
most users will want to perform on the site, or the
operations they will perform first. </div>
<div>* Each step should contain all the information
necessary to complete it. And the Quickstart should
not contain any additional info that is not
needed--because it will be easier to understand if it
is as brief as possible. </div>
<div>* It should include code samples (examples) that
users can copy and paste. For each step that the user
has to perform. (If it's an API)</div>
<div>* Each example should be explained in comments that
follow directly after the example, so newcomers can
quickly understand how the API works </div>
<div><br>
</div>
<div>2.) The quickstart should not include: <br>
</div>
<div><br>
</div>
<div>* Setup information</div>
<div>* Things that belong in the reference section, like
authentication, throttling, error codes, a complete
description of any feature.</div>
<div>* Things that belong in the overview (a general
description of the product; what it can do; what it
can't do)</div>
<div><br>
</div>
<div>3.) Links to external examples. The quickstart
template should include a list of examples of good
quickstarts that you can check out for comparison. It
should discuss what we like or don't like about each
example. </div>
<div><br>
</div>
<div><br>
</div>
<div><br>
</div>
</div>
_______________________________________________<br>
SeasonOfDocs mailing list<br>
<a href="mailto:SeasonOfDocs@lists.osgeo.org"
target="_blank" moz-do-not-send="true">SeasonOfDocs@lists.osgeo.org</a><br>
<a
href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a><br>
</blockquote>
</div>
</blockquote>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
SeasonOfDocs mailing list
<a class="moz-txt-link-abbreviated" href="mailto:SeasonOfDocs@lists.osgeo.org">SeasonOfDocs@lists.osgeo.org</a>
<a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</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>