{"id":13560926,"url":"https://github.com/2-alchemists/krossboard-docs","last_synced_at":"2025-04-03T16:31:33.887Z","repository":{"id":39610171,"uuid":"255994694","full_name":"2-alchemists/krossboard-docs","owner":"2-alchemists","description":"📚 Documentation site for Krossboard - Krossboard provides a centralized resource usage analytics for multiple Kubernetes clusters; it works with multi cloud and across several distributions.","archived":false,"fork":false,"pushed_at":"2024-06-18T12:50:45.000Z","size":38466,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-01T13:19:52.348Z","etag":null,"topics":["hugo-site","kubernetes"],"latest_commit_sha":null,"homepage":"https://krossboard.app","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/2-alchemists.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-15T17:49:58.000Z","updated_at":"2024-06-18T12:50:49.000Z","dependencies_parsed_at":"2024-05-21T11:43:09.413Z","dependency_job_id":"90ce4c88-d9f3-4566-8786-d8ca460e9bd7","html_url":"https://github.com/2-alchemists/krossboard-docs","commit_stats":null,"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2-alchemists","download_url":"https://codeload.github.com/2-alchemists/krossboard-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247037014,"owners_count":20873078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hugo-site","kubernetes"],"created_at":"2024-08-01T13:00:50.895Z","updated_at":"2025-04-03T16:31:28.873Z","avatar_url":"https://github.com/2-alchemists.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"[![CC-BY-NC-SA](https://licensebuttons.net/l/by-nc-sa/3.0/88x31.png)](LICENSE.md)\n[![build-site](https://img.shields.io/github/actions/workflow/status/2-alchemists/krossboard-docs/build.yml?label=BUILD\u0026style=for-the-badge\u0026logo=github)](https://github.com/2-alchemists/krossboard-docs/actions/workflows/build.yml?label=Lint\u0026style=for-the-badge\u0026logo=github)\n[![deploy-site](https://img.shields.io/github/actions/workflow/status/2-alchemists/krossboard-docs/deploy.yml?label=DEPLOY\u0026style=for-the-badge\u0026logo=github)](https://github.com/2-alchemists/krossboard-docs/actions/workflows/deploy.yml)\n[![site](https://img.shields.io/badge/%F0%9F%8C%8E-site-blue?style=for-the-badge)](https://krossboard.app)\n\n# Overview \u0026 License\n\nThis project holds the documentation website for [Krossboard](https://krossboard.app/).\n\nThis 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.\n\n# Contributions\n\nContributions are welcomed for typos, misspellings, or inaccurate information in the documentation.\n\nEach 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.\n\n## Requirements\n\n[Hugo](https://gohugo.io/) static site generator `v0.75.x` minimum (`v0.75.1` is the version currently used by the CI).\n\n```\nsudo snap install hugo --classic\n```\n\n## View the site in development mode\n\n```sh\nhugo server\n```\n\nThen open [http://localhost:1313/](http://localhost:1313/)\n\n## Build a distribution\n\n```sh\nhugo --minify\n```\n\nThe will compile the content and generate the static site in the folder `./public`.\n\n## Deploy a distribution locally\n\nThe site can be deployed locally using a rudimentary web server to serve files in the `public/` directory with TLS enabled.\n\nThe following tools are used:\n\n- [mkcert](https://github.com/FiloSottile/mkcert) - a simple tool for making locally-trusted development certificates.\n- [ran](https://github.com/m3ng9i/ran) - a simple static web server (written in Go).\n\nSteps are following:\n\n- if not already done, generate a locally-trusted certificate:\n\n```sh\nmkcert my-machine.local\n```\n\n- start the web server:\n\n```sh\ncd public\nran -cert=../my-machine.local.pem -key=../my-machine.local-key.pem .\n```\n\nThe site is then available at: [https://my-machine.local/](https://my-machine.local)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2-alchemists%2Fkrossboard-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2-alchemists%2Fkrossboard-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2-alchemists%2Fkrossboard-docs/lists"}