{"id":21344589,"url":"https://github.com/krustlet/krustlet-docs","last_synced_at":"2025-08-11T21:05:45.558Z","repository":{"id":38834142,"uuid":"365317699","full_name":"krustlet/krustlet-docs","owner":"krustlet","description":"Documentation for Krustlet","archived":false,"fork":false,"pushed_at":"2023-03-19T10:46:10.000Z","size":9031,"stargazers_count":4,"open_issues_count":3,"forks_count":14,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-12T15:40:08.471Z","etag":null,"topics":["docs","hugo","static-site"],"latest_commit_sha":null,"homepage":"https://docs.deislabs.io/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/krustlet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-05-07T18:14:14.000Z","updated_at":"2022-12-15T09:17:45.000Z","dependencies_parsed_at":"2024-11-22T01:32:47.836Z","dependency_job_id":null,"html_url":"https://github.com/krustlet/krustlet-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/krustlet/krustlet-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krustlet%2Fkrustlet-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krustlet%2Fkrustlet-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krustlet%2Fkrustlet-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krustlet%2Fkrustlet-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/krustlet","download_url":"https://codeload.github.com/krustlet/krustlet-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krustlet%2Fkrustlet-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269956287,"owners_count":24503137,"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","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docs","hugo","static-site"],"created_at":"2024-11-22T01:20:18.588Z","updated_at":"2025-08-11T21:05:45.536Z","avatar_url":"https://github.com/krustlet.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Krustlet Docs\n\n\u003e :book: This repo contains the [Krustlet Docs](https://github.com/krustlet/krustlet/tree/main/docs)  \n\u003e :ship: Also the website config to generate [docs.krustlet.dev](https://docs.krustlet.dev/)  \n\u003e :link: Looking for the main Krustlet.dev website? Visit [krustlet.dev](https://github.com/krustlet/krustlet.dev)  \n\n\n## Editing Content\n\ndocs.krustlet.dev is a static site. The documentation content needs to be located at `docs/content/docs/`.\n\nTo ensure the docs content renders correctly in the theme, each page will need to have [front matter](https://gohugo.io/content-management/front-matter/) metadata. Example front matter:\n\n```\n---\ntitle: \"Docs Home\"\nlinkTitle: \"Home\"\ndescription: \"Krustlet Docs\"\nweight: 1\ntype: docs\n---\n```\n\n## Front Matter Notes:\n\n* inclusion of `type: docs` is important for the theme to properly index the site contents\n* the `linkTitle` attribute allows you to simplify the name as it appears in the left-side nav bar - ideally it should be short and clear - whereas the title can handle longform names for pages/documents.\n\n\n# Site Development\n\n## Notes\n\n* built with the [Hugo](https://gohugo.io/) static site generator\n* custom theme uses [Docsy](https://www.docsy.dev/) as a base, with [Bootstrap](https://getbootstrap.com/) as the underlying css framework and some Krustlet custom sass additions\n* deployed to [Netlify](https://app.netlify.com/sites/krustlet-docs/deploys) via merges to main. (@flynnduism can grant additional access to account)\n* metrics tracked via Google Analytics (as part of Krustlet.dev)\n\n## Install dependencies:\n\n* Hugo [installation guide](https://gohugo.io/getting-started/installing/)  \n* NPM packages are installed by running `yarn`. [Install Yarn](https://yarnpkg.com/getting-started/install) if you need to.  \n\n## Run the site:\n\n```\n// install npm packages\nyarn\n\n// rebuild the site (to compile latest css/js)\nhugo\n\n// or serve the site for local dev\nhugo serve\n```\n\n## Deploying the site:\n\nThe site auto deploys the main branch via [Netlify](https://app.netlify.com/sites/krustlet-docs). Once pull requests are merged the changes will appear at docs.krustlet.dev after a couple of minutes. Check the [logs](https://app.netlify.com/sites/krustlet-docs/deploys) for details.\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/51ec134b-5691-434b-b6d7-f749c07f914d/deploy-status)](https://app.netlify.com/sites/krustlet-docs/deploys)\n\n`hugo serve` will run the site locally at [localhost:1313](http://localhost:1313/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrustlet%2Fkrustlet-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkrustlet%2Fkrustlet-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrustlet%2Fkrustlet-docs/lists"}