[OSGeoLive] Quick starts template question (Season of Docs)

[Felicity Brand]

I checked the history of the toc file but it was inconclusive :-)
Looks like it's been there a while. Vicky Vergara might have a
recollection about it.

I see what you're saying: It is unlikely someone would stumble upon
the URL unless they guessed the name of the file and manually typed it
in to their browser.
Okay, I can look at modifying the uDig file to make it less uDiggy and
more templatey.

I'll add that to my list of to-dos.

Thanks
Felicity

On Tue, Oct 15, 2019 at 2:48 PM Cameron Shorter
<cameron.shorter at gmail.com> wrote:
>
> I'm not sure what the toc.rst file is doing in the directory. I suspect it probably should be removed, or maybe it is being pulled in by a template. If you check the version history you should be able to find out who created it, then ask them.
>
> Re creating a new template.rst: The template.rst will not be findable from other docs if no one links to it. However, I'm pretty sure the html page is created and accessible from say https://live.osgeo.org/en/quickstart/template_quickstart.html . That is ok. (We have previously allowed emerging projects to create their Project Overview on OSGeoLive, but not linked into the main docs as a stepping stone to getting included into OSGeoLive.)
>
> On Tue, 15 Oct 2019 at 14:35, Felicity Brand <felicitybrand at gmail.com> wrote:
>>
>> In the OSGeoLive-doc\doc\quickstart directory, there's a file called
>> `toc.rst` that has the following contents:
>> --------------------------
>> .. only:: latex
>>    .. toctree::
>>      :maxdepth: 1
>>      :glob:
>>      *_quickstart
>> -----------------------------
>>
>> I can't read the code but didn't want to plonk a new file called
>> "template.rst" into the directory in case this code is generating an
>> automatic list of quickstarts that displays somewhere important.
>> Would this be why you embedded writing instructions into a quickstart
>> in the first place, rather than having it in its own file?
>>
>> On Mon, Oct 14, 2019 at 9:11 PM Cameron Shorter
>> <cameron.shorter at gmail.com> wrote:
>> >
>> > While it would be ok to put into the udig_quistart.rst, I agree that it would be better to have a template_quickstart.rst. Erin, a Google tech writer recently made the comment that there are downsides with selecting an exemplar project (as we have done):
>> > 1. The exemplar project is likely to change, and need updating, and might not be exemplar any more.
>> > 2. There is potential other projects get jealous about not being selected as an exemplar project.
>> > An alternative she suggested is to create a simple imaginary project (maybe about mapping time-travel through worm holes in space, or something equally silly).
>> >
>> > On Mon, 14 Oct 2019 at 11:06, Felicity Brand <felicitybrand at gmail.com> wrote:
>> >>
>> >> Hi all,
>> >> I realized that before I do my dry run-though, I need to submit a PR
>> >> with my changes to the Quick Start template. My changes are in the
>> >> "Writing tips" sections.
>> >>
>> >> At the moment, these writing tips are embedded in the
>> >> uDig_quickstart.rst
>> >> https://github.com/flicstar/OSGeoLive-doc/blob/master/doc/quickstart/udig_quickstart.rst
>> >>
>> >> Is this where we want to keep them? I wonder if a new file called
>> >> "template_quickstart.rst" would be better?
>> >>
>> >> Please advise.
>> >> Thanks
>> >> Felicity
>> >> _______________________________________________
>> >> osgeolive mailing list
>> >> osgeolive at lists.osgeo.org
>> >> https://lists.osgeo.org/mailman/listinfo/osgeolive
>> >
>> >
>> >
>> > --
>> > Cameron Shorter
>> > Technology Demystifier
>> > Open Technologies and Geospatial Consultant
>> >
>> > M +61 (0) 419 142 254
>> >
>> >
>> >
>
>
>
> --
> Cameron Shorter
> Technology Demystifier
> Open Technologies and Geospatial Consultant
>
> M +61 (0) 419 142 254
>
>
>