crossplane / crossplane/cli

Automatically update the command reference docs from CI

Open
#31 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Go
Stars
19
Forks
31
Avg merge
3d 4h
Merged PRs (30d)
52

Description

### What problem are you facing?

We're now able to auto-generate the CLI reference documentation for docs.crossplane.io, but have to do it manually.

### How could Crossplane help solve your problem?

We should add CI jobs to:

- Update the CLI docs in the `content/master/` directory of the docs repo every time we merge a help change to main.
- Update the CLI docs in the relevant release directory of the docs repo (e.g., `content/v2.3`) every time we do a release.

We can use https://github.com/peter-evans/create-pull-request to automatically create PRs to the docs repo.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.