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

[cmd/mdatagen] add doc generation capabilities #30188

Closed
wants to merge 16 commits into from
Closed

[cmd/mdatagen] add doc generation capabilities #30188

wants to merge 16 commits into from

Conversation

atoulme
Copy link
Contributor

@atoulme atoulme commented Dec 23, 2023

Description:
This adds documentation generation capabilities to mdatagen. Those capabilities are taken after configschema.

Link to tracking Issue:
#30187

Testing:
Unit tests, and a visual representation with apachereceiver.

@atoulme atoulme requested a review from a team December 23, 2023 01:26
@atoulme atoulme mentioned this pull request Dec 23, 2023
Closed
3 tasks
@atoulme atoulme requested a review from mx-psi as a code owner December 23, 2023 01:47
@github-actions github-actions bot added cmd/configschema configschema command cmd/otelcontribcol otelcontribcol command labels Dec 23, 2023
@atoulme atoulme force-pushed the internal_configschema branch 2 times, most recently from 637e650 to 54a7497 Compare December 23, 2023 02:55
mx-psi
mx-psi reviewed Jan 3, 2024
View reviewed changes
.github/ALLOWLIST Outdated Show resolved Hide resolved
.github/CODEOWNERS Outdated Show resolved Hide resolved
cmd/mdatagen/loader.go Show resolved Hide resolved
@dmitryax
Copy link
Member

dmitryax commented Jan 4, 2024

How much different internal/configschema from cmd/configschema? Is there a chance to reuse the code and make cmd/configschema depend on internal/configschema or the other way around?

@atoulme
Copy link
Contributor Author

atoulme commented Jan 4, 2024

How much different internal/configschema from cmd/configschema? Is there a chance to reuse the code and make cmd/configschema depend on internal/configschema or the other way around?

I thought we'd let cmd/configschema rot and remove it cleanly while we iterate on internal/configschema.

@mx-psi
Copy link
Member

mx-psi commented Jan 4, 2024

How much different internal/configschema from cmd/configschema? Is there a chance to reuse the code and make cmd/configschema depend on internal/configschema or the other way around?

I thought we'd let cmd/configschema rot and remove it cleanly while we iterate on internal/configschema.

If it's not too hard, I would prefer doing what @dmitryax said and reuse internal/configschema for cmd/configschema. It's the approach we usually have taken when moving code around

dmitryax
dmitryax reviewed Jan 4, 2024
View reviewed changes
.github/CODEOWNERS Outdated Show resolved Hide resolved
.chloggen/internal_configschema.yaml Outdated Show resolved Hide resolved
.chloggen/internal_configschema.yaml Outdated Show resolved Hide resolved
receiver/apachereceiver/apache.yaml Outdated Show resolved Hide resolved
@atoulme
Copy link
Contributor Author

atoulme commented Jan 5, 2024

FYI this PR must be merged after 0.92.0 is released as #30190 is merged

@atoulme atoulme force-pushed the internal_configschema branch 3 times, most recently from a4fa06a to 3882637 Compare January 12, 2024 01:12
@atoulme
Copy link
Contributor Author

atoulme commented Jan 12, 2024

Rebased. Please take a look

@atoulme atoulme force-pushed the internal_configschema branch 2 times, most recently from e978fb0 to 0e9ae98 Compare January 13, 2024 00:23
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2024

This PR was marked stale due to lack of activity. It will be closed in 14 days.

@github-actions github-actions bot added the Stale label Feb 6, 2024
@github-actions GitHub Actions
Copy link
Contributor

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions bot closed this Feb 20, 2024
@atoulme atoulme reopened this Feb 22, 2024
@github-actions github-actions bot removed the Stale label Feb 23, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 8, 2024

This PR was marked stale due to lack of activity. It will be closed in 14 days.

@github-actions github-actions bot added the Stale label Mar 8, 2024
@atoulme
Copy link
Contributor Author

atoulme commented Mar 20, 2024

This PR will never be merged since mdatagen has moved over to core. Closing.

@atoulme atoulme closed this Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmitryax dmitryax dmitryax left review comments

@mx-psi mx-psi mx-psi left review comments

@djaglowski djaglowski Awaiting requested review from djaglowski djaglowski is a code owner

@pmcollins pmcollins Awaiting requested review from pmcollins

Assignees

@bogdandrutu bogdandrutu

Labels
cmd/configschema configschema command cmd/mdatagen mdatagen command cmd/otelcontribcol otelcontribcol command receiver/apache Stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@atoulme @dmitryax @mx-psi @bogdandrutu