https://github.com/kavinraja-g/crossplane-docs
Docs (XDOCs) generator for Crossplane
https://github.com/kavinraja-g/crossplane-docs
cncf crossplane documentation generator golang kubernetes
Last synced: 7 months ago
JSON representation
Docs (XDOCs) generator for Crossplane
- Host: GitHub
- URL: https://github.com/kavinraja-g/crossplane-docs
- Owner: Kavinraja-G
- License: apache-2.0
- Created: 2024-03-23T14:48:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-09T08:21:26.000Z (over 1 year ago)
- Last Synced: 2024-05-09T09:35:58.938Z (over 1 year ago)
- Topics: cncf, crossplane, documentation, generator, golang, kubernetes
- Language: Go
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# crossplane-docs
## What is XDocs?
- We have XR, XRD, XRC ;) Why not XDocs?
- Inspired from [terraform-docs](https://github.com/terraform-docs/terraform-docs) but for [Crossplane](https://www.crossplane.io/)
- Generate markdown based docs for your Compositions, it also includes your linked Resources, XRD and Claim
## Installation
**XDocs** Generator can be installed in several ways to suit your preferences and development environments
### Homebrew Tap (macOS & Linux)
If you're using Homebrew, you can install the tool via our custom Homebrew tap
```bash
brew tap Kavinraja-G/tap
brew install crossplane-docs
```
### Standalone Binary
For macOS, Linux, and Windows, standalone binaries are available. Download the appropriate binary for your operating system from the [releases](https://github.com/Kavinraja-G/crossplane-docs/releases/) page, then move it to a directory in your PATH.
#### macOS/Linux
```bash
# Feel free to change the release/arch names accordingly
curl -Lo crossplane-docs https://github.com/Kavinraja-G/crossplane-docs/releases/download/v0.1.0/crossplane-docs_v0.1.0_darwin_amd64.tar.gz
chmod +x crossplane-docs
sudo mv crossplane-docs /usr/local/bin/
```
#### Windows
Download the `.exe` file and add it to your `PATH`
## Usage
Currently xDocs supports only markdown output, but more in pipeline. To generate markdown docs for your compositions & XRDs
```bash
# Generate markdown docs for given compositions and XRDs
crossplane-docs md [INPUT_PATH] -o [OUTPUT_FILE]
# In some cases users prefer to generate XRD docs since pipeline mode is not supported
crossplane-docs md [INPUT_PATH] -o [OUTPUT_FILE] --xrd-only
```
For example:
```bash
crossplane-docs md ./samples -o samples/README.md
```
Check [README.md](./samples/README.md) for the output.
## Features
- Discovers Composition & its resources, XR, XRD and Claim names with their references
- Markdown ouput with tabulation
- Supports generating only XRD docs
- Claim/XRC specifications
## Limitations
Crossplane compositions with Pipeline composition mode is not supported.
## License
Distributed under the Apache-2.0 License. See [LICENSE](./LICENSE) for more information.