crossplane / crossplane/upjet

Ability to disable certain example manifest generation

Open
#69 0 comments 0 reactions 0 assignees View on GitHub
docgen enhancement v2
Dominant language
Go
Stars
481
Forks
131
Avg merge
2d 1h
Merged PRs (30d)
11

Description

### What problem are you facing?

In many cases, there is a single unified manifest for the whole group and then the dependent manifests are also repeated in other single YAML examples. In some cases, the manifest is different than the one used in the unified example. Our goal is to have the least examples for a kind in the beginning to reduce the toil, hence we'd like to disable generation of these additional examples when we see those kinds already have examples in the unified YAML.

### How could Terrajet help solve your problem?

If the removal of an example from `.MetaResource` does not exclude it from reference config generation, then a helper function should be sufficient. However, if it does have an impact, then a configuration field that will disable only write operation of the manifest would be needed.

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.