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

Rewrite scripts/generate-component-docs.rb in Rust #22350

Open
pront opened this issue Feb 3, 2025 · 2 comments
Open

Rewrite scripts/generate-component-docs.rb in Rust #22350

pront opened this issue Feb 3, 2025 · 2 comments
Labels
domain: external docs Anything related to Vector's external, public documentation domain: internal docs Anything related to Vector's internal documentation meta: good first issue Anything that is good for new contributors. type: enhancement A value-adding code change that enhances its existing functionality.

Comments

@pront
Copy link
Member

pront commented Feb 3, 2025

Code is here: https://github.com/vectordotdev/vector/blob/master/scripts/generate-component-docs.rb

Longe term we want to remove the dependency to Ruby and generally we have had a great experience with Rust utilities.

@pront pront added meta: good first issue Anything that is good for new contributors. type: enhancement A value-adding code change that enhances its existing functionality. labels Feb 3, 2025
@titaneric
Copy link
Contributor

I would like to investigate this issue, and take a deep dive into https://github.com/vectordotdev/vector/blob/master/scripts/generate-component-docs.rb

I find the partial WIP code in https://github.com/vectordotdev/vector/blob/master/lib/docs-renderer/src/main.rs . Since it is really complicated, I might need LOTS of time to verify the docs generation and write the unit test for it.

@pront
Copy link
Member Author

pront commented Feb 18, 2025

Hi @titaneric, thank you for your interest in this and for all work you already did. Obviously there is no rush at all. I expect that removing Ruby will be a time consuming effort (but maybe also fun). Feel free to experiment as much as you want and you can ping me here if you need input.

@pront pront added domain: external docs Anything related to Vector's external, public documentation domain: internal docs Anything related to Vector's internal documentation labels Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: external docs Anything related to Vector's external, public documentation domain: internal docs Anything related to Vector's internal documentation meta: good first issue Anything that is good for new contributors. type: enhancement A value-adding code change that enhances its existing functionality.
Projects
None yet
Development

No branches or pull requests

2 participants