clickhouse-docs icon indicating copy to clipboard operation
clickhouse-docs copied to clipboard

Versions for each feature

Open OmarBazaraa opened this issue 1 year ago • 6 comments

ClickHouse gets new features constantly and continuously, and the new features, settings, configurations, ..etc. get documented regularly on https://clickhouse.com/docs. It will be so nice and useful if the docs mention when a new feature was introduced or changed.

For example, for lightweight deletes, it will be nice if the docs mentions when the feature:

  1. Was first introduced as an experimental feature
  2. Became production ready and available by default in the server

Another example would be for settings and configurations. If the default value of a server setting changed from x to y on version v, then it will be useful to mention in the docs that:

  1. The default value is x.
  2. And starting from version v, the default value became y.

Basically mentioning the history of features and default values.

And thanks so much for the great product, ClickHouse!

OmarBazaraa avatar Mar 08 '24 12:03 OmarBazaraa

cc @melvynator FYI

tbragin avatar Mar 09 '24 03:03 tbragin

I've given this the X-Large size flag since it'll be a huge amount of work to go through all the existing docs/settings/functions/features and add this added in version XYZ status. I'm not saying we shouldn't do this -- having this status would be super valuable. I'm just setting expectations that this isn't an easy nor quick fix.

This would be a project all on it's own, similar to the functions-project the docs team is currently dealing with.

johnnymatthews avatar Mar 12 '24 13:03 johnnymatthews

Yeah I understand it'd be a huge effort. Starting with the new features/changes would still be beneficial tho. And thanks a lot!

OmarBazaraa avatar Mar 13 '24 12:03 OmarBazaraa

Opened an issue with an alternative solution https://github.com/ClickHouse/clickhouse-docs/issues/2492

Andersson007 avatar Jul 16 '24 08:07 Andersson007