{"id":43374837,"url":"https://github.com/xcat2/confluent-docs","last_synced_at":"2026-02-02T06:24:25.982Z","repository":{"id":294501777,"uuid":"987178521","full_name":"xcat2/confluent-docs","owner":"xcat2","description":"Documentation material for confluent","archived":false,"fork":false,"pushed_at":"2025-12-11T15:11:13.000Z","size":23090,"stargazers_count":1,"open_issues_count":11,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-12-12T18:05:20.463Z","etag":null,"topics":["administration","cluster","deployment","hpc","provisioning","stateless"],"latest_commit_sha":null,"homepage":"https://xcat2.github.io/confluent-docs/","language":"Python","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/xcat2.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-20T17:33:05.000Z","updated_at":"2025-12-11T15:10:10.000Z","dependencies_parsed_at":"2025-12-11T19:28:22.927Z","dependency_job_id":"85be75fd-5b7f-4ae4-99d3-38f4c92042f9","html_url":"https://github.com/xcat2/confluent-docs","commit_stats":null,"previous_names":["xcat2/confluent-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/xcat2/confluent-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fconfluent-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fconfluent-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fconfluent-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fconfluent-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xcat2","download_url":"https://codeload.github.com/xcat2/confluent-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fconfluent-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29006994,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T04:25:24.522Z","status":"ssl_error","status_checked_at":"2026-02-02T04:24:51.069Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["administration","cluster","deployment","hpc","provisioning","stateless"],"created_at":"2026-02-02T06:24:22.262Z","updated_at":"2026-02-02T06:24:25.977Z","avatar_url":"https://github.com/xcat2.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Confluent documentation\n\n[![Build Status](https://github.com/xcat2/confluent-docs/workflows/build/badge.svg)](https://github.com/xcat2/confluent-docs/actions) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/xcat2/confluent-docs/blob/master/LICENSE)\n\nThe [confluent documentation](https://xcat2.github.io/confluent-docs/) is built using [MkDocs](https://www.mkdocs.org/). All **Markdown** files in the `docs` directory are automatically added to the documentation.  \nNavigation can be customized using `.nav.yml` files located in each directory.\n\nSince Markdown is supported by most Git web hosting platforms, you can also view or edit the documentation online without using MkDocs.\n\n## Prerequisites\n\nTo generate the documentation you need the Python package [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) along with some additional plugins. To install the required dependencies, run:\n\n```bash\npip3 install -r requirements.txt --user\n```\n\nAlternatively, you can install these within a Python virtual environment.\n\nFurthermore, you should have the [confluent repository](https://github.com/xcat2/confluent) cloned to `../confluent`.\n\n## Viewing and editing live documentation\n\nFor development purposes, you can use the following command to start a local web server that watches the files in the `docs` directory and updates the documentation on changes:\n\n```bash\nmkdocs serve\n```\n\nThen, access the live documentation at: [http://127.0.0.1:8000](http://127.0.0.1:8000)\n\n## Building HTML documentation\n\nTo build static HTML pages, use either:\n\n```bash\n./makeattribdoc   # generate node_attributes.md from ../confluent\n./makeman         # generate man pages from ../confluent\nmkdocs build      # build HTML pages\n```\n\nor\n\n```bash\nmake all\n```\n\nThe generated HTML pages will be placed in the `_site` directory. You can copy this directory to a web server or open it directly in a web browser.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxcat2%2Fconfluent-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxcat2%2Fconfluent-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxcat2%2Fconfluent-docs/lists"}