@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

The latest updates on your projects. Learn more about Vercel for Git ↗︎

CC @mshustov, I remember you mentioned it would be nice to test code snippets in the docs. This change will allow you to import code into docs from integrations repos using url. Would this API be suitable for your use case as well, or are there some improvements we can make?

@Blargian This is an incredible improvement, thank you for taking a look at it!

or are there some improvements we can make?

We might need a way to specify not just a file, but specific rows to incluse not the whole file, but a snippet. That's how GitHub does it:
https://github.com/ClickHouse/clickhouse-docs/blob/main/package.json#L39-L43

It adds some complexity to the source file, though, since we'd need to ensure that either the lines are static or the docs are updated if the lines in the snippet move or content changed.

Per request, code for code blocks should be able to be imported from files or URLs.
This change will allow the user to specify file= or url= on code snippets. For example:
file=code_snippets/ClickStack/config-unstructured-logs-with-processor.yaml
url=https://raw.githubusercontent.com/ClickHouse/clickhouse-connect/refs/heads/main/examples/pandas_examples.py

May I ask you to include this information in the contribution guide, please? https://github.com/ClickHouse/clickhouse-docs/tree/main/contribute

@Blargian This is an incredible improvement, thank you for taking a look at it!

or are there some improvements we can make?

We might need a way to specify not just a file, but specific rows to incluse not the whole file, but a snippet. That's how GitHub does it: https://github.com/ClickHouse/clickhouse-docs/blob/main/package.json#L39-L43

It adds some complexity to the source file, though, since we'd need to ensure that either the lines are static or the docs are updated if the lines in the snippet move or content changed.

@mshustov good point. Maybe we could add to the example files comments something like #docs-begin and #docs-end (or //docs-begin, //docs-end etc depending on language of the file). The processing script can then extract only lines between those comments if they are present, otherwise the entire file contents. Advantage of this approach will be that it's only necessary to change the files with example code, and not the docs.