Files
kustomize/site
Dani Santos 506dc4f9fe migrate site content: contributing docs (#4709)
* migrate contributing docs

* modifies weight for ordering

* updates links and info based on feedback

* removes broken powershell link

* Update site/content/en/contribute/windows/_index.md

Co-authored-by: Katrina Verey <kn.verey@gmail.com>

* Update site/content/en/contribute/windows/_index.md

Co-authored-by: Katrina Verey <kn.verey@gmail.com>

* Update site/content/en/contribute/mac/_index.md

Co-authored-by: Katrina Verey <kn.verey@gmail.com>

* Update site/content/en/contribute/howitworks/_index.md

Co-authored-by: Katrina Verey <kn.verey@gmail.com>

* Update site/content/en/contribute/howitworks/_index.md

Co-authored-by: Katrina Verey <kn.verey@gmail.com>

* simplify build explanation

* removes windows docs

* removes community - duplicate

* update the tooling instructions

* point to proposal docs

* Update site/content/en/contribute/howitworks/_index.md

Co-authored-by: Katrina Verey <kn.verey@gmail.com>
2022-09-29 10:20:39 -07:00
..
2022-03-06 12:29:12 +01:00
2022-07-29 12:33:13 -07:00
2022-03-06 12:29:12 +01:00
2022-07-29 12:33:13 -07:00
2022-07-29 12:33:13 -07:00
2022-03-06 12:29:12 +01:00

kustomize website: the alpha of the alpha

Overview

This is just an example overview of what the new kustomize website might look like. It is forked from the docsy exmaple website and heavy based on that.

I'm not a frontend dev but I was mostly successful at creating what I thought would be a good outline. However, I couldn't get rid of that picture of porridge with blueberries on it on the landing page! So ignore that and imagine it's something more nautical.

I put the most effort into the Documentation section. The left-menu bar has the custom structure that is my creation, based on the docsy example, the content of the current kustomize documentation sources and a general vibe of documentation sites I find easy to read.

The top bar is customized with the sections I think make sense to split. However, I have customized nothing else inside the Community, Contribute and Blog sections.

Building

Build and run using Docker or Hugo, then access the site at http://localhost:1313.

Docker

Dependencies:

docker-compose build
docker-compomse up -d

hugo

Building using the hugo command requires the following dependencies:

  • hugo CLI
  • Go
  • Node.js
  • npm dependencies
    npm install -D autoprefixer
    npm install -D postcss-cli
    npm install -D postcss
    

Start in development mode:

hugo serve -D