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

check embedded code blocks #1093

Merged
merged 18 commits into from
Mar 18, 2024
Merged

check embedded code blocks #1093

merged 18 commits into from
Mar 18, 2024

Conversation

sh-rp
Copy link
Collaborator

@sh-rp sh-rp commented Mar 14, 2024

Description

This PR will add a new short python script that will find all embedded code blocks in our docs and parse them to see if there are any very obvious errors. We may even be able to lint the python ones, but this is unclear as of now.

What it does now:

  • Forces you to mark a code block with the type of language, if it is not a language, setting it to text is allowed
  • Will parse python, toml, yaml and json blocks and fail if they are not parseable

@sh-rp sh-rp linked an issue Mar 14, 2024 that may be closed by this pull request
Copy link

netlify bot commented Mar 14, 2024

Deploy Preview for dlt-hub-docs canceled.

Name Link
🔨 Latest commit 958b387
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/65f746cad2ccbe000838dbde

@sh-rp sh-rp force-pushed the d#/check-embedded-code-blocks branch 3 times, most recently from 4eacd4d to aa1d850 Compare March 14, 2024 14:21
@sh-rp sh-rp force-pushed the d#/check-embedded-code-blocks branch from aa1d850 to 9547b6f Compare March 14, 2024 14:21
@sh-rp sh-rp force-pushed the d#/check-embedded-code-blocks branch from 2f3765e to d5be290 Compare March 14, 2024 19:39
@sh-rp sh-rp marked this pull request as ready for review March 14, 2024 19:46
@sh-rp sh-rp force-pushed the d#/check-embedded-code-blocks branch from a7effe0 to 87a2b20 Compare March 17, 2024 18:29
@sh-rp sh-rp self-assigned this Mar 18, 2024
Copy link
Collaborator

@rudolfix rudolfix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
@sh-rp but npm run start still runs some python right? didn't we plan to decouple this?

@sh-rp
Copy link
Collaborator Author

sh-rp commented Mar 18, 2024

LGTM! @sh-rp but npm run start still runs some python right? didn't we plan to decouple this?
@rudolfix yes, I want to do these things step by step. In the next pr i plan to remove python stuff from the npm commands (except for the main build command) and remove duplicated snippet code, but for the latter I still have to do some tests.

@sh-rp sh-rp merged commit ce701b5 into devel Mar 18, 2024
52 of 63 checks passed
@sh-rp sh-rp deleted the d#/check-embedded-code-blocks branch March 18, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make Snippets great again (Docs snippet management and qa improvements)
2 participants