[SeasonOfDocs] TheGoodDocsProject: Templates repo proposal

Jo Cook jo.k.cook at gmail.com
Wed Jul 31 03:44:31 PDT 2019


Hi Erin,

I'm keen on keeping the templates in their own repsitory, so a big +1 on
that. I'm less worried about the structure within it.

My thoughts are as follows:

1) People downloading the templates want the templates and not the website
2) We can, if we choose, create releases and downloads, and/or link to the
repository as a submodule in other repositories like the website or the
documentation
3) We can customise pull request templates and such like to fit the
repository much better

All the best

Jo

On Tue, Jul 30, 2019 at 10:46 PM Erin McKean <emckean at google.com> wrote:

> Hi folks!
>
> As discussed in today's meeting, should we have a separate repo just for
> templates? This would be CC-0 licensed and the "how-to" documentation would
> link to it.
>
> Structure TBD, but the general idea would be to have folders for types of
> templates and then 'blessed' examples for each use case.
>
> E.g. for READMEs, the structure would be:
> -- Templates repo
>   -- CONTRIBUTING.md
>   -- LICENSE.md
>   -- READMEs folder
>       README.md (this is the blessed template)
>       OTHER READMES folder (these would be other examples)
>       README_README.md (the README for how to use the README template
> ...🤔 perhaps this wasn't a very clear example)
>
> Please +1/-1/0 to show your approval, rejection, or 'meh' reactions before
> next week's meeting if possible?
>
> Thanks!
>
> Erin
>
> --
> Erin McKean | Developer Relations Program Manager, Open Source Strategy |
> emckean at google.com | she/her
>
> _______________________________________________
> SeasonOfDocs mailing list
> SeasonOfDocs at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>


-- 
------------------------
http://about.me/jocook
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190731/e66f701f/attachment.html>


More information about the SeasonOfDocs mailing list