Skip to content

[WIP] Fix header casing -> sentence case #3938

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contribute/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ When using URL parameters to control which version of documentation is displayed
there are conventions to follow for reliable functionality.
Here's how the `?v=v08` parameter relates to the snippet selection:

#### How It Works
#### How it works

The URL parameter acts as a selector that matches against the `version` property
in your component configuration. For example:
Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/_GCS_authentication_and_bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import Image from '@theme/IdealImage';

<Image size="md" img={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" border />

### Generate an Access key {#generate-an-access-key}
### Generate an access key {#generate-an-access-key}

### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret}

Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/_add_superset_detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are a few tasks to be done before running `docker compose`:
The commands below are to be run from the top level of the GitHub repo, `superset`.
:::

## Official ClickHouse Connect driver {#official-clickhouse-connect-driver}
## Official ClickHouse connect driver {#official-clickhouse-connect-driver}

To make the ClickHouse Connect driver available in the Superset deployment add it to the local requirements file:

Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/_users-and-roles-common.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ Roles are used to define groups of users for certain privileges instead of manag
Verify that only the above two rows are returned, rows with the value `B` in `column1` should be excluded.
:::

## Modifying Users and Roles {#modifying-users-and-roles}
## Modifying users and roles {#modifying-users-and-roles}

Users can be assigned multiple roles for a combination of privileges needed. When using multiple roles, the system will combine the roles to determine privileges, the net effect will be that the role permissions will be cumulative.

Expand Down
110 changes: 108 additions & 2 deletions docs/about-us/beta-and-experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Due to the uncertainty of when features are classified as generally available, w

The sections below explicitly describe the properties of **Beta** and **Experimental** features:

## Beta Features {#beta-features}
## Beta features {#beta-features}

- Under active development to make them generally available (GA)
- Main known issues can be tracked on GitHub
Expand All @@ -26,7 +26,7 @@ The following features are considered Beta in ClickHouse Cloud and are available

Note: please be sure to be using a current version of the ClickHouse [compatibility](/operations/settings/settings#compatibility) setting to be using a recently introduced feature.

## Experimental Features {#experimental-features}
## Experimental features {#experimental-features}

- May never become GA
- May be removed
Expand All @@ -44,4 +44,110 @@ Please note: no additional experimental features are allowed to be enabled in Cl
-->

<!--AUTOGENERATED_START-->
## Beta settings {#beta-settings}

| Name | Default |
|------|--------|
| [geotoh3_argument_order](/operations/settings/settings#geotoh3_argument_order) | `lat_lon` |
| [allow_experimental_parallel_reading_from_replicas](/operations/settings/settings#allow_experimental_parallel_reading_from_replicas) | `0` |
| [parallel_replicas_mode](/operations/settings/settings#parallel_replicas_mode) | `read_tasks` |
| [parallel_replicas_count](/operations/settings/settings#parallel_replicas_count) | `0` |
| [parallel_replica_offset](/operations/settings/settings#parallel_replica_offset) | `0` |
| [parallel_replicas_custom_key](/operations/settings/settings#parallel_replicas_custom_key) | `` |
| [parallel_replicas_custom_key_range_lower](/operations/settings/settings#parallel_replicas_custom_key_range_lower) | `0` |
| [parallel_replicas_custom_key_range_upper](/operations/settings/settings#parallel_replicas_custom_key_range_upper) | `0` |
| [cluster_for_parallel_replicas](/operations/settings/settings#cluster_for_parallel_replicas) | `` |
| [parallel_replicas_allow_in_with_subquery](/operations/settings/settings#parallel_replicas_allow_in_with_subquery) | `1` |
| [parallel_replicas_for_non_replicated_merge_tree](/operations/settings/settings#parallel_replicas_for_non_replicated_merge_tree) | `0` |
| [parallel_replicas_min_number_of_rows_per_replica](/operations/settings/settings#parallel_replicas_min_number_of_rows_per_replica) | `0` |
| [parallel_replicas_prefer_local_join](/operations/settings/settings#parallel_replicas_prefer_local_join) | `1` |
| [parallel_replicas_mark_segment_size](/operations/settings/settings#parallel_replicas_mark_segment_size) | `0` |
| [parallel_replicas_local_plan](/operations/settings/settings#parallel_replicas_local_plan) | `1` |
| [parallel_replicas_index_analysis_only_on_coordinator](/operations/settings/settings#parallel_replicas_index_analysis_only_on_coordinator) | `1` |
| [parallel_replicas_only_with_analyzer](/operations/settings/settings#parallel_replicas_only_with_analyzer) | `1` |
| [parallel_replicas_insert_select_local_pipeline](/operations/settings/settings#parallel_replicas_insert_select_local_pipeline) | `1` |
| [parallel_replicas_connect_timeout_ms](/operations/settings/settings#parallel_replicas_connect_timeout_ms) | `300` |
| [session_timezone](/operations/settings/settings#session_timezone) | `` |
| [low_priority_query_wait_time_ms](/operations/settings/settings#low_priority_query_wait_time_ms) | `1000` |
| [max_limit_for_vector_search_queries](/operations/settings/settings#max_limit_for_vector_search_queries) | `1000` |
| [hnsw_candidate_list_size_for_search](/operations/settings/settings#hnsw_candidate_list_size_for_search) | `256` |
| [vector_search_filter_strategy](/operations/settings/settings#vector_search_filter_strategy) | `auto` |
| [vector_search_postfilter_multiplier](/operations/settings/settings#vector_search_postfilter_multiplier) | `1` |
| [allow_experimental_delta_kernel_rs](/operations/settings/settings#allow_experimental_delta_kernel_rs) | `1` |
| [allow_remote_fs_zero_copy_replication](/operations/settings/merge-tree-settings#allow_remote_fs_zero_copy_replication) | `0` |


## Experimental settings {#experimental-settings}

| Name | Default |
|------|--------|
| [allow_experimental_kafka_offsets_storage_in_keeper](/operations/settings/settings#allow_experimental_kafka_offsets_storage_in_keeper) | `0` |
| [allow_experimental_correlated_subqueries](/operations/settings/settings#allow_experimental_correlated_subqueries) | `0` |
| [allow_experimental_materialized_postgresql_table](/operations/settings/settings#allow_experimental_materialized_postgresql_table) | `0` |
| [allow_experimental_funnel_functions](/operations/settings/settings#allow_experimental_funnel_functions) | `0` |
| [allow_experimental_nlp_functions](/operations/settings/settings#allow_experimental_nlp_functions) | `0` |
| [allow_experimental_hash_functions](/operations/settings/settings#allow_experimental_hash_functions) | `0` |
| [allow_experimental_object_type](/operations/settings/settings#allow_experimental_object_type) | `0` |
| [allow_experimental_time_series_table](/operations/settings/settings#allow_experimental_time_series_table) | `0` |
| [allow_experimental_vector_similarity_index](/operations/settings/settings#allow_experimental_vector_similarity_index) | `0` |
| [allow_experimental_codecs](/operations/settings/settings#allow_experimental_codecs) | `0` |
| [throw_on_unsupported_query_inside_transaction](/operations/settings/settings#throw_on_unsupported_query_inside_transaction) | `1` |
| [wait_changes_become_visible_after_commit_mode](/operations/settings/settings#wait_changes_become_visible_after_commit_mode) | `wait_unknown` |
| [implicit_transaction](/operations/settings/settings#implicit_transaction) | `0` |
| [grace_hash_join_initial_buckets](/operations/settings/settings#grace_hash_join_initial_buckets) | `1` |
| [grace_hash_join_max_buckets](/operations/settings/settings#grace_hash_join_max_buckets) | `1024` |
| [join_to_sort_minimum_perkey_rows](/operations/settings/settings#join_to_sort_minimum_perkey_rows) | `40` |
| [join_to_sort_maximum_table_rows](/operations/settings/settings#join_to_sort_maximum_table_rows) | `10000` |
| [allow_experimental_join_right_table_sorting](/operations/settings/settings#allow_experimental_join_right_table_sorting) | `0` |
| [allow_statistics_optimize](/operations/settings/settings#allow_statistics_optimize) | `0` |
| [allow_experimental_statistics](/operations/settings/settings#allow_experimental_statistics) | `0` |
| [allow_experimental_inverted_index](/operations/settings/settings#allow_experimental_inverted_index) | `0` |
| [allow_experimental_full_text_index](/operations/settings/settings#allow_experimental_full_text_index) | `0` |
| [allow_experimental_lightweight_update](/operations/settings/settings#allow_experimental_lightweight_update) | `0` |
| [allow_experimental_join_condition](/operations/settings/settings#allow_experimental_join_condition) | `0` |
| [allow_experimental_live_view](/operations/settings/settings#allow_experimental_live_view) | `0` |
| [live_view_heartbeat_interval](/operations/settings/settings#live_view_heartbeat_interval) | `15` |
| [max_live_view_insert_blocks_before_refresh](/operations/settings/settings#max_live_view_insert_blocks_before_refresh) | `64` |
| [allow_experimental_window_view](/operations/settings/settings#allow_experimental_window_view) | `0` |
| [window_view_clean_interval](/operations/settings/settings#window_view_clean_interval) | `60` |
| [window_view_heartbeat_interval](/operations/settings/settings#window_view_heartbeat_interval) | `15` |
| [wait_for_window_view_fire_signal_timeout](/operations/settings/settings#wait_for_window_view_fire_signal_timeout) | `10` |
| [stop_refreshable_materialized_views_on_startup](/operations/settings/settings#stop_refreshable_materialized_views_on_startup) | `0` |
| [allow_experimental_database_materialized_postgresql](/operations/settings/settings#allow_experimental_database_materialized_postgresql) | `0` |
| [allow_experimental_query_deduplication](/operations/settings/settings#allow_experimental_query_deduplication) | `0` |
| [allow_experimental_database_iceberg](/operations/settings/settings#allow_experimental_database_iceberg) | `0` |
| [allow_experimental_database_unity_catalog](/operations/settings/settings#allow_experimental_database_unity_catalog) | `0` |
| [allow_experimental_database_glue_catalog](/operations/settings/settings#allow_experimental_database_glue_catalog) | `0` |
| [allow_experimental_database_hms_catalog](/operations/settings/settings#allow_experimental_database_hms_catalog) | `0` |
| [allow_experimental_kusto_dialect](/operations/settings/settings#allow_experimental_kusto_dialect) | `0` |
| [allow_experimental_prql_dialect](/operations/settings/settings#allow_experimental_prql_dialect) | `0` |
| [enable_adaptive_memory_spill_scheduler](/operations/settings/settings#enable_adaptive_memory_spill_scheduler) | `0` |
| [make_distributed_plan](/operations/settings/settings#make_distributed_plan) | `0` |
| [distributed_plan_execute_locally](/operations/settings/settings#distributed_plan_execute_locally) | `0` |
| [distributed_plan_default_shuffle_join_bucket_count](/operations/settings/settings#distributed_plan_default_shuffle_join_bucket_count) | `8` |
| [distributed_plan_default_reader_bucket_count](/operations/settings/settings#distributed_plan_default_reader_bucket_count) | `8` |
| [distributed_plan_force_exchange_kind](/operations/settings/settings#distributed_plan_force_exchange_kind) | `` |
| [allow_experimental_ts_to_grid_aggregate_function](/operations/settings/settings#allow_experimental_ts_to_grid_aggregate_function) | `0` |
| [allow_experimental_replacing_merge_with_cleanup](/operations/settings/merge-tree-settings#allow_experimental_replacing_merge_with_cleanup) | `0` |
| [allow_experimental_reverse_key](/operations/settings/merge-tree-settings#allow_experimental_reverse_key) | `0` |
| [enable_replacing_merge_with_cleanup_for_min_age_to_force_merge](/operations/settings/merge-tree-settings#enable_replacing_merge_with_cleanup_for_min_age_to_force_merge) | `0` |
| [force_read_through_cache_for_merges](/operations/settings/merge-tree-settings#force_read_through_cache_for_merges) | `0` |
| [merge_selector_algorithm](/operations/settings/merge-tree-settings#merge_selector_algorithm) | `Simple` |
| [notify_newest_block_number](/operations/settings/merge-tree-settings#notify_newest_block_number) | `0` |
| [part_moves_between_shards_delay_seconds](/operations/settings/merge-tree-settings#part_moves_between_shards_delay_seconds) | `30` |
| [part_moves_between_shards_enable](/operations/settings/merge-tree-settings#part_moves_between_shards_enable) | `0` |
| [remote_fs_zero_copy_path_compatible_mode](/operations/settings/merge-tree-settings#remote_fs_zero_copy_path_compatible_mode) | `0` |
| [remote_fs_zero_copy_zookeeper_path](/operations/settings/merge-tree-settings#remote_fs_zero_copy_zookeeper_path) | `/clickhouse/zero_copy` |
| [remove_rolled_back_parts_immediately](/operations/settings/merge-tree-settings#remove_rolled_back_parts_immediately) | `1` |
| [shared_merge_tree_enable_coordinated_merges](/operations/settings/merge-tree-settings#shared_merge_tree_enable_coordinated_merges) | `0` |
| [shared_merge_tree_enable_keeper_parts_extra_data](/operations/settings/merge-tree-settings#shared_merge_tree_enable_keeper_parts_extra_data) | `0` |
| [shared_merge_tree_merge_coordinator_election_check_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_election_check_period_ms) | `30000` |
| [shared_merge_tree_merge_coordinator_factor](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_factor) | `2` |
| [shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms) | `10000` |
| [shared_merge_tree_merge_coordinator_max_merge_request_size](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_merge_request_size) | `20` |
| [shared_merge_tree_merge_coordinator_max_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_period_ms) | `10000` |
| [shared_merge_tree_merge_coordinator_merges_prepare_count](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_merges_prepare_count) | `100` |
| [shared_merge_tree_merge_coordinator_min_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_min_period_ms) | `1` |
| [shared_merge_tree_merge_worker_fast_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_fast_timeout_ms) | `100` |
| [shared_merge_tree_merge_worker_regular_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_regular_timeout_ms) | `10000` |
<!--AUTOGENERATED_END-->
2 changes: 1 addition & 1 deletion docs/about-us/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: 'ClickHouse Cloud'
ClickHouse Cloud is the cloud offering created by the original creators of the popular open-source OLAP database ClickHouse.
You can experience ClickHouse Cloud by [starting a free trial](https://console.clickhouse.cloud/signUp).

### ClickHouse Cloud benefits: {#clickhouse-cloud-benefits}
### ClickHouse Cloud benefits {#clickhouse-cloud-benefits}

Some of the benefits of using ClickHouse Cloud are described below:

Expand Down
Loading
Loading