search

crossplane / docs

Repo for Crossplane documentation.
https://docs.crossplane.io
Other
49 stars 112 forks source link

Move upbound.io from Jekyll to Hugo #149

Closed plumbis closed 2 years ago

plumbis commented 2 years ago

What problem are you facing?

Today the Crossplane documentation uses Jekyll, a Ruby based static site generator.

For local development the process requires installing NPM, Docker and then running the build, which takes multiple minutes (at least on my M1 Mac).

The overhead and time required for building locally is a barrier to contributing to Crossplane community documentation.

How could Crossplane help solve your problem?

I propose that Crossplane documentation moves to the Hugo static site generator.

Hugo is a single binary that builds larger sites in sub-second times, making the local development of content much easier.

Kubernetes uses Hugo for their documentation, allowing Crossplane to align on a tool that the community is already familiar with.

Hugo is Go based and uses Go Templating for their template engine instead of Jekyll's Ruby based Liquid language. Aligning with a Go-based tool makes sense given the Crossplane Go code codebase.

I volunteer to make the required changes for porting the existing site to Hugo.

negz commented 2 years ago

@plumbis This sounds good to me. Please feel free to start work and open a draft PR when you're ready for review.

plumbis commented 2 years ago

Completed with PR #151