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.

Sign up for GitHub

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

Jump to bottom

Add parent field to metadata.yaml file for subcomponents. #23430

Closed
mackjmr opened this issue Jun 16, 2023 · 1 comment
Closed

Add parent field to metadata.yaml file for subcomponents. #23430

mackjmr opened this issue Jun 16, 2023 · 1 comment
Assignees
@mackjmr
Labels
cmd/mdatagen mdatagen command

Comments

@mackjmr
Copy link
Member

mackjmr commented Jun 16, 2023 •
edited
Loading

Component(s)

cmd/mdatagen

Describe the issue you're reporting

Add a parent field to metadata.yaml. This will be used in subcomponents, and the field will contain the type of their parent component.

In terms of generated files, we will include the parent component in the documentation.md. If a use case arises in the future, we could also add this elsewhere such as a const in generated_status.go.

Having this field will help us identify from the metadata.yaml wether the component is a subcomponent, and will help with: #23424.
@mackjmr mackjmr added the needs triage New item requiring triage label Jun 16, 2023
@github-actions github-actions bot added the cmd/mdatagen mdatagen command label Jun 16, 2023
@github-actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@songy23 songy23 removed the needs triage New item requiring triage label Jun 16, 2023
mackjmr added a commit to mackjmr/opentelemetry-collector-contrib that referenced this issue Jun 22, 2023
@mackjmr
mdatagen: Add parent field to metadata.yaml file for subcomponents
f7af147 
This PR adds a `parent` field to the `metadata.yaml`. This is used in subcomponents, and the field contains the type of their parent component.

Issue: open-telemetry#23430
@mackjmr mackjmr mentioned this issue Jun 22, 2023
Merged
@mackjmr mackjmr closed this as completed Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mackjmr mackjmr

Labels
cmd/mdatagen mdatagen command
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@songy23 @mackjmr