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 validation for the code snippets in the components doc #123

Open
sujuka99 opened this issue Feb 21, 2023 · 1 comment
Open

Add validation for the code snippets in the components doc #123

sujuka99 opened this issue Feb 21, 2023 · 1 comment
Labels
area/documentation Improvements or additions to documentation

Comments

@sujuka99
Copy link
Contributor

preceeded by #112

In docs/user/references/components.md there are code snippets which are imported from docs/resources/pipeline-components.

The CI should compare the files against kpops/schema_pipeline.json.
Maybe something like ajv?

Eventually, the snippets will be generated automatically and this issue wouldn't be relevant anymore, but since that automation seems far away, this is the second best option imo.
@sujuka99 sujuka99 mentioned this issue Feb 23, 2023
Merged
@raminqaf raminqaf added the area/documentation Improvements or additions to documentation label Jun 7, 2023
@disrupted
Copy link
Member

might be possible to do it all in Python using jsonschema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@disrupted @raminqaf @sujuka99