https://github.com/2-alchemists/krossboard-docs

📚 Documentation site for Krossboard - Krossboard provides a centralized resource usage analytics for multiple Kubernetes clusters; it works with multi cloud and across several distributions.
https://github.com/2-alchemists/krossboard-docs

hugo-site kubernetes

Last synced: 5 days ago
JSON representation

📚 Documentation site for Krossboard - Krossboard provides a centralized resource usage analytics for multiple Kubernetes clusters; it works with multi cloud and across several distributions.

• Host: GitHub
• URL: https://github.com/2-alchemists/krossboard-docs
• Owner: 2-alchemists
• License: other
• Created: 2020-04-15T17:49:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T12:50:45.000Z (5 months ago)
• Last Synced: 2024-08-01T13:19:52.348Z (3 months ago)
• Topics: hugo-site, kubernetes
• Language: CSS
• Homepage: https://krossboard.app
• Size: 36.7 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ccamel - 2-alchemists/krossboard-docs - 📚 Documentation site for Krossboard - Krossboard provides a centralized resource usage analytics for multiple Kubernetes clusters; it works with multi cloud and across several distributions. (CSS)

README

        
[![CC-BY-NC-SA](https://licensebuttons.net/l/by-nc-sa/3.0/88x31.png)](LICENSE.md)

[![build-site](https://img.shields.io/github/actions/workflow/status/2-alchemists/krossboard-docs/build.yml?label=BUILD&style=for-the-badge&logo=github)](https://github.com/2-alchemists/krossboard-docs/actions/workflows/build.yml?label=Lint&style=for-the-badge&logo=github)

[![deploy-site](https://img.shields.io/github/actions/workflow/status/2-alchemists/krossboard-docs/deploy.yml?label=DEPLOY&style=for-the-badge&logo=github)](https://github.com/2-alchemists/krossboard-docs/actions/workflows/deploy.yml)

[![site](https://img.shields.io/badge/%F0%9F%8C%8E-site-blue?style=for-the-badge)](https://krossboard.app)

# Overview & License

This project holds the documentation website for [Krossboard](https://krossboard.app/).

This project is Open Sourced under the terms of the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (also known as CC-BY-NC-SA). See the [LICENSE](LICENSE.md) file for more details.

# Contributions

Contributions are welcomed for typos, misspellings, or inaccurate information in the documentation.

Each contribution should be submitted through a Github [pull request](https://github.com/2-alchemists/krossboard-docs/pulls). By submitting a contribution, you accept that it'll be published under the same terms of CC-BY-NC-SA License.

## Requirements

[Hugo](https://gohugo.io/) static site generator `v0.75.x` minimum (`v0.75.1` is the version currently used by the CI).

```

sudo snap install hugo --classic

```

## View the site in development mode

```sh

hugo server

```

Then open [http://localhost:1313/](http://localhost:1313/)

## Build a distribution

```sh

hugo --minify

```

The will compile the content and generate the static site in the folder `./public`.

## Deploy a distribution locally

The site can be deployed locally using a rudimentary web server to serve files in the `public/` directory with TLS enabled.

The following tools are used:

- [mkcert](https://github.com/FiloSottile/mkcert) - a simple tool for making locally-trusted development certificates.

- [ran](https://github.com/m3ng9i/ran) - a simple static web server (written in Go).

Steps are following:

- if not already done, generate a locally-trusted certificate:

```sh

mkcert my-machine.local

```

- start the web server:

```sh

cd public

ran -cert=../my-machine.local.pem -key=../my-machine.local-key.pem .

```

The site is then available at: [https://my-machine.local/](https://my-machine.local)