{"id":28925600,"url":"https://github.com/redpanda-data/docs","last_synced_at":"2026-02-02T14:36:02.397Z","repository":{"id":191454971,"uuid":"684321309","full_name":"redpanda-data/docs","owner":"redpanda-data","description":"Open source content for the Redpanda documentation","archived":false,"fork":false,"pushed_at":"2026-01-28T16:44:46.000Z","size":34765,"stargazers_count":9,"open_issues_count":11,"forks_count":47,"subscribers_count":32,"default_branch":"main","last_synced_at":"2026-01-29T07:30:58.452Z","etag":null,"topics":["antora","docs","redpanda","streaming","streaming-data"],"latest_commit_sha":null,"homepage":"https://docs.redpanda.com","language":"Gherkin","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/redpanda-data.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","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":"2023-08-28T22:47:00.000Z","updated_at":"2026-01-28T16:55:19.000Z","dependencies_parsed_at":"2023-10-17T10:48:51.509Z","dependency_job_id":"76b96276-cae9-4fa1-a289-7dbbf0c96f3c","html_url":"https://github.com/redpanda-data/docs","commit_stats":null,"previous_names":["redpanda-data/docs","redpanda-data/documentation"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/redpanda-data/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redpanda-data%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redpanda-data%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redpanda-data%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redpanda-data%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redpanda-data","download_url":"https://codeload.github.com/redpanda-data/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redpanda-data%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29013090,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T12:48:30.580Z","status":"ssl_error","status_checked_at":"2026-02-02T12:46:38.384Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["antora","docs","redpanda","streaming","streaming-data"],"created_at":"2025-06-22T11:09:37.548Z","updated_at":"2026-02-02T14:36:02.390Z","avatar_url":"https://github.com/redpanda-data.png","language":"Gherkin","readme":"= Redpanda Documentation\n:url-playbook: https://github.com/redpanda-data/docs-site\n\nimage:https://img.shields.io/badge/slack-purple[Slack, link=\"https://redpanda.com/slack\"]\nimage:https://img.shields.io/twitter/follow/redpandadata.svg?style=social\u0026label=Follow[Twitter, link=\"https://twitter.com/intent/follow?screen_name=redpandadata\"]\nimage:https://api.netlify.com/api/v1/badges/5b89dd6f-1847-419c-b3be-a1650ce8992f/deploy-status[Netlify Status, link=\"https://app.netlify.com/sites/redpanda-documentation/deploys\"]\nimage:https://img.shields.io/coderabbit/prs/github/redpanda-data/docs?utm_source=oss\u0026utm_medium=github\u0026utm_campaign=redpanda-data%2Fdocs\u0026labelColor=171717\u0026color=FF570A\u0026label=CodeRabbit+Reviews[CodeRabbit Reviews, link=\"https://coderabbit.ai\"]\n\n\n++++\n\u003cp\u003e\n\u003ca href=\"https://docs.redpanda.com\"\u003e\n\u003cobject type=\"image/svg+xml\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/redpanda-data/docs-ui/main/src/img/redpanda-docs-logo.svg\"/\u003e\n\u003c/object\u003e\n\u003c/p\u003e\u003c/a\u003e\n++++\n\nThis repository hosts the documentation content for Redpanda Self-Managed.\n\n== Contribute\n\nThe Redpanda docs are open source, and we welcome your contributions!\n\nBefore you add or edit content, consult the Redpanda https://github.com/redpanda-data/docs-site/blob/main/meta-docs/STYLE-GUIDE.adoc[Style Guide] for product documentation guidelines.\n\nTo contribute to the Redpanda docs, you have the following options:\n\n|===\n|Option|Description\n\n|\u003c\u003cOpen an issue\u003e\u003e\n|Suggest a change by opening an issue on GitHub.\n\n|\u003c\u003cContribute content\u003e\u003e\n|Make changes directly to the documentation and submit them through a pull request.\n\n|===\n\n=== Open an issue\n\nThe Redpanda docs team uses GitHub issues to track, plan, and prioritize tasks. To suggest changes, you can create an issue, which the team will then evaluate:\n\n. Verify whether a similar issue already exists in that repository to avoid duplication.\n. Go to **Issues** \u003e **New Issue** to create a new issue.\n\nYou have the option to assign the issue to yourself or leave the assignee field blank. The Redpanda docs team triages all new issues and will allocate a writer if one isn't already assigned.\n\nIf you are a Redpanda employee, submit doc issues in `redpanda-data/documentation-private`.\n\n=== Contribute content\n\nYou have two options to contribute to the documentation:\n\n. Directly edit a page on GitHub by selecting **Make a contribution** \u003e **Edit on GitHub** located at the bottom of a documentation page.\n. Clone the docs repository to make changes locally on your machine. For a guide, see {url-playbook}/blob/main/meta-docs/CONTRIBUTING.adoc[Submit your first contribution].\n\nCheck the open docs issues. If you find an issue you'd like to work on:\n\n- If the issue is already assigned to someone else, please consider another one.\n- If the issue is unassigned, add a comment expressing your interest in working on it.\n\n== Local development\n\nIf you want to run the website locally, install and update the packages:\n\n```bash\nnpm update\n```\n\nThen, build the docs and start a local web server:\n\n```bash\nnpm run start\n```\n\nThis command opens a browser window. Most changes are reflected live without having to restart the server.\n\n=== Build the site\n\nTo build the files, run:\n\n```bash\nnpm run build\n```\n\nThis command generates static content in the `docs` directory and can be served using any hosting service.\n\nYou can serve the static files on a local web server using:\n\n```bash\nnpm run serve\n```\n\n== Versioning\n\nVersioned content is stored in branches that track the version of Redpanda Self-Managed. Production branches use the *v/x.y* naming pattern. For example, branch `v/22.3` hosts the content for version 22.3.x of Redpanda Self-Managed. The `main` branch always contains docs for the latest release.\n\nThe production {url-playbook}[docs site playbook] instructs Antora to automatically aggregate content in the following branches:\n\n- `main`: Content for the latest version of Redpanda.\n- `v/*`: Content for previous versions of Redpanda.\n- `shared`: Content that is shared across all versions (asciidoc attributes and terms)\n- `api`: API docs as well as the source OpenAPI spec files.\n- `site-search`: The global site search page.\n\n== Repository Structure\n\nThe documentation content is stored in the `modules/` directory, where each module represents a top-level label in the documentation nav tree.\n\nEach module has a `pages/` directory that stores the documentation pages in Asciidoc format. Some modules also include a `partials/` directory that contains single-sourced documentation that can be shared and referenced by any documentation pages across any module.\n\nThe `shared` module stores the images, attachments, and partials that do not belong to a single module and can be referenced by any documentation pages across any module.\n\n....\nmodules/shared\n├── attachments\n├── images\n└── partials\n....\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredpanda-data%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredpanda-data%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredpanda-data%2Fdocs/lists"}