spinkube / documentation

Site and Docs for the SpinKube community project
https://www.spinkube.dev/
Apache License 2.0
16 stars 23 forks source link

Configure Hugo & Docsy to render the docs as a public-facing website via GitHub pages #32

Closed tpmccallum closed 8 months ago

tpmccallum commented 8 months ago

This task may be a little bit early (understanding that rendering a private repay maybe be difficult, and when the repo is public, this task may be easier). Just wanted to get in front of the configuration in readiness for when the spinkube GitHub org (and internal documentation repository) becomes public at which point the documentation is required to be a public facing website.

vdice commented 8 months ago

@tpmccallum it looks pretty straightforward to deploy to GitHub Pages, thanks to the following guide: https://gohugo.io/hosting-and-deployment/hosting-on-github/

But I also see the netlify.toml file (perhaps included with the original docsy-example template) and wanted to double-check if deploying via Netlify was the plan instead? (Hey, there's a guide for that too! https://gohugo.io/hosting-and-deployment/hosting-on-netlify)

cc @flynnduism

vdice commented 8 months ago

(Chatted w/ @flynnduism and @endocrimes and GH pages will be the approach for now, just as originally requested.)

vdice commented 8 months ago

Closed by https://github.com/spinkube/documentation/pull/46.