{"id":38036795,"url":"https://github.com/syntasso/kratix-docs","last_synced_at":"2026-01-16T19:50:19.821Z","repository":{"id":64511819,"uuid":"532663923","full_name":"syntasso/kratix-docs","owner":"syntasso","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-12T11:53:51.000Z","size":133044,"stargazers_count":5,"open_issues_count":37,"forks_count":10,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-12T18:29:07.271Z","etag":null,"topics":["documentation","hacktoberfest","kratix","kubernetes","platform"],"latest_commit_sha":null,"homepage":"","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/syntasso.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-09-04T21:35:03.000Z","updated_at":"2026-01-12T11:48:10.000Z","dependencies_parsed_at":"2024-01-22T11:52:06.607Z","dependency_job_id":"2329298e-747c-4f17-94f7-cad16d0d7315","html_url":"https://github.com/syntasso/kratix-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/syntasso/kratix-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntasso%2Fkratix-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntasso%2Fkratix-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntasso%2Fkratix-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntasso%2Fkratix-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/syntasso","download_url":"https://codeload.github.com/syntasso/kratix-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syntasso%2Fkratix-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28482002,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","hacktoberfest","kratix","kubernetes","platform"],"created_at":"2026-01-16T19:50:19.751Z","updated_at":"2026-01-16T19:50:19.806Z","avatar_url":"https://github.com/syntasso.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kratix Docs\n\nKratix documentation is built using [Docusaurus 2](https://docusaurus.io/). The live version of the documentation is available at [docs.kratix.io](https://docs.kratix.io).\n\n## Installation\n\n```bash\ncorepack enable\nyarn install\n```\n\nThis command will install all the Dependencies required to build the website. If you don't have `yarn` installed, check out the [installation guide](https://yarnpkg.com/getting-started/install).\n\n## Local Development\n\n```bash\nyarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Running in Docker\n\nYou can also run it in Docker:\n\n```bash\ndocker run -it -v `pwd`:/app -p 3000:3000 node /bin/bash -c \"cd /app; yarn run start --host 0.0.0.0\"\n```\n\n## Build, test, and verify\n\n```bash\nyarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service. Building the website also runs a lightweight test suite that ensure there are no broken links in the documentation.\n\n```bash\nyarn serve\n```\n\nThis command starts a local server, serving the contents of the `build` directory. This is useful for testing the production build locally.\n\n## Deployment\n\nPublishing the website managed by CircleCI and is triggered by a commit to the `main` branch. The CircleCI configuration is available in the `.circleci` directory.\n\nThe live website is hosted on GitHub Pages and the deployment is done by pushing the generated static files to the `gh-pages` branch. The yarn `deploy` task is configured to do this. A [CircleCI pipeline](https://app.circleci.com/pipelines/github/syntasso/kratix-docs?branch=main) is responsible for running the `deploy` task.\n\n\u003e Note: a branch protection rule is in place to prevent direct commits to the `gh-pages` branch. The `gh-pages` branch is only updated by the CircleCI job.\n\nOnce the `gh-pages` is updated, a Github Actions will be triggered to update the live website, and is available [here](https://github.com/syntasso/kratix-docs/actions/workflows/pages/pages-build-deployment).\n\nOnce the Action completes, you can verify the documentation at [docs.kratix.io](https://docs.kratix.io).\n\n## Docs structure\n\nThe landing page is built with React and the source code can be found in [src/pages/index.tsx](src/pages/index.tsx). From there, you can find the other React components that make up the landing page.\n\nThe documentation pages are located in the [docs](docs) directory.\n\n## Autogenerated Docs\n\n### CLIs\n\nThe documentation for each of the CLI tools is generated via the `scripts/generate-cli-docs` script. In order  to run this, you must ensure that the cli in question is in your `PATH`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyntasso%2Fkratix-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyntasso%2Fkratix-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyntasso%2Fkratix-docs/lists"}