diff --git a/docs/en/development/browse_code.md b/docs/en/development/browse_code.md new file mode 100644 index 0000000000000000000000000000000000000000..0a99f5128cb47023bc5141384d986e899e39c1f4 --- /dev/null +++ b/docs/en/development/browse_code.md @@ -0,0 +1,7 @@ +# Browse ClickHouse Source Code + +You can use **Woboq** online code browser available [here](https://clickhouse-test-reports.s3.yandex.net/codebrowser/html_report///ClickHouse/dbms/src/index.html). It provides code navigation and semantic highlighting, search and indexing. The code snapshot is updated daily. + +Also you can browse sources on [GitHub](https://github.com/ClickHouse/ClickHouse) as usual. + +If you're interested what IDE to use, we recommend CLion, QT Creator, VS Code and KDevelop (with caveats). You can use any favourite IDE. Vim and Emacs also count. diff --git a/docs/fa/development/browse_code.md b/docs/fa/development/browse_code.md new file mode 120000 index 0000000000000000000000000000000000000000..8c08c622129bc4b51562b560de8b59d0ef6cfba9 --- /dev/null +++ b/docs/fa/development/browse_code.md @@ -0,0 +1 @@ +../../en/development/browse_code.md \ No newline at end of file diff --git a/docs/ja/development/browse_code.md b/docs/ja/development/browse_code.md new file mode 120000 index 0000000000000000000000000000000000000000..8c08c622129bc4b51562b560de8b59d0ef6cfba9 --- /dev/null +++ b/docs/ja/development/browse_code.md @@ -0,0 +1 @@ +../../en/development/browse_code.md \ No newline at end of file diff --git a/docs/ru/development/browse_code.md b/docs/ru/development/browse_code.md new file mode 100644 index 0000000000000000000000000000000000000000..e18ba21b889ffd585a1280d6acc45f18dc0b1a46 --- /dev/null +++ b/docs/ru/development/browse_code.md @@ -0,0 +1,7 @@ +# Навигация по коду ClickHouse + +Для навигации по коду онлайн доступен **Woboq**, он расположен [здесь](https://clickhouse-test-reports.s3.yandex.net/codebrowser/html_report///ClickHouse/dbms/src/index.html). В нём реализовано удобное перемещение между исходными файлами, семантическая подсветка, подсказки, индексация и поиск. Слепок кода обновляется ежедневно. + +Также вы можете просматривать исходники на [GitHub](https://github.com/ClickHouse/ClickHouse). + +Если вы интересуетесь, какую среду разработки выбрать для работы с ClickHouse, мы рекомендуем CLion, QT Creator, VSCode или KDevelop (с некоторыми предостережениями). Вы можете использовать свою любимую среду разработки, Vim и Emacs тоже считаются. diff --git a/docs/toc_en.yml b/docs/toc_en.yml index f5bbea39945b96b9c848f27174a12ee7eb2c3efd..042b0332bbcaadc8423d1a0d9e5acb01b458f5e6 100644 --- a/docs/toc_en.yml +++ b/docs/toc_en.yml @@ -218,14 +218,15 @@ nav: - 'Development': - 'hidden': 'development/index.md' + - 'The Beginner ClickHouse Developer Instruction': 'development/developer_instruction.md' - 'Overview of ClickHouse Architecture': 'development/architecture.md' + - 'Browse ClickHouse Source Code': 'development/browse_code.md' - 'How to Build ClickHouse on Linux': 'development/build.md' - 'How to Build ClickHouse on Mac OS X': 'development/build_osx.md' - 'How to Build ClickHouse on Linux for Mac OS X': 'development/build_cross_osx.md' - 'How to Build ClickHouse on Linux for AARCH64 (ARM64)': 'development/build_cross_arm.md' - 'How to Write C++ Code': 'development/style.md' - 'How to Run ClickHouse Tests': 'development/tests.md' - - 'The Beginner ClickHouse Developer Instruction': 'development/developer_instruction.md' - 'Third-Party Libraries Used': 'development/contrib.md' - 'What''s New': diff --git a/docs/toc_fa.yml b/docs/toc_fa.yml index b13c8092889049a75a576a8745a0360637dd38c5..9da4346dbbcf1905aaab84da4d15281f86e11a5a 100644 --- a/docs/toc_fa.yml +++ b/docs/toc_fa.yml @@ -59,7 +59,7 @@ nav: - 'Expression': 'data_types/special_data_types/expression.md' - 'Set': 'data_types/special_data_types/set.md' - 'Nothing': 'data_types/special_data_types/nothing.md' - - 'Interval': 'data_types/special_data_types/interval.md' + - 'Interval': 'data_types/special_data_types/interval.md' - 'Domains': - 'Overview': 'data_types/domains/overview.md' - 'IPv4': 'data_types/domains/ipv4.md' @@ -167,7 +167,7 @@ nav: - 'jdbc': 'query_language/table_functions/jdbc.md' - 'odbc': 'query_language/table_functions/odbc.md' - 'hdfs': 'query_language/table_functions/hdfs.md' - - 'input': 'query_language/table_functions/input.md' + - 'input': 'query_language/table_functions/input.md' - 'Dictionaries': - 'Introduction': 'query_language/dicts/index.md' - 'External Dictionaries': @@ -210,18 +210,19 @@ nav: - 'clickhouse-copier': 'operations/utils/clickhouse-copier.md' - 'clickhouse-local': 'operations/utils/clickhouse-local.md' - 'clickhouse-benchmark': 'operations/utils/clickhouse-benchmark.md' - + - 'F.A.Q.': - 'General Questions': 'faq/general.md' - 'Development': - 'hidden': 'development/index.md' + - 'The Beginner ClickHouse Developer Instruction': 'development/developer_instruction.md' - 'Overview of ClickHouse Architecture': 'development/architecture.md' + - 'Browse ClickHouse Source Code': 'development/browse_code.md' - 'How to Build ClickHouse on Linux': 'development/build.md' - 'How to Build ClickHouse on Mac OS X': 'development/build_osx.md' - 'How to Write C++ code': 'development/style.md' - 'How to Run ClickHouse Tests': 'development/tests.md' - - 'The Beginner ClickHouse Developer Instruction': 'development/developer_instruction.md' - 'Third-Party Libraries Used': 'development/contrib.md' - 'What''s New': diff --git a/docs/toc_ja.yml b/docs/toc_ja.yml index 31b384f97b5a4ee5612c73441e896568d6077508..786559124f5deb97ea8d84f6362ec36753a604c4 100644 --- a/docs/toc_ja.yml +++ b/docs/toc_ja.yml @@ -214,17 +214,18 @@ nav: - 'clickhouse-copier': 'operations/utils/clickhouse-copier.md' - 'clickhouse-local': 'operations/utils/clickhouse-local.md' - 'clickhouse-benchmark': 'operations/utils/clickhouse-benchmark.md' - + - 'Development': - 'hidden': 'development/index.md' + - 'The Beginner ClickHouse Developer Instruction': 'development/developer_instruction.md' - 'Overview of ClickHouse Architecture': 'development/architecture.md' + - 'Browse ClickHouse Source Code': 'development/browse_code.md' - 'How to Build ClickHouse on Linux': 'development/build.md' - 'How to Build ClickHouse on Mac OS X': 'development/build_osx.md' - 'How to Build ClickHouse on Linux for Mac OS X': 'development/build_cross_osx.md' - 'How to Build ClickHouse on Linux for AARCH64 (ARM64)': 'development/build_cross_arm.md' - 'How to Write C++ Code': 'development/style.md' - 'How to Run ClickHouse Tests': 'development/tests.md' - - 'The Beginner ClickHouse Developer Instruction': 'development/developer_instruction.md' - 'Third-Party Libraries Used': 'development/contrib.md' - 'What''s New': diff --git a/docs/toc_ru.yml b/docs/toc_ru.yml index cd42277328278ddfcf0420242c2b5e8c73b72670..c2b7ab6961ab3989d8dab8bb89c84c24daf4d2b8 100644 --- a/docs/toc_ru.yml +++ b/docs/toc_ru.yml @@ -138,7 +138,7 @@ nav: - 'mysql': 'query_language/table_functions/mysql.md' - 'jdbc': 'query_language/table_functions/jdbc.md' - 'odbc': 'query_language/table_functions/odbc.md' - - 'hdfs': 'query_language/table_functions/hdfs.md' + - 'hdfs': 'query_language/table_functions/hdfs.md' - 'input': 'query_language/table_functions/input.md' - 'Словари': - 'Введение': 'query_language/dicts/index.md' @@ -216,13 +216,14 @@ nav: - 'Разработка': - 'hidden': 'development/index.md' + - 'Инструкция для начинающего разработчика ClickHouse': 'development/developer_instruction.md' - 'Обзор архитектуры ClickHouse': 'development/architecture.md' + - 'Навигация по коду ClickHouse': 'development/browse_code.md' - 'Как собрать ClickHouse на Linux': 'development/build.md' - 'Как собрать ClickHouse на Mac OS X': 'development/build_osx.md' - 'Как собрать ClickHouse на Linux для Mac OS X': 'development/build_cross_osx.md' - 'Как писать код на C++': 'development/style.md' - 'Как запустить тесты': 'development/tests.md' - - 'Инструкция для начинающего разработчика ClickHouse': 'development/developer_instruction.md' - 'Сторонние библиотеки': 'development/contrib.md' - 'Что нового': diff --git a/docs/toc_zh.yml b/docs/toc_zh.yml index c07c3bb27114116c5576e73c9710a0e3f95cc504..8f33e5579d21cc1191986a2357e45e77581851d0 100644 --- a/docs/toc_zh.yml +++ b/docs/toc_zh.yml @@ -59,7 +59,7 @@ nav: - 'Expression': 'data_types/special_data_types/expression.md' - 'Set': 'data_types/special_data_types/set.md' - 'Nothing': 'data_types/special_data_types/nothing.md' - - 'Interval': 'data_types/special_data_types/interval.md' + - 'Interval': 'data_types/special_data_types/interval.md' - 'Domain类型': - '介绍': 'data_types/domains/overview.md' - 'IPv4': 'data_types/domains/ipv4.md' @@ -209,19 +209,20 @@ nav: - 'clickhouse-copier': 'operations/utils/clickhouse-copier.md' - 'clickhouse-local': 'operations/utils/clickhouse-local.md' - 'clickhouse-benchmark': 'operations/utils/clickhouse-benchmark.md' - + - '常见问题': - '一般的问题': 'faq/general.md' - '开发者指南': - 'hidden': 'development/index.md' + - '开发者指南': 'development/developer_instruction.md' - 'ClickHouse架构概述': 'development/architecture.md' + - 'ClickHouse Code Browser': 'development/browse_code.md' - '如何在Linux中编译ClickHouse': 'development/build.md' - '如何在Mac OS X中编译ClickHouse': 'development/build_osx.md' - '如何在Linux中编译Mac OS X ClickHouse': 'development/build_cross_osx.md' - '如何编写C++代码': 'development/style.md' - '如何运行ClickHouse测试': 'development/tests.md' - - '开发者指南': 'development/developer_instruction.md' - '使用的第三方库': 'development/contrib.md' - '新功能特性': diff --git a/docs/zh/development/browse_code.md b/docs/zh/development/browse_code.md new file mode 120000 index 0000000000000000000000000000000000000000..8c08c622129bc4b51562b560de8b59d0ef6cfba9 --- /dev/null +++ b/docs/zh/development/browse_code.md @@ -0,0 +1 @@ +../../en/development/browse_code.md \ No newline at end of file