{"id":24344336,"url":"https://github.com/aiven/aiven-docs","last_synced_at":"2025-12-25T02:10:00.748Z","repository":{"id":219773460,"uuid":"740400791","full_name":"aiven/aiven-docs","owner":"aiven","description":"The repository for the public documentation.","archived":false,"fork":false,"pushed_at":"2025-12-20T09:16:03.000Z","size":56209,"stargazers_count":19,"open_issues_count":16,"forks_count":25,"subscribers_count":45,"default_branch":"main","last_synced_at":"2025-12-22T03:08:29.150Z","etag":null,"topics":["docs","documentation"],"latest_commit_sha":null,"homepage":"https://aiven.io/docs","language":"TypeScript","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/aiven.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","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":"2024-01-08T09:16:30.000Z","updated_at":"2025-12-20T09:16:05.000Z","dependencies_parsed_at":"2025-10-30T14:32:48.404Z","dependency_job_id":"de928ca1-ba2f-4f82-b0b9-9950a4c22869","html_url":"https://github.com/aiven/aiven-docs","commit_stats":null,"previous_names":["aiven/aiven-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aiven/aiven-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiven%2Faiven-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiven%2Faiven-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiven%2Faiven-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiven%2Faiven-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aiven","download_url":"https://codeload.github.com/aiven/aiven-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiven%2Faiven-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28017097,"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-12-25T02:00:05.988Z","response_time":58,"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","documentation"],"created_at":"2025-01-18T09:33:51.439Z","updated_at":"2025-12-25T02:10:00.742Z","avatar_url":"https://github.com/aiven.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aiven docs\n\n\u003c!-- vale off --\u003e\n\nThe Aiven docs repo generates the content located at [www.aiven.io/docs](https://www.aiven.io/docs).\nWe use [Docusaurus](https://docusaurus.io/) to build the docs.\n\n## 🤲 Contributing\n\nWe welcome contributions! To contribute to our docs, see [Contributing](./CONTRIBUTING.md).\n\n## ️🚀 Building the docs\n\n1. Update the examples submodule:\n\n   ```bash\n   git submodule update --init --recursive\n   ```\n\n### With Docker\n\n1. Run:\n\n   ```bash\n   docker compose up dev\n   ```\n\n1. Go to http://localhost:3000/docs/. Updating files in your local repo refreshes the website.\n\n### Without Docker\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cb\u003eRequirements\u003c/b\u003e\u003c/summary\u003e\n  \u003cdiv\u003e\n   \u003cul\u003e\n     \u003cli\u003eNode ≥ 23\u003c/li\u003e\n     \u003cli\u003e\u003ca href=\"https://yarnpkg.com/getting-started/install\"\u003eyarn 4\u003c/a\u003e\u003c/li\u003e\n   \u003c/ul\u003e\n  \u003c/div\u003e\n\u003c/details\u003e\n\n1. Install the dependencies:\n\n   ```bash\n   corepack enable\n   yarn\n   ```\n\n1. Optional: Install [Vale](https://vale.sh/docs/vale-cli/installation/).\n\n1. Optional: Install [Husky](https://typicode.github.io/husky/):\n\n   ```bash\n   yarn dlx husky\n   ```\n\n   Husky prevents git pushes when Vale errors are in the files you've modified.\n\n1. Build the docs:\n\n   ```bash\n   yarn start\n   ```\n\n   **💡 Tip:** If you use VS Code, you can use the build task: **⌘+⇧+B** \u003e **Build the docs**\n\n1. Go to http://localhost:3000/docs/. Updating files in the local repo refreshes the website.\n\n## Opening a PR\n\n1. Check for potential broken links with `yarn build` (`yarn start` doesn't check for broken links).\n1. If you get a green build and when you are happy with your changes, open a PR.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiven%2Faiven-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faiven%2Faiven-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiven%2Faiven-docs/lists"}