1. Oslc-Op
  2. Topics

Hugo Templates for documentation

Jory Burson
 

Jim, Alex, Andrew et al,

Came across this new set of templates for Hugo Google has in beta and I thought it might be interesting to ya'll: https://github.com/google/docsy

- Jory
Andrii Berezovskyi
 

Thanks Jory!

Gabriel, what do you think about incorporating this on open services?

Jim, Jad, if it’s not feasible to incorporate on the main site, we can use it for the devguide, which I suggested to migrate to Hugo some time ago.

--
/Andrew
(from phone)

1 juli 2019 kl. 20:02 skrev Jory Burson <jory.burson@...>:

Jim, Alex, Andrew et al,

Came across this new set of templates for Hugo Google has in beta and I thought it might be interesting to ya'll: https://github.com/google/docsy

- Jory
Jim Amsden
 

It would be hard to justify the resource to migrate the current OSLC Developer Guide material in any way. If we can utilize docsy for new stuff without breaking the old, then that's fine.



--
Jim Amsden, Senior Technical Staff Member
ELM Quality Manager
919-525-6575




From:        "Andrii Berezovskyi" <andriib@...>
To:        "oslc-op@..." <oslc-op@...>
Cc:        "gabriel.fernandes@..." <gabriel.fernandes@...>
Date:        07/01/2019 02:17 PM
Subject:        [EXTERNAL] Re: [oslc-op] Hugo Templates for documentation
Sent by:        oslc-op@...



Thanks Jory!

Gabriel, what do you think about incorporating this on open services?

Jim, Jad, if it’s not feasible to incorporate on the main site, we can use it for the devguide, which I suggested to migrate to Hugo some time ago.

--
/Andrew
(from phone)

1 juli 2019 kl. 20:02 skrev Jory Burson <jory.burson@...>:

Jim, Alex, Andrew et al,

Came across this new set of templates for Hugo Google has in beta and I thought it might be interesting to ya'll: https://github.com/google/docsy

- Jory
Andrii Berezovskyi
 

I agree that it should be a good effort but I think Jim was referring to the amount of effort he already spent with Gatsby on https://oslc.github.io/developing-oslc-applications/ 😊

 

--

–Andrew.

 

P.S. I think you need to subscribe to the list first but I have changed the setting to allow emails from non-subscribers too, so let’s see how it works!

 

Från: Gabriel Fernandes <gabriel.fernandes@...>
Datum: måndag, 1 juli 2019, W27 23:08
Till: Andrii Berezovskyi <andriib@...>
Ämne: Fw: Re: [oslc-op] Hugo Templates for documentation

 

Tried sending this to the oslc-op email but got a non-delivery report. Forwarding to you so you also get the answer

 

From: Gabriel Fernandes
Sent: Monday, July 1, 2019 6:03 PM
To: Jim Amsden; oslc-op@...
Subject: Re: Re: [oslc-op] Hugo Templates for documentation

 

I see no problem using docsy.

It would have to be a separate site (something like docs.open-services.org maybe?) as it's a Hugo theme, and supporting multiple themes in a single site is not natively supported. It could work in our favor to do that as providing access for collaboration could be easier since collaborators would only need access to the documentation repository and not the whole site.

The way I see it, this should be the opportunity to either create new documentation (that replaces the old) or to migrate any still relevant documentation into it. Having a single consolidated source of documentation, in my opinion, is the best user experience we can provide. That leads to easier adoption, easier discussions, easier contributions and so on.

That said we could easily just add new stuff without breaking any existing documentation.

Best,
Gabriel Fernandes

From: Jim Amsden <jamsden@...>
Sent: Monday, July 1, 2019 3:58 PM
To: oslc-op@...
Cc: Gabriel Fernandes
Subject: Re: Re: [oslc-op] Hugo Templates for documentation

 

It would be hard to justify the resource to migrate the current OSLC Developer Guide material in any way. If we can utilize docsy for new stuff without breaking the old, then that's fine.



--
Jim Amsden, Senior Technical Staff Member
ELM Quality Manager
919-525-6575




From:        "Andrii Berezovskyi" <andriib@...>
To:        "oslc-op@..." <oslc-op@...>
Cc:        "gabriel.fernandes@..." <gabriel.fernandes@...>
Date:        07/01/2019 02:17 PM
Subject:        [EXTERNAL] Re: [oslc-op] Hugo Templates for documentation
Sent by:        oslc-op@...




Thanks Jory!

Gabriel, what do you think about incorporating this on open services?

Jim, Jad, if it’s not feasible to incorporate on the main site, we can use it for the devguide, which I suggested to migrate to Hugo some time ago.

--
/Andrew
(from phone)

1 juli 2019 kl. 20:02 skrev Jory Burson <jory.burson@...>:

Jim, Alex, Andrew et al,

Came across this new set of templates for Hugo Google has in beta and I thought it might be interesting to ya'll: https://github.com/google/docsy

- Jory

1 - 4 of 4