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

Generate project metadata documentation via automation #916

Open
kaylareopelle opened this issue Apr 1, 2024 · 2 comments
Open

Generate project metadata documentation via automation #916

kaylareopelle opened this issue Apr 1, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation keep Ensures stale-bot keeps this issue/PR open

Comments

@kaylareopelle
Copy link
Contributor

To disambiguate a code "owner" vs the reviewers, create an automated strategy to display a more specific code owner on a gem's Readme.

One option coudl be to follow the pattern established in otelcol-contrib where the Readme files have an auto-generated section:

Status
Stability [beta]: traces, metrics, logs
Distributions [contrib], [observiq], [splunk], [sumo]
Issues Open issues Closed issues
Code Owners @rnishtala-sumo

First discussed in: #879 (comment)

Here's an example PR demonstrating how this is done: open-telemetry/opentelemetry-collector-contrib#22800

It uses the mdatagen library, which isn't available in Ruby.

@kaylareopelle kaylareopelle added the documentation Improvements or additions to documentation label Apr 1, 2024
@dmathieu
Copy link
Member

dmathieu commented Apr 2, 2024

Note that while mdatagen is written in Go, and the documentation emphasizes the usage of //go:generate, it is actually only a binary that doesn't need a .go file to be executed.
It could be used within this repository rather easily, we'd just need to go install the binary in a pre-step.

Copy link
Contributor

github-actions bot commented May 3, 2024

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale Marks an issue/PR stale label May 3, 2024
@kaylareopelle kaylareopelle added keep Ensures stale-bot keeps this issue/PR open and removed stale Marks an issue/PR stale labels May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation keep Ensures stale-bot keeps this issue/PR open
Projects
None yet
Development

No branches or pull requests

2 participants