Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to disable certain example manifest generation #69

Open
muvaf opened this issue Aug 12, 2022 · 0 comments
Open

Ability to disable certain example manifest generation #69

muvaf opened this issue Aug 12, 2022 · 0 comments
Labels
docgen enhancement New feature or request v2
Milestone

Comments

@muvaf
Copy link
Member

muvaf commented Aug 12, 2022

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.

@muvaf muvaf added the enhancement New feature or request label Aug 12, 2022
@jeanduplessis jeanduplessis added this to the 2.x milestone Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docgen enhancement New feature or request v2
Projects
None yet
Development

No branches or pull requests

2 participants