Files
kustomize/site
Nick bfb00ecb27 Add common Tasks to documentation (#5383)
* Add labels, annotations, namespaces, and names tasks

* Remove redundant information from ref/labels ref/annotations

* Update labels and annotations example names for consistency

* Remove name, prefix and suffix api examples

* Add link to tasks in reference

* Add link to tasks section for ref/configMapGenerator and ref/secretGenerator

* Add Labels/Annotatations headers

* Add Labels

* Add Template Labels

* Cleanup Add Template Labels

* Consolidate commonLabels and labels.includeSelectors

* Improve commonAnnotations example

* Add labels and annotations ref links

* Add generated ConfigMap to namespace example

* Add name headers

* Change header weights so they appear in sidebar

* Add namespace/name links

* Add generated ConfigMap to namePrefix example

* Add name propagation example

* Add more description of name propagation

* template labels

* Address feedback for labels

* Address names feedback

* Update for consistency

* Address feedback

* Remove API
2023-11-25 21:34:10 +01: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

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

  1. 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
    
  1. Initialize Docsy and nested submodules
    # In Kustomize repository root directory, fetch docsy submodule at site/themes/docsy.
    # See alternative submodule cloning options in the submodule documentation linked above.
    git submodule init
    git submodule update
    # Fetch submodules nested in docsy.
    cd site/themes/docsy
    git submodule init
    git submodule update
    
  2. Start in development mode:
    hugo serve -D