{"id":28449365,"url":"https://github.com/enterprisedb/k8s-api-docgen","last_synced_at":"2025-06-26T15:32:14.724Z","repository":{"id":44885372,"uuid":"346353552","full_name":"EnterpriseDB/k8s-api-docgen","owner":"EnterpriseDB","description":"Reads Go source files to extract metadata about Kubernetes API custom resources defined by the developer in Godoc and produces different kinds of output - such as JSON or Markdown.","archived":false,"fork":false,"pushed_at":"2023-06-14T16:09:52.000Z","size":41,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-06-06T14:08:03.008Z","etag":null,"topics":["developer","documentation","godoc","golang"],"latest_commit_sha":null,"homepage":"","language":"Go","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/EnterpriseDB.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-10T12:45:29.000Z","updated_at":"2025-03-07T16:55:40.000Z","dependencies_parsed_at":"2024-06-20T00:12:28.283Z","dependency_job_id":"f2985356-a1db-4a09-8d99-43b01b81d574","html_url":"https://github.com/EnterpriseDB/k8s-api-docgen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/EnterpriseDB/k8s-api-docgen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EnterpriseDB%2Fk8s-api-docgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EnterpriseDB%2Fk8s-api-docgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EnterpriseDB%2Fk8s-api-docgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EnterpriseDB%2Fk8s-api-docgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EnterpriseDB","download_url":"https://codeload.github.com/EnterpriseDB/k8s-api-docgen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EnterpriseDB%2Fk8s-api-docgen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262094540,"owners_count":23257988,"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","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":["developer","documentation","godoc","golang"],"created_at":"2025-06-06T14:08:02.833Z","updated_at":"2025-06-26T15:32:14.709Z","avatar_url":"https://github.com/EnterpriseDB.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kubernetes API documentation generator\n\n`k8s-api-docgen` is a tool that reads Go source files to extract metadata\nabout Kubernetes API custom resources defined by the developer in [Godoc](https://blog.golang.org/godoc)\nand to produce different kinds of output - such as JSON or Markdown.\n\nIts main use case is to automatically generate documentation in Markdown\nformat to be used within a CI/CD pipeline of a software written in Go\nfor Kubernetes, such as an operator.\n\n## Requirements\n\nTo compile this software you need:\n\n- a working [Go compiler](https://golang.org/);\n\n- a `make` installation (the one in MacOSX and the GNU ones are known to be\n  working correctly).\n\nThe code has been tested on MacOS X and Linux, but should resonably work in other\nplatforms too.\n\n## How to compile the code\n\nJust use the Makefile:\n\n    $ make\n    [...]\n\n## Usage instructions\n\nThe tool needs to have access to the Go source files for your Kubernetes API.\nThese are the files that will also be used by\n[controller-gen](https://book.kubebuilder.io/reference/controller-gen.html) to\ngenerate the CRD.\n\nSupposing these files are reachable at `../operator/api/v1` you can extract the\ndocumentation in JSON format via:\n\n    $ ./bin/k8s-api-docgen ../operator/api/v1/*types.go\n\nThe JSON stream will be written to *standard output*. Should you desire to\ncreate a file, you can use the `-o` option as follows:\n\n    $ ./bin/k8s-api-docgen -o documentation.json ../operator/api/v1/*types.go\n\nUsing the `-t` option with `md` value, you can also extract the documentation in Markdown format via:\n\n    $ ./bin/k8s-api-docgen -t md -o documentation.md ../operator/api/v1/*types.go\n\nIf you provide a `-c` option, you could specify your custom configuration file in YAML format via\n\n    $ ./bin/k8s-api-docgen -t md -c md-configuration.yaml -o documentation.md ../operator/api/v1/*types.go\n\nThis option is useful for linking K8s documentation to types and customizing table headers.\n\n## Copyright\n\n`k8s-api-docgen` is distributed under Apache License 2.0.\nCopyright (C) 2021 EnterpriseDB Corporation.\nSome portions Copyright 2016 The prometheus-operator Authors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenterprisedb%2Fk8s-api-docgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenterprisedb%2Fk8s-api-docgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenterprisedb%2Fk8s-api-docgen/lists"}