[SeasonOfDocs] TheGoodDocsProject: Docsy template

[Sanket Totewar]

Additional findings:
I installed Docsy <https://github.com/google/docsy> on a local Hugo
instance and added the OpenAPI spec shortcode
<https://github.com/tenfourty/hugo-openapispec-shortcode> to the site.

This allows us to add API Reference Docs for specific endpoints as a part
of a help guide, which might prove useful if we expose APIs in the
future. Example here: https://www.tenfourty.com/hugo-oai-swagger-example/

Cheers!

On Wed, Aug 14, 2019 at 4:08 AM Erin McKean <emckean at google.com> wrote:

> Hey folks, looks like there are only ~4 + for setting up a Docsy site? We
> can discuss today if people have been abstaining or if I set the target too
> high. :)
>
> Thanks!
>
> Erin
>
> On Thu, Aug 1, 2019 at 1:35 PM Cameron Shorter <cameron.shorter at gmail.com>
> wrote:
>
>> +0 . I don't have experience in this, nor a strong opinion, however I've
>> added a + to my vote as I like the logic provided by those voting before me.
>>
>> Cameron
>> On 31/7/19 7:24 pm, Jo Cook wrote:
>>
>> I'm a big fan of hugo too, so yes let's go ahead with this +1.
>>
>> We can definitely do subdomains.
>>
>> Jo
>>
>> On Wed, Jul 31, 2019 at 1:55 AM Jared Morgan <jaredleonmorgan at gmail.com>
>> wrote:
>>
>>> As Jessica Parsons from Netlify told us all at WTD AU, if you are going
>>> to choose a Static Site Generator the best option is to choose one that
>>> uses a framework your team (Devs in the context Jess was speaking about)
>>> can develop with.
>>>
>>> Choosing Hugo is fine, but it may mean that those folks used to using
>>> Python based docs tooling may not be able to help out as easily with site
>>> maintenance.
>>>
>>> If that is not a concern then full steam ahead with Hugo.
>>>
>>> On Wed., 31 Jul. 2019, 07:41 Erin McKean, <emckean at google.com> wrote:
>>>
>>>> Hi folks! As an example of a website for open-source projects, I'd like
>>>> to set up a Docsy site for the GDP.
>>>>
>>>> Docsy is a Hugo-based static site that is set up for OSS projects. I
>>>> think it could live at docsy.thegooddocsproject.dev, if we have
>>>> subdomain options for that domain.
>>>>
>>>> More info on Docsy is at docsy.dev.
>>>>
>>>> If you are okay with this, +1 by Aug 8? If I get 5 +1s I'll go ahead
>>>> and set it up. :)
>>>>
>>>> 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
>>>>
>>> _______________________________________________
>>> SeasonOfDocs mailing list
>>> SeasonOfDocs at lists.osgeo.org
>>> https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>>>
>>
>>
>> --
>> ------------------------
>> http://about.me/jocook
>>
>> _______________________________________________
>> SeasonOfDocs mailing listSeasonOfDocs at lists.osgeo.orghttps://lists.osgeo.org/mailman/listinfo/seasonofdocs
>>
>> --
>> Cameron Shorter
>> Technology Demystifier
>> Open Technologies and Geospatial Consultant
>>
>> M +61 (0) 419 142 254
>>
>> _______________________________________________
>> SeasonOfDocs mailing list
>> SeasonOfDocs at lists.osgeo.org
>> https://lists.osgeo.org/mailman/listinfo/seasonofdocs
>>
>
>
> --
> 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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190814/d8e3b55b/attachment.html>