This is an automated email from the ASF dual-hosted git repository. xxyu pushed a commit to branch doc5.0 in repository https://gitbox.apache.org/repos/asf/kylin.git
commit eda2949c84ce188df9f245215daf5fd0e4840d5c Author: Mukvin <boyboys...@163.com> AuthorDate: Fri Aug 26 16:18:56 2022 +0800 KYLIN-5242 add doc for modeling --- website/docs/modeling/images/add_dimention.gif | Bin 305969 -> 279896 bytes .../docs/modeling/images/add_join_relations.png | Bin 45663 -> 29579 bytes website/docs/modeling/images/add_measure.gif | Bin 0 -> 189064 bytes website/docs/modeling/images/add_measure.png | Bin 283425 -> 0 bytes website/docs/modeling/images/add_model_set.png | Bin 105678 -> 51784 bytes website/docs/modeling/images/add_tables.png | Bin 76148 -> 45712 bytes .../docs/modeling/images/create_join_relations.gif | Bin 0 -> 279896 bytes .../docs/modeling/images/create_join_relations.png | Bin 345446 -> 0 bytes website/docs/modeling/images/model_list.png | Bin 144135 -> 38006 bytes .../modeling/images/model_overview/dimensions.png | Bin 270458 -> 66756 bytes website/docs/modeling/images/model_overview/er.png | Bin 240832 -> 39852 bytes .../modeling/images/model_overview/measures.png | Bin 209326 -> 33398 bytes .../images/model_overview/unfold_model.png | Bin 337877 -> 40493 bytes .../docs/modeling/images/modellist_more_info.png | Bin 330441 -> 39489 bytes website/docs/modeling/images/save_load_method.png | Bin 112102 -> 54968 bytes .../docs/modeling/images/star_model_created.png | Bin 90333 -> 51718 bytes .../docs/modeling/images/switch_to_fact_table.png | Bin 76376 -> 33622 bytes website/docs/modeling/load_data/by_date.md | 2 +- website/docs/modeling/load_data/full_build.md | 3 - .../load_data/images/full_load/full_load.png | Bin 131982 -> 34455 bytes .../load_data/images/full_load/full_load_smart.png | Bin 41844 -> 0 bytes .../load_data/images/full_load/load_data.png | Bin 169454 -> 43606 bytes .../load_data/images/full_load/load_data_smart.png | Bin 57021 -> 0 bytes .../modeling/load_data/images/full_load/notice.png | Bin 123106 -> 28130 bytes .../load_data/images/full_load/notice_smart.png | Bin 53973 -> 0 bytes .../load_data/images/full_load/refresh.png | Bin 55516 -> 0 bytes .../load_data/images/full_load/refresh_smart.png | Bin 51236 -> 0 bytes .../load_data/images/load_by_date/add_segment.png | Bin 174978 -> 41692 bytes .../images/load_by_date/build_all_index.png | Bin 491221 -> 128969 bytes .../images/load_by_date/build_all_index2.png | Bin 197965 -> 41057 bytes .../load_data/images/load_by_date/build_index.png | Bin 478215 -> 120293 bytes .../images/load_by_date/build_index_by_segment.png | Bin 178721 -> 32496 bytes .../load_data/images/load_by_date/delete_index.png | Bin 483308 -> 122617 bytes .../modeling/load_data/images/load_by_date/job.png | Bin 55216 -> 0 bytes .../load_data/images/load_by_date/job_smart.png | Bin 55216 -> 0 bytes .../load_data/images/load_by_date/load_data.png | Bin 168547 -> 43606 bytes .../load_data/images/load_by_date/load_ok.png | Bin 139019 -> 38856 bytes .../load_data/images/load_by_date/load_ok_2.png | Bin 58070 -> 0 bytes .../images/load_by_date/load_ok_smart.png | Bin 50925 -> 0 bytes .../load_data/images/load_by_date/load_twice.png | Bin 176020 -> 45249 bytes .../load_data/images/load_by_date/model_list_3.png | Bin 194216 -> 52303 bytes .../load_data/images/load_by_date/notice_2.png | Bin 169862 -> 51865 bytes .../load_data/images/load_by_date/range_en.png | Bin 90045 -> 0 bytes .../images/load_by_date/range_smart_2_en.png | Bin 59387 -> 0 bytes .../images/load_by_date/range_smart_en.png | Bin 58139 -> 0 bytes .../images/load_by_date/source_smart_en.png | Bin 157955 -> 0 bytes .../segment_operation_settings/images/segment.png | Bin 171751 -> 52240 bytes .../load_data/segment_operation_settings/intro.md | 2 +- .../segment_operation_settings/segment_merge.md | 4 +- website/docs/modeling/manual_modeling.md | 4 +- website/docs/modeling/model_concepts_operations.md | 6 +- .../images/multilevel_partitioning_set.png | Bin 49137 -> 12156 bytes .../advance_guide/model_metadata_managment.md | 2 +- .../advance_guide/multilevel_partitioning.md | 2 +- .../modeling/model_design/aggregation_group.md | 4 +- .../docs/modeling/model_design/computed_column.md | 19 ++- .../model_design/images/computed_column/cc_1.png | Bin 0 -> 96616 bytes .../model_design/images/computed_column/cc_11.png | Bin 0 -> 94064 bytes .../model_design/images/computed_column/cc_2.png | Bin 0 -> 25693 bytes .../model_design/images/computed_column/cc_3.png | Bin 0 -> 92496 bytes .../model_design/images/computed_column/cc_4.png | Bin 0 -> 28699 bytes .../model_design/images/computed_column/cc_5.png | Bin 0 -> 29304 bytes .../model_design/images/computed_column/cc_6.png | Bin 0 -> 122044 bytes .../model_design/images/computed_column/cc_8.png | Bin 0 -> 26076 bytes .../images/computed_column/cc_en_1.png | Bin 370515 -> 0 bytes .../images/computed_column/cc_en_10.png | Bin 314249 -> 0 bytes .../images/computed_column/cc_en_11.png | Bin 258431 -> 0 bytes .../images/computed_column/cc_en_2.png | Bin 92436 -> 0 bytes .../images/computed_column/cc_en_3.png | Bin 153929 -> 0 bytes .../images/computed_column/cc_en_4.png | Bin 101795 -> 0 bytes .../images/computed_column/cc_en_5.png | Bin 252495 -> 0 bytes .../images/computed_column/cc_en_6.png | Bin 145607 -> 0 bytes .../images/computed_column/cc_en_7.png | Bin 369282 -> 0 bytes .../images/computed_column/cc_en_8.png | Bin 91059 -> 0 bytes .../computed_column/computed_column_en.7.png | Bin 214934 -> 0 bytes .../computed_column/computed_column_en.8.png | Bin 472530 -> 0 bytes .../docs/modeling/model_design/images/index_1.png | Bin 475186 -> 0 bytes .../scd2/model_historical_dimension_table_scd2.png | Bin 95690 -> 51251 bytes .../model_historical_dimension_table_scd2_join.png | Bin 151089 -> 86487 bytes .../model_design/images/table_index/index_1.png | Bin 0 -> 121401 bytes .../images/table_index/table_index_1.png | Bin 0 -> 54536 bytes .../images/{ => table_index}/table_index_2.png | Bin .../images/{ => table_index}/table_index_3.png | Bin .../modeling/model_design/images/table_index_1.png | Bin 177044 -> 0 bytes .../model_design/measure_design/collect_set.md | 2 +- .../modeling/model_design/measure_design/corr.md | 4 +- .../measure_design/count_distinct_bitmap.md | 2 +- .../measure_design/images/add_collect_set.png | Bin 68039 -> 18634 bytes .../images/cd_measures_add_precisely.png | Bin 83925 -> 21191 bytes .../measure_design/images/cd_measures_edit.png | Bin 88159 -> 22234 bytes .../measure_design/images/collect_result.png | Bin 280978 -> 83779 bytes .../measure_design/images/concatws_result.png | Bin 278352 -> 83341 bytes .../measure_design/images/corr_add_measure.png | Bin 24368 -> 38039 bytes .../measure_design/images/corr_edit_measure.png | Bin 25500 -> 23603 bytes .../measure_design/images/corr_query.png | Bin 11558 -> 12596 bytes .../images/percentile_approximate.png | Bin 92465 -> 23215 bytes .../measure_design/images/percentile_result.png | Bin 211818 -> 53440 bytes .../images/percentile_result_hive.png | Bin 189696 -> 45260 bytes .../measure_design/images/topN_en_measure_edit.jpg | Bin 105031 -> 0 bytes .../measure_design/images/topN_measure_edit.png | Bin 0 -> 26123 bytes .../measure_design/images/topn_result.png | Bin 159569 -> 33920 bytes .../model_design/measure_design/sum_expression.md | 16 +-- .../modeling/model_design/measure_design/topn.md | 8 +- .../model_design/slowly_changing_dimension.md | 4 +- website/docs/modeling/model_design/table_index.md | 6 +- website/docs/monitor/job_concept_settings.md | 4 +- .../system-operation/cli_tool/rollback.md | 2 +- .../function/conditional_function.md | 2 +- .../operator_function/operator/logical_operator.md | 2 +- website/docs/quickstart/expert_mode_tutorial.md | 2 +- website/docs/quickstart/images/agg_group.png | Bin 254411 -> 90368 bytes website/docs/quickstart/images/dataload.png | Bin 174744 -> 37754 bytes website/docs/quickstart/images/dataset.png | Bin 221519 -> 46702 bytes website/docs/quickstart/images/datasource.png | Bin 236126 -> 80106 bytes .../images/installation_query_result.png | Bin 127355 -> 49378 bytes website/docs/quickstart/images/job.png | Bin 132111 -> 31838 bytes website/docs/quickstart/images/list.png | Bin 153847 -> 86365 bytes website/docs/quickstart/images/model.png | Bin 261649 -> 98033 bytes website/docs/quickstart/quick_start.md | 2 +- website/docs/quickstart/sample_dataset.md | 8 +- website/docs/restapi/project_api.md | 2 +- website/docs/tutorial/create-a-blog-post.md | 34 ----- website/docs/tutorial/create-a-document.md | 55 -------- website/docs/tutorial/create-a-page.md | 43 ------ website/docs/tutorial/deploy-your-site.md | 31 ----- website/docs/tutorial/markdown-features.mdx | 145 --------------------- website/sidebars.js | 22 ---- 127 files changed, 55 insertions(+), 389 deletions(-) diff --git a/website/docs/modeling/images/add_dimention.gif b/website/docs/modeling/images/add_dimention.gif old mode 100755 new mode 100644 index ffecf678a3..5ed9e71cab Binary files a/website/docs/modeling/images/add_dimention.gif and b/website/docs/modeling/images/add_dimention.gif differ diff --git a/website/docs/modeling/images/add_join_relations.png b/website/docs/modeling/images/add_join_relations.png index c5ee67d123..93fc636fd2 100644 Binary files a/website/docs/modeling/images/add_join_relations.png and b/website/docs/modeling/images/add_join_relations.png differ diff --git a/website/docs/modeling/images/add_measure.gif b/website/docs/modeling/images/add_measure.gif new file mode 100644 index 0000000000..1be35075e8 Binary files /dev/null and b/website/docs/modeling/images/add_measure.gif differ diff --git a/website/docs/modeling/images/add_measure.png b/website/docs/modeling/images/add_measure.png deleted file mode 100644 index 15ab8d2932..0000000000 Binary files a/website/docs/modeling/images/add_measure.png and /dev/null differ diff --git a/website/docs/modeling/images/add_model_set.png b/website/docs/modeling/images/add_model_set.png index 97cb3168f6..5944673ee4 100644 Binary files a/website/docs/modeling/images/add_model_set.png and b/website/docs/modeling/images/add_model_set.png differ diff --git a/website/docs/modeling/images/add_tables.png b/website/docs/modeling/images/add_tables.png index 0070ac5e89..99ec4133fe 100644 Binary files a/website/docs/modeling/images/add_tables.png and b/website/docs/modeling/images/add_tables.png differ diff --git a/website/docs/modeling/images/create_join_relations.gif b/website/docs/modeling/images/create_join_relations.gif new file mode 100644 index 0000000000..5ed9e71cab Binary files /dev/null and b/website/docs/modeling/images/create_join_relations.gif differ diff --git a/website/docs/modeling/images/create_join_relations.png b/website/docs/modeling/images/create_join_relations.png deleted file mode 100644 index 1b6720f735..0000000000 Binary files a/website/docs/modeling/images/create_join_relations.png and /dev/null differ diff --git a/website/docs/modeling/images/model_list.png b/website/docs/modeling/images/model_list.png index cc2bbbd064..3167631a3a 100644 Binary files a/website/docs/modeling/images/model_list.png and b/website/docs/modeling/images/model_list.png differ diff --git a/website/docs/modeling/images/model_overview/dimensions.png b/website/docs/modeling/images/model_overview/dimensions.png index 9528c0a163..ee021ecdcc 100644 Binary files a/website/docs/modeling/images/model_overview/dimensions.png and b/website/docs/modeling/images/model_overview/dimensions.png differ diff --git a/website/docs/modeling/images/model_overview/er.png b/website/docs/modeling/images/model_overview/er.png index 84119eb4db..fe6addc10f 100644 Binary files a/website/docs/modeling/images/model_overview/er.png and b/website/docs/modeling/images/model_overview/er.png differ diff --git a/website/docs/modeling/images/model_overview/measures.png b/website/docs/modeling/images/model_overview/measures.png index 9d9e8a63c9..e82c5614e2 100644 Binary files a/website/docs/modeling/images/model_overview/measures.png and b/website/docs/modeling/images/model_overview/measures.png differ diff --git a/website/docs/modeling/images/model_overview/unfold_model.png b/website/docs/modeling/images/model_overview/unfold_model.png index 6ba03f4df0..46c27182b6 100644 Binary files a/website/docs/modeling/images/model_overview/unfold_model.png and b/website/docs/modeling/images/model_overview/unfold_model.png differ diff --git a/website/docs/modeling/images/modellist_more_info.png b/website/docs/modeling/images/modellist_more_info.png index b47f6b9be2..0ff4524ecb 100644 Binary files a/website/docs/modeling/images/modellist_more_info.png and b/website/docs/modeling/images/modellist_more_info.png differ diff --git a/website/docs/modeling/images/save_load_method.png b/website/docs/modeling/images/save_load_method.png index 8158552f50..d50d3c6821 100644 Binary files a/website/docs/modeling/images/save_load_method.png and b/website/docs/modeling/images/save_load_method.png differ diff --git a/website/docs/modeling/images/star_model_created.png b/website/docs/modeling/images/star_model_created.png index db546dbd4e..94bf255e82 100644 Binary files a/website/docs/modeling/images/star_model_created.png and b/website/docs/modeling/images/star_model_created.png differ diff --git a/website/docs/modeling/images/switch_to_fact_table.png b/website/docs/modeling/images/switch_to_fact_table.png index f6b5e48dff..70d0f4298c 100644 Binary files a/website/docs/modeling/images/switch_to_fact_table.png and b/website/docs/modeling/images/switch_to_fact_table.png differ diff --git a/website/docs/modeling/load_data/by_date.md b/website/docs/modeling/load_data/by_date.md index 32cef99cec..3974d307f7 100755 --- a/website/docs/modeling/load_data/by_date.md +++ b/website/docs/modeling/load_data/by_date.md @@ -60,7 +60,7 @@ The start time range of Segment should greater than `1970-01-02`. 3. **Add Segment** - Besides the above methods, you can also increase the model data range by adding a new segment. Click the **+ Segment** button under segment list. Then click the **Save and Build Index** button in the pop-up window. After that, a building job will be submitted and the third segment will be shown when the job is finished. + Besides the above methods, you can also increase the model data range by adding a new segment. Click the **+ Segment** button under segment list. Then click the **Incremental Build** button in the pop-up window. After that, a building job will be submitted and the third segment will be shown when the job is finished. Note: If you want to use this function, you need to enable **Creating Reserved Segments**. Please refer to [Project Settings](../../operations/project-operation/project_settings.md) for more information. diff --git a/website/docs/modeling/load_data/full_build.md b/website/docs/modeling/load_data/full_build.md index dc4adcf4ee..cdc52ba399 100644 --- a/website/docs/modeling/load_data/full_build.md +++ b/website/docs/modeling/load_data/full_build.md @@ -14,9 +14,6 @@ last_update: date: 08/19/2022 --- - -## Full Load - If you want to load all the data in the source table, you can choose full load. The main contents are as follows: - [<span id="expert">Full Load</span>](#full-load-in-ai-augmented-mode-project) diff --git a/website/docs/modeling/load_data/images/full_load/full_load.png b/website/docs/modeling/load_data/images/full_load/full_load.png index edf962a876..ce9352460c 100644 Binary files a/website/docs/modeling/load_data/images/full_load/full_load.png and b/website/docs/modeling/load_data/images/full_load/full_load.png differ diff --git a/website/docs/modeling/load_data/images/full_load/full_load_smart.png b/website/docs/modeling/load_data/images/full_load/full_load_smart.png deleted file mode 100644 index 9b90493bf6..0000000000 Binary files a/website/docs/modeling/load_data/images/full_load/full_load_smart.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/full_load/load_data.png b/website/docs/modeling/load_data/images/full_load/load_data.png index 752c5e2c57..55e07f2544 100644 Binary files a/website/docs/modeling/load_data/images/full_load/load_data.png and b/website/docs/modeling/load_data/images/full_load/load_data.png differ diff --git a/website/docs/modeling/load_data/images/full_load/load_data_smart.png b/website/docs/modeling/load_data/images/full_load/load_data_smart.png deleted file mode 100755 index f864f9de69..0000000000 Binary files a/website/docs/modeling/load_data/images/full_load/load_data_smart.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/full_load/notice.png b/website/docs/modeling/load_data/images/full_load/notice.png index 411f62dc1d..39351ce244 100644 Binary files a/website/docs/modeling/load_data/images/full_load/notice.png and b/website/docs/modeling/load_data/images/full_load/notice.png differ diff --git a/website/docs/modeling/load_data/images/full_load/notice_smart.png b/website/docs/modeling/load_data/images/full_load/notice_smart.png deleted file mode 100644 index 89f3aa3312..0000000000 Binary files a/website/docs/modeling/load_data/images/full_load/notice_smart.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/full_load/refresh.png b/website/docs/modeling/load_data/images/full_load/refresh.png deleted file mode 100644 index bef6076dc1..0000000000 Binary files a/website/docs/modeling/load_data/images/full_load/refresh.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/full_load/refresh_smart.png b/website/docs/modeling/load_data/images/full_load/refresh_smart.png deleted file mode 100644 index 1af4d4945c..0000000000 Binary files a/website/docs/modeling/load_data/images/full_load/refresh_smart.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/add_segment.png b/website/docs/modeling/load_data/images/load_by_date/add_segment.png index 2de3a5ad94..bc177a6827 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/add_segment.png and b/website/docs/modeling/load_data/images/load_by_date/add_segment.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/build_all_index.png b/website/docs/modeling/load_data/images/load_by_date/build_all_index.png index eed0ad4e55..04b3976fcb 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/build_all_index.png and b/website/docs/modeling/load_data/images/load_by_date/build_all_index.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/build_all_index2.png b/website/docs/modeling/load_data/images/load_by_date/build_all_index2.png index a624daf368..f8001221bb 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/build_all_index2.png and b/website/docs/modeling/load_data/images/load_by_date/build_all_index2.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/build_index.png b/website/docs/modeling/load_data/images/load_by_date/build_index.png index 1f2a47b2f2..89cf53ce4a 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/build_index.png and b/website/docs/modeling/load_data/images/load_by_date/build_index.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/build_index_by_segment.png b/website/docs/modeling/load_data/images/load_by_date/build_index_by_segment.png index c6d91f78f1..d33b6aebb1 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/build_index_by_segment.png and b/website/docs/modeling/load_data/images/load_by_date/build_index_by_segment.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/delete_index.png b/website/docs/modeling/load_data/images/load_by_date/delete_index.png index 53a221f791..64905ae3d2 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/delete_index.png and b/website/docs/modeling/load_data/images/load_by_date/delete_index.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/job.png b/website/docs/modeling/load_data/images/load_by_date/job.png deleted file mode 100644 index 2d7a39a69f..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/job.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/job_smart.png b/website/docs/modeling/load_data/images/load_by_date/job_smart.png deleted file mode 100644 index 2d7a39a69f..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/job_smart.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/load_data.png b/website/docs/modeling/load_data/images/load_by_date/load_data.png index 77dfb17fad..55e07f2544 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/load_data.png and b/website/docs/modeling/load_data/images/load_by_date/load_data.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/load_ok.png b/website/docs/modeling/load_data/images/load_by_date/load_ok.png index 457638532b..5a6258c54c 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/load_ok.png and b/website/docs/modeling/load_data/images/load_by_date/load_ok.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/load_ok_2.png b/website/docs/modeling/load_data/images/load_by_date/load_ok_2.png deleted file mode 100644 index f271a73cc6..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/load_ok_2.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/load_ok_smart.png b/website/docs/modeling/load_data/images/load_by_date/load_ok_smart.png deleted file mode 100644 index 120d8ffb20..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/load_ok_smart.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/load_twice.png b/website/docs/modeling/load_data/images/load_by_date/load_twice.png index 347f831cbf..3501988587 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/load_twice.png and b/website/docs/modeling/load_data/images/load_by_date/load_twice.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/model_list_3.png b/website/docs/modeling/load_data/images/load_by_date/model_list_3.png index 77fea3f47d..12bcbac13c 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/model_list_3.png and b/website/docs/modeling/load_data/images/load_by_date/model_list_3.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/notice_2.png b/website/docs/modeling/load_data/images/load_by_date/notice_2.png index 995b059a0e..5cc1204068 100644 Binary files a/website/docs/modeling/load_data/images/load_by_date/notice_2.png and b/website/docs/modeling/load_data/images/load_by_date/notice_2.png differ diff --git a/website/docs/modeling/load_data/images/load_by_date/range_en.png b/website/docs/modeling/load_data/images/load_by_date/range_en.png deleted file mode 100644 index 5526316984..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/range_en.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/range_smart_2_en.png b/website/docs/modeling/load_data/images/load_by_date/range_smart_2_en.png deleted file mode 100644 index 6dbaa7be76..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/range_smart_2_en.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/range_smart_en.png b/website/docs/modeling/load_data/images/load_by_date/range_smart_en.png deleted file mode 100644 index 822fb51206..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/range_smart_en.png and /dev/null differ diff --git a/website/docs/modeling/load_data/images/load_by_date/source_smart_en.png b/website/docs/modeling/load_data/images/load_by_date/source_smart_en.png deleted file mode 100644 index 7490c836cc..0000000000 Binary files a/website/docs/modeling/load_data/images/load_by_date/source_smart_en.png and /dev/null differ diff --git a/website/docs/modeling/load_data/segment_operation_settings/images/segment.png b/website/docs/modeling/load_data/segment_operation_settings/images/segment.png index 8596946053..7e8fe97835 100644 Binary files a/website/docs/modeling/load_data/segment_operation_settings/images/segment.png and b/website/docs/modeling/load_data/segment_operation_settings/images/segment.png differ diff --git a/website/docs/modeling/load_data/segment_operation_settings/intro.md b/website/docs/modeling/load_data/segment_operation_settings/intro.md index 0d4b0ddea5..edcead68cb 100644 --- a/website/docs/modeling/load_data/segment_operation_settings/intro.md +++ b/website/docs/modeling/load_data/segment_operation_settings/intro.md @@ -26,7 +26,7 @@ User can access the Segment management interface by following these steps: 1. Open **Data Asset -> Model** page, and click the model (index group) name. 2. Select **Segment** tag. -The model list page in the AI augmented mode project is shown as below. +The model list page in the project is shown as below.  diff --git a/website/docs/modeling/load_data/segment_operation_settings/segment_merge.md b/website/docs/modeling/load_data/segment_operation_settings/segment_merge.md index 1e91167c59..d740a08edc 100644 --- a/website/docs/modeling/load_data/segment_operation_settings/segment_merge.md +++ b/website/docs/modeling/load_data/segment_operation_settings/segment_merge.md @@ -14,7 +14,7 @@ last_update: date: 08/19/2022 --- -In the incremental build mode, as the number of segments increases, the system may need to aggregate multiple segments to serve the query, which degrades the query performance and the query performance decreases. At the same time, a large number of small files will put pressure on the HDFS Namenode and affect the HDFS performance. Kyligence Enterprise provides a mechanism to control the number of segments - **Segments Merge **. +In the incremental build mode, as the number of segments increases, the system may need to aggregate multiple segments to serve the query, which degrades the query performance and the query performance decreases. At the same time, a large number of small files will put pressure on the HDFS Namenode and affect the HDFS performance. Apache Kylin provides a mechanism to control the number of segments - **Segments Merge **. ### <span id="manual">Manual Merge</span> @@ -28,7 +28,7 @@ In the web GUI ### <span id="auto">Auto Merge</span> -Merging Segments is very simple, but requires manual triggering of the merge from time to time. When there are multiple projects and models in the production environment, it becomes very cumbersome to trigger the merge operation one by one. Therefore, Kyligence Enterprise provides a segment automatic merging solution. +Merging Segments is very simple, but requires manual triggering of the merge from time to time. When there are multiple projects and models in the production environment, it becomes very cumbersome to trigger the merge operation one by one. Therefore, Apache Kylin provides a segment automatic merging solution. - [Auto-Merge settings](#setting) - [Auto-merge strategy](#strategy) - [Choose Segment](#choose) diff --git a/website/docs/modeling/manual_modeling.md b/website/docs/modeling/manual_modeling.md index 0a6bb8e9a7..fc503e047c 100644 --- a/website/docs/modeling/manual_modeling.md +++ b/website/docs/modeling/manual_modeling.md @@ -74,7 +74,7 @@ Kylin model consists of multiple tables and their join relations. In this articl 1. On the model editing page, drag a column to create a join relation between the foreign key of the fact table and the primary key of the dimension table. -  +  2. In the **Add Join Relationship** dialog box, follow the instructions below to set the join relation. @@ -130,7 +130,7 @@ P_LINEORDER LEFT JOIN PART ON P_LINEORDER.LO_PARTKEY = PART.P_PARTKEY To add dimensions in batch, click **+** in the **Measure** section. -  +  2. In the **Add Measure** dialog box, follow the instructions below to complete join relation settings. diff --git a/website/docs/modeling/model_concepts_operations.md b/website/docs/modeling/model_concepts_operations.md index dc7bed313c..ed016b0110 100644 --- a/website/docs/modeling/model_concepts_operations.md +++ b/website/docs/modeling/model_concepts_operations.md @@ -28,7 +28,7 @@ Model design refers to build the star model or snowflake model based on data tab 1. Log in to Web UI, switch to a project. -2. Navigate to **Data Asset -> Model** page, where models are shown in a list. The picture below is the index group list in AI augmented mode: +2. Navigate to **Data Asset -> Model** page, where models are shown in a list. The picture below is the index group list:  @@ -70,7 +70,7 @@ Model design refers to build the star model or snowflake model based on data tab ### <span id="operation">Model Operation</span> -You are only allowed to operate on models in **AI augmented mode**. You can hover on the righ tmost column **Actions** of the model list to get the action names. Specific actions are listed below: +You are only allowed to operate on models. You can hover on the right most column **Actions** of the model list to get the action names. Specific actions are listed below: - **Edit**: Click on the pencil shape button, enter into the model editing page. @@ -100,7 +100,7 @@ You are only allowed to operate on models in **AI augmented mode**. You can hove - **Online**: Makes a *Offline* model online. An online model should be able to answer related queries. -> **Note:** If the model is in *BROKEN* status, only the delete operation is allowed. +> **Note:** If the model is in *BROKEN* status, only the **delete** operation is allowed. ### <span id="more">Model Details</span> diff --git a/website/docs/modeling/model_design/advance_guide/images/multilevel_partitioning_set.png b/website/docs/modeling/model_design/advance_guide/images/multilevel_partitioning_set.png index d0abb0cbff..9e478e5f98 100644 Binary files a/website/docs/modeling/model_design/advance_guide/images/multilevel_partitioning_set.png and b/website/docs/modeling/model_design/advance_guide/images/multilevel_partitioning_set.png differ diff --git a/website/docs/modeling/model_design/advance_guide/model_metadata_managment.md b/website/docs/modeling/model_design/advance_guide/model_metadata_managment.md index 7d76bd4ccf..a38d356925 100644 --- a/website/docs/modeling/model_design/advance_guide/model_metadata_managment.md +++ b/website/docs/modeling/model_design/advance_guide/model_metadata_managment.md @@ -130,4 +130,4 @@ You can also export and import model metadata through API. For details, please r ### Known limitation {#know_limitation} - **After the model is imported, it cannot be undone. Please make a backup of the model in advance**. -- Only supports export and import between the first two versions of the same version number. For example, the model metadata package exported by Kylin 4.2.x does not support importing in Kylin 4.3.x. +- Only supports export and import between the first two versions of the same version number. For example, the model metadata package exported by Kylin 4.x does not support importing in Kylin 5.x. diff --git a/website/docs/modeling/model_design/advance_guide/multilevel_partitioning.md b/website/docs/modeling/model_design/advance_guide/multilevel_partitioning.md index cd252e3ff3..c9fb9db8ac 100644 --- a/website/docs/modeling/model_design/advance_guide/multilevel_partitioning.md +++ b/website/docs/modeling/model_design/advance_guide/multilevel_partitioning.md @@ -40,7 +40,7 @@ You can enable or disable support for multi-level partitioning in the model **Se After enabling multi-level partitioning, you can create a model in **Data Asset- Model- +Model**. Then you can choose to add sub-partition columns when saving the model, and the types currently supported as sub-partition columns are **tinyint,smallint,int/integer,bigint,double,decimal,timestamp,date,varchar,char,boolean**. -<img src="./images/multilevel_partitioning_model_save.en.png" width="40%"/> + Or you can adjust the sub-partition column in **Model List-...(More Actions)-Model Partition**. diff --git a/website/docs/modeling/model_design/aggregation_group.md b/website/docs/modeling/model_design/aggregation_group.md index be78eefcb1..b1fcaa5940 100644 --- a/website/docs/modeling/model_design/aggregation_group.md +++ b/website/docs/modeling/model_design/aggregation_group.md @@ -321,7 +321,7 @@ At the same time, according to laboratory test data, it is found that when the n Click **Data Asset -> Model** in the left navigation bar to enter the **Model List** page, then click the model name and you can view the details of aggregate index in **Index-Index Overview**. - + You can enter the index ID or index content in the **Search** box to filter the index. Index content includes the dimensions, measures, and columns contained in the index, the index content is fuzzy filtering, and the index ID is precisely filtered. You can click the button in the **Content** column to view the index details. What's more. you can edit and delete Custom(Table Index), and for other kinds of indexes, you can only delete. On the top of the list, you can see data range. Once you have already build index, it will show the time range of the data loaded in the index.If it is **full load**, the data range will show **full load**. @@ -372,7 +372,7 @@ The details page shows the combination of dimensions and all measures in the ind ### <span id="advanced">Advanced Settings</span> -In the aggregate index of AI augmented mode, you can set the ShardBy column, and the data will be stored according to the column fragmentation to improve query efficiency. You can set the filter dimension or grouping dimension frequently used in the query as the ShardBy column according to the cardinality from high to low. In current version, you can only set one ShardBy column. +In the aggregate index, you can set the ShardBy column, and the data will be stored according to the column fragmentation to improve query efficiency. You can set the filter dimension or grouping dimension frequently used in the query as the ShardBy column according to the cardinality from high to low. In current version, you can only set one ShardBy column. > Note: The ShardBy column is applied to all custom aggregate indexes. diff --git a/website/docs/modeling/model_design/computed_column.md b/website/docs/modeling/model_design/computed_column.md index 9ef35e6c56..977c121cf8 100644 --- a/website/docs/modeling/model_design/computed_column.md +++ b/website/docs/modeling/model_design/computed_column.md @@ -59,7 +59,6 @@ This section will describe the supported computed columns in Kylin, which includ - Expression only containing constants is not recommended to create computed column, such as `POWER(CAST(2 AS DOUBLE), 2)`. - If a function expression contains a column using the keywords as column name, it cannot be recommended as a computed column. For more details about keywords, please refer the **Keywords** section in [SQL Specification](../../../query/insight/sql_spec.en.md). - Computed columns only support `Hive` data source in current version. - - JDBC-based syntax expressions only supported in smart mode project rather than in AI augmented mode project. For example, we cannot support `{FN CONVERT(PRICE, SQL_BIGINT)}` as a computed column expression in AI augmented mode project. - Computed columns cannot be used as time partition columns and join keys. - If a function expression contains a table name or column name that is not started with letters or includes special characters, need to double quote this name. For example: `"100_KYLIN_SALES"."100_PRICE" * "100_KYLIN_SALES"."200_ITEM_COUNT"` @@ -78,33 +77,33 @@ We want to define two computed columns on this fact table, `T_PRICE_PER_ITEM` to First, click the button **CC** marked in the picture. Then a window of **Computed Column** will pop up. - + Secondly, click the button **+** in this window, and a dialog box of **Add Computed Column** will pop up. Please fill in the following information: - `Column name`: Defines the name of the computed column. - `Expression`: Calculates the calculation logic for the column. - + Third, click the button **Submit**, the system will verify whether the name or the expression of the computed column is legal. If anything is wrong, the system will give you a tip, please correct it and resubmit. Once the computed column is created, you will see it on the fact table. As shown below, `T_PRICE_PER_ITEM` appears in the fact table `P_LINEORDER`. - + Finally, after creating the computed column, click the button **+** in the window of **Dimension** to add a new dimension which is based on the computed column `YEAR_OF_ORDER`, as shown below: - + Also, click the button **+** in the window of **Measure** to add a new measure `TOTAL_PRICE` which is based on computed column `T_PRICE_PER_ITEM`, as shown below: - + ### <span id="edit">Edit Computed Columns</span> In some cases, we need to change the expression to adapt some business scenario changes. At this point, we can modify the expressions of the computable columns directly by editing the model. - + However, there are few limitations and attentions. Please read the following limitations carefully before using it: @@ -121,7 +120,7 @@ You can use computed columns in an aggregate index or in a table index. Let's ta Firstly, click the model name to get more information in the **Data Asset->Model** page. Then we need to click **Index** to enter the **Index Overview** page as shown below. Click **+ Index** to add index. - + After the submission is successful, we have completed the basic usage about computed columns including: @@ -189,11 +188,11 @@ Expression of computed column can be nested by other computed columns. You can d Here, we will introduce how to create a nested computed column. For example, we want to create column `D_PRICE_PER_ITEM = 2 * T_PRICE_PER_ITEM`. `D_PRICE_PER_ITEM` is the name of this nested computed column and `T_PRICE_PER_ITEM` is a predefined computed column. First, define a computed column named `T_PRICE_PER_ITEM`, click **Submit** - + Second, define a computed column named `D_PRICE_PER_ITEM` and the expression is `2 * T_PRICE_PER_ITEM`. - + After clicking **Submit** button, it will automatically validate the computed column expression. Then you will see the computed column information shown in the figure above. diff --git a/website/docs/modeling/model_design/images/computed_column/cc_1.png b/website/docs/modeling/model_design/images/computed_column/cc_1.png new file mode 100644 index 0000000000..f1f261c195 Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_1.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_11.png b/website/docs/modeling/model_design/images/computed_column/cc_11.png new file mode 100644 index 0000000000..973aaee590 Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_11.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_2.png b/website/docs/modeling/model_design/images/computed_column/cc_2.png new file mode 100644 index 0000000000..93c7919840 Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_2.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_3.png b/website/docs/modeling/model_design/images/computed_column/cc_3.png new file mode 100644 index 0000000000..a260e024cb Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_3.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_4.png b/website/docs/modeling/model_design/images/computed_column/cc_4.png new file mode 100644 index 0000000000..5f12cd3f80 Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_4.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_5.png b/website/docs/modeling/model_design/images/computed_column/cc_5.png new file mode 100644 index 0000000000..1feba27bb6 Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_5.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_6.png b/website/docs/modeling/model_design/images/computed_column/cc_6.png new file mode 100644 index 0000000000..ec280e72be Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_6.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_8.png b/website/docs/modeling/model_design/images/computed_column/cc_8.png new file mode 100644 index 0000000000..017bb56600 Binary files /dev/null and b/website/docs/modeling/model_design/images/computed_column/cc_8.png differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_1.png b/website/docs/modeling/model_design/images/computed_column/cc_en_1.png deleted file mode 100644 index 0bc6b920dd..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_1.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_10.png b/website/docs/modeling/model_design/images/computed_column/cc_en_10.png deleted file mode 100644 index 3a68a601a4..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_10.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_11.png b/website/docs/modeling/model_design/images/computed_column/cc_en_11.png deleted file mode 100644 index 653d1e40f7..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_11.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_2.png b/website/docs/modeling/model_design/images/computed_column/cc_en_2.png deleted file mode 100644 index 6eef0e9f81..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_2.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_3.png b/website/docs/modeling/model_design/images/computed_column/cc_en_3.png deleted file mode 100644 index a1ded30f20..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_3.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_4.png b/website/docs/modeling/model_design/images/computed_column/cc_en_4.png deleted file mode 100644 index 5a82aa283e..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_4.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_5.png b/website/docs/modeling/model_design/images/computed_column/cc_en_5.png deleted file mode 100644 index 124e5f5cb5..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_5.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_6.png b/website/docs/modeling/model_design/images/computed_column/cc_en_6.png deleted file mode 100644 index 296be288cb..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_6.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_7.png b/website/docs/modeling/model_design/images/computed_column/cc_en_7.png deleted file mode 100644 index b9861a5468..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_7.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/cc_en_8.png b/website/docs/modeling/model_design/images/computed_column/cc_en_8.png deleted file mode 100644 index dac6d7097c..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/cc_en_8.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/computed_column_en.7.png b/website/docs/modeling/model_design/images/computed_column/computed_column_en.7.png deleted file mode 100644 index b0384eb0f8..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/computed_column_en.7.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/computed_column/computed_column_en.8.png b/website/docs/modeling/model_design/images/computed_column/computed_column_en.8.png deleted file mode 100644 index bf92f79bb0..0000000000 Binary files a/website/docs/modeling/model_design/images/computed_column/computed_column_en.8.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/index_1.png b/website/docs/modeling/model_design/images/index_1.png deleted file mode 100644 index 8d65f60ee2..0000000000 Binary files a/website/docs/modeling/model_design/images/index_1.png and /dev/null differ diff --git a/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2.png b/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2.png index ac109748f9..48ba4d1b62 100644 Binary files a/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2.png and b/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2.png differ diff --git a/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2_join.png b/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2_join.png index b5e0951755..fafeb86e4f 100644 Binary files a/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2_join.png and b/website/docs/modeling/model_design/images/scd2/model_historical_dimension_table_scd2_join.png differ diff --git a/website/docs/modeling/model_design/images/table_index/index_1.png b/website/docs/modeling/model_design/images/table_index/index_1.png new file mode 100644 index 0000000000..f9ea65c760 Binary files /dev/null and b/website/docs/modeling/model_design/images/table_index/index_1.png differ diff --git a/website/docs/modeling/model_design/images/table_index/table_index_1.png b/website/docs/modeling/model_design/images/table_index/table_index_1.png new file mode 100644 index 0000000000..c4e9b6d662 Binary files /dev/null and b/website/docs/modeling/model_design/images/table_index/table_index_1.png differ diff --git a/website/docs/modeling/model_design/images/table_index_2.png b/website/docs/modeling/model_design/images/table_index/table_index_2.png similarity index 100% rename from website/docs/modeling/model_design/images/table_index_2.png rename to website/docs/modeling/model_design/images/table_index/table_index_2.png diff --git a/website/docs/modeling/model_design/images/table_index_3.png b/website/docs/modeling/model_design/images/table_index/table_index_3.png similarity index 100% rename from website/docs/modeling/model_design/images/table_index_3.png rename to website/docs/modeling/model_design/images/table_index/table_index_3.png diff --git a/website/docs/modeling/model_design/images/table_index_1.png b/website/docs/modeling/model_design/images/table_index_1.png deleted file mode 100644 index 8e33989b40..0000000000 Binary files a/website/docs/modeling/model_design/images/table_index_1.png and /dev/null differ diff --git a/website/docs/modeling/model_design/measure_design/collect_set.md b/website/docs/modeling/model_design/measure_design/collect_set.md index f2568efb58..08923f301b 100644 --- a/website/docs/modeling/model_design/measure_design/collect_set.md +++ b/website/docs/modeling/model_design/measure_design/collect_set.md @@ -15,7 +15,7 @@ last_update: --- -From v5, Kylin supports the COLLECT_SET function, which returns a set of unique elements as an array. The syntax is `COLLECT_SET(column)`. In smart mode, the product recommends the index containing the COLLECT_SET measure based on your query. In AI augmented mode the COLLECT_ SET measure is customizable. +From Kylin 5, Kylin supports the COLLECT_SET function, which returns a set of unique elements as an array. The syntax is `COLLECT_SET(column)`. The COLLECT_ SET measure is customizable. diff --git a/website/docs/modeling/model_design/measure_design/corr.md b/website/docs/modeling/model_design/measure_design/corr.md index b695b92ebd..9b7abc6183 100644 --- a/website/docs/modeling/model_design/measure_design/corr.md +++ b/website/docs/modeling/model_design/measure_design/corr.md @@ -28,8 +28,8 @@ CORR function will return a value to find the relationship between the two varia The query example in Kylin is as below: ```sql -SELECT corr(ITEM_COUNT, PRICE) -FROM TEST_KYLIN_FACT +SELECT corr(LO_ORDTOTALPRICE, LO_SHIPPRIOTITY) +FROM SSB.P_LINEORDER ``` diff --git a/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md b/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md index 874ed7df05..adf88e1e4e 100644 --- a/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md +++ b/website/docs/modeling/model_design/measure_design/count_distinct_bitmap.md @@ -17,7 +17,7 @@ last_update: Count Distinct is a frequently used function for many data analysts. We implement precise Count Distinct based on bitmap. For the data with type tiny int(byte), small int(short) and int, the value projects onto the bitmap directly. For the data with type long, string, and others, encode the value as String onto a dict and project the dict id onto the bitmap. The resulting measure is the serialized data of the bitmap, not just the count value. This ensures results are always correct withi [...] -In the project of Kylin 5 the Count Distinct (Precise) measure is customizable. +In the project of Kylin 5, the Count Distinct (Precise) measure is customizable. diff --git a/website/docs/modeling/model_design/measure_design/images/add_collect_set.png b/website/docs/modeling/model_design/measure_design/images/add_collect_set.png index 056e8158cf..27c48e7e30 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/add_collect_set.png and b/website/docs/modeling/model_design/measure_design/images/add_collect_set.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/cd_measures_add_precisely.png b/website/docs/modeling/model_design/measure_design/images/cd_measures_add_precisely.png index a9591b367c..15e650c4f2 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/cd_measures_add_precisely.png and b/website/docs/modeling/model_design/measure_design/images/cd_measures_add_precisely.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/cd_measures_edit.png b/website/docs/modeling/model_design/measure_design/images/cd_measures_edit.png index 45930e82b7..70fb2cadd8 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/cd_measures_edit.png and b/website/docs/modeling/model_design/measure_design/images/cd_measures_edit.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/collect_result.png b/website/docs/modeling/model_design/measure_design/images/collect_result.png index 7ed5c57d0a..11088135e9 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/collect_result.png and b/website/docs/modeling/model_design/measure_design/images/collect_result.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/concatws_result.png b/website/docs/modeling/model_design/measure_design/images/concatws_result.png index 376afafa5a..51a5cd1772 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/concatws_result.png and b/website/docs/modeling/model_design/measure_design/images/concatws_result.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/corr_add_measure.png b/website/docs/modeling/model_design/measure_design/images/corr_add_measure.png index 3335fb9caf..5d24039ec6 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/corr_add_measure.png and b/website/docs/modeling/model_design/measure_design/images/corr_add_measure.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/corr_edit_measure.png b/website/docs/modeling/model_design/measure_design/images/corr_edit_measure.png index 3ea8b33d20..b6ba442764 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/corr_edit_measure.png and b/website/docs/modeling/model_design/measure_design/images/corr_edit_measure.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/corr_query.png b/website/docs/modeling/model_design/measure_design/images/corr_query.png index 16805b2384..3ee6107719 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/corr_query.png and b/website/docs/modeling/model_design/measure_design/images/corr_query.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/percentile_approximate.png b/website/docs/modeling/model_design/measure_design/images/percentile_approximate.png index 5089e8ec31..bf71864701 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/percentile_approximate.png and b/website/docs/modeling/model_design/measure_design/images/percentile_approximate.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/percentile_result.png b/website/docs/modeling/model_design/measure_design/images/percentile_result.png index aa4e1bfd35..7b248cea0c 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/percentile_result.png and b/website/docs/modeling/model_design/measure_design/images/percentile_result.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/percentile_result_hive.png b/website/docs/modeling/model_design/measure_design/images/percentile_result_hive.png index 27edf8c495..85f01697b8 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/percentile_result_hive.png and b/website/docs/modeling/model_design/measure_design/images/percentile_result_hive.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/topN_en_measure_edit.jpg b/website/docs/modeling/model_design/measure_design/images/topN_en_measure_edit.jpg deleted file mode 100644 index 96fe2758fb..0000000000 Binary files a/website/docs/modeling/model_design/measure_design/images/topN_en_measure_edit.jpg and /dev/null differ diff --git a/website/docs/modeling/model_design/measure_design/images/topN_measure_edit.png b/website/docs/modeling/model_design/measure_design/images/topN_measure_edit.png new file mode 100644 index 0000000000..008167c334 Binary files /dev/null and b/website/docs/modeling/model_design/measure_design/images/topN_measure_edit.png differ diff --git a/website/docs/modeling/model_design/measure_design/images/topn_result.png b/website/docs/modeling/model_design/measure_design/images/topn_result.png index a7fde36147..5d941156c2 100644 Binary files a/website/docs/modeling/model_design/measure_design/images/topn_result.png and b/website/docs/modeling/model_design/measure_design/images/topn_result.png differ diff --git a/website/docs/modeling/model_design/measure_design/sum_expression.md b/website/docs/modeling/model_design/measure_design/sum_expression.md index f7138517cf..c27db5f250 100644 --- a/website/docs/modeling/model_design/measure_design/sum_expression.md +++ b/website/docs/modeling/model_design/measure_design/sum_expression.md @@ -44,14 +44,14 @@ For example: ```sql select - sum(case when ORDERPRIOTITY='1-URGENT' then ORDTOTALPRICE else null end) -from LINEORDER + sum(case when LO_ORDERPRIOTITY='1-URGENT' then LO_ORDTOTALPRICE else null end) +from SSB.LO_LINEORDER ``` In order to run this SQL, set your model as below in addition to enable sum(expression): -- Define all columns in the `when` clause as dimensions, like the `ORDERPRIOTITY` in this example. -- Define all columns in the `then` clause as Sum measure, like the `sum(ORDTOTALPRICE)` in this example. +- Define all columns in the `when` clause as dimensions, like the `LO_ORDERPRIOTITY` in this example. +- Define all columns in the `then` clause as Sum measure, like the `sum(LO_ORDTOTALPRICE)` in this example. Then, the model will be able to run the above SQL. @@ -62,12 +62,12 @@ Then, the model will be able to run the above SQL. For example: ```sql -select sum(ORDTOTALPRICE * 3) from LINEORDER +select sum(LO_ORDTOTALPRICE * 3) from SSB.LO_LINEORDER ``` In order to run this SQL, set your model as below in addition to enable sum(expression): -- Define the column in the `sum` function as Sum measure, like the `sum(ORDTOTALPRICE)` in this example. +- Define the column in the `sum` function as Sum measure, like the `sum(LO_ORDTOTALPRICE)` in this example. Then, the model will be able to run the above SQL. @@ -78,7 +78,7 @@ Then, the model will be able to run the above SQL. For example: ```sql -select sum(3) from LINEORDER +select sum(3) from P_LINEORDER ``` In order to run this SQL, just enable the sum(expression) feature. No other setting on model is needed. @@ -88,7 +88,7 @@ In order to run this SQL, just enable the sum(expression) feature. No other sett For example: ```sql -select sum(cast((case when ORDERPRIOTITY='1-URGENT' then ORDTOTALPRICE else null end) as bigint)) from LINEORDER +select sum(cast((case when LO_ORDERPRIOTITY='1-URGENT' then LO_ORDTOTALPRICE else null end) as bigint)) from SSB.P_LINEORDER ``` In order to run this SQL, set your model as below in addition to enable sum(expression): diff --git a/website/docs/modeling/model_design/measure_design/topn.md b/website/docs/modeling/model_design/measure_design/topn.md index f9a4694092..b6510625a1 100644 --- a/website/docs/modeling/model_design/measure_design/topn.md +++ b/website/docs/modeling/model_design/measure_design/topn.md @@ -19,7 +19,7 @@ Finding the Top-N entities from a dataset is a frequent use case in data mining. As both the raw dataset and the number of entities increase in the big data era, this need is getting stronger than ever before. Without pre-calculation, retrieving the Top-K entities among a distributed big dataset may take a long time, making the pushdown query inefficient. -In v2.1 and higher, Apache Kylin introduces the “Top-N” measure, aiming to pre-calculate the top entities during the index build phase. In the query phase, Kyligence Enterprise can quickly fetch and return the top records. The performance will be much better than a model without “Top-N” and give the user more power to analzye data. +In v2.1 and higher, Apache Kylin introduces the “Top-N” measure, aiming to pre-calculate the top entities during the index build phase. In the query phase, Apache Kylin can quickly fetch and return the top records. The performance will be much better than a model without “Top-N” and give the user more power to analzye data. In the project of Kylin 5 the Top-N measure is customizable. @@ -45,7 +45,7 @@ We will use the fact table `SSB.P_LINEORDER`. This is a mockup of transactions t ```sql SELECT LO_PARTKEY, SUM(LO_ORDTOTALPRICE) AS TOTAL_AMOUNT FROM SSB.P_LINEORDER -WHERE LO_ORDERDATE between '19930601' AND '19940601' +WHERE LO_ORDERDATE between '1993-06-01' AND '1994-06-01' AND LO_SUPPKEY in (1) group by LO_PARTKEY order by SUM(LO_ORDTOTALPRICE) DESC @@ -58,9 +58,9 @@ It returns multiple records. See below: *Method 2*: In order to get the desired query performance on a massive dataset, we recommend creating a Top-N measure for the target column and pre-calculating it when building the index. Please add a measure in the model editing page as follows. Fill in the measure **Name** for example `TOTAL_AMOUNT`, select **Function** as **TOP_N**, select **Function Parameter** as **Top 100**, and finally select the target column from the dropdown list. - + -Once the measure is added and the model is saved, you need to go to the **Edit Aggregate Index** page, add the corresponding dimensions and measures to the appropriate aggregate group according to your business scenario, and the new aggregate index will be generated after submission. In this example, the new index will contain the dimension `LO_ORDERDATE`, `LO_SUPPKEY`, `LO_PARTKEY` and the measure ` SUM(LO_ORDTOTALPRICE) `, you need to build index and load data to complete the precomput [...] +Once the measure is added and the model is saved, you need to go to the **Edit Aggregate Index** page, add the corresponding dimensions and measures to the appropriate aggregate group according to your business scenario, and the new aggregate index will be generated after submission. In this example, the new index will contain the dimension `LO_ORDERDATE`, `LO_SUPPKEY`, `LO_PARTKEY` and the measure ` SUM(LO_ORDTOTALPRICE) `, you need to build index and load data to complete the precomput [...] diff --git a/website/docs/modeling/model_design/slowly_changing_dimension.md b/website/docs/modeling/model_design/slowly_changing_dimension.md index 550ed30b6e..b451b94ea9 100644 --- a/website/docs/modeling/model_design/slowly_changing_dimension.md +++ b/website/docs/modeling/model_design/slowly_changing_dimension.md @@ -25,7 +25,7 @@ Dealing with this issue involves SCD management methodologies referred to as Typ For SCD Type 2(subsequently referred to as "SCD2"), Only supports the model based on the History Table, Below screen-shot illustrates the basics: - + ### History Table @@ -58,7 +58,7 @@ Every time Zhang San change his work location, the History Table adds a new line In order to be able to query the historical information of the History Table, the fact table is often used to filter the start and end dates of the History Table records, like`LO_ORDERDATE>=START_DATE AND LO_ORDERDATE<END_DATE` As shown below: -<img src="images/scd2/model_historical_dimension_table_scd2_join.en.png" alt="model_historical_dimension_table_scd2_join " style="zoom:50%;" /> + In order to use the History Table to meet the demand for slow dimensions, you can click **Setting -> Advanced Settings -> Support History Table** to turn on the function of supporting History Table. As shown below: diff --git a/website/docs/modeling/model_design/table_index.md b/website/docs/modeling/model_design/table_index.md index e4ab2d4206..61982ea565 100644 --- a/website/docs/modeling/model_design/table_index.md +++ b/website/docs/modeling/model_design/table_index.md @@ -22,7 +22,7 @@ Kylin provides table index function to support querying on raw data. To create a In the **Data Asset -> Model** page, click the model name,then click **Index** and click **Table Index** button under **+ Index** in the **Index Overview** tab or **+**(Add Table Index) button in the **Table Index** tab to enter the **Add Table Index** page. You can edit the table index in the pop-up window shown below and put the required column in a table index. - + The fields are defined as follows: @@ -53,7 +53,7 @@ You can add multiple table indices. After building the table index and loading d -###View Table Index +### View Table Index In the **Data Asset -> Model** page, click the model name and click **Index**. Under the **Index Overview** tab, you can view the details of table index. @@ -62,7 +62,7 @@ You can click the icon beside the status and see the details in View Index Detai If you need to add base indexes when there is no base index or when a base index is missing. Click **+ Index** to add the base indexes in the drop-down box. - + For more information about the Index List, such as the index status, please refer to the [Aggregate Index](aggregation_group.md) section. diff --git a/website/docs/monitor/job_concept_settings.md b/website/docs/monitor/job_concept_settings.md index 2339e26707..05f379227d 100644 --- a/website/docs/monitor/job_concept_settings.md +++ b/website/docs/monitor/job_concept_settings.md @@ -51,13 +51,13 @@ You can view the job details in the navigation bar **Monitor -> Job**. As shown > **Attention**: The start time of loading data must be greater than the end time of the loaded data. - - In AI augmented mode, in the navigation bar **Data Asset -> Model**, loading data within a time range of the model will trigger the job. + - In the navigation bar **Data Asset -> Model**, loading data within a time range of the model will trigger the job. 3. **Merge Data**: When the system detects a sufficient number of segments, it will automatically trigger the job of merging data. You can set the parameters of merging segments in the navigation bar **Setting -> Segment Settings**. For detailed message, you can refer to [Segment Operation and Settings](../modeling/load_data/segment_operation_settings/intro.md). 4. **Refresh Data**: Job for refreshing segments. - - In AI augmented mode, in the navigation bar **Data Asset -> Model**, refreshing data of a specified segment in the specified model will trigger the job. + - In the navigation bar **Data Asset -> Model**, refreshing data of a specified segment in the specified model will trigger the job. > **Attention**:If you refresh n segments at the same time, it will trigger n jobs to refresh the data, and arrange them in the job queue according to the chronological order of original segments. You can view them in the **Monitor -> Job** bar. diff --git a/website/docs/operations/system-operation/cli_tool/rollback.md b/website/docs/operations/system-operation/cli_tool/rollback.md index a27193153c..9d55a8b9b9 100644 --- a/website/docs/operations/system-operation/cli_tool/rollback.md +++ b/website/docs/operations/system-operation/cli_tool/rollback.md @@ -46,7 +46,7 @@ When a user error causes metadata or data loss, or when Kylin is unavailable due Below is a common scenario of using the rollback tool in the operational process, describing how the tool can be used to roll back and downgrade issues in the event of product agnostic issues. -- In AI augmented mode, the `rollback_example` project has recommendation with recommendation mode turned on. If the user accepts the recommendations under the model at 16:06:05 on September 1, 2020, then the original model of this project and the metadata related to the index will be updated. +- The `rollback_example` project has recommendation with recommendation mode turned on. If the user accepts the recommendations under the model at 16:06:05 on September 1, 2020, then the original model of this project and the metadata related to the index will be updated.  - At this point, it can be seen that the index recommended by the system has been generated, but at this point there is an unknown problem, which results in the index not being built properly and affects the health of the entire cluster, and the product is also in an inoperable state. - To guarantee production availability, the rollback tool can be used to roll back the metadata and data for this item to 15:20 on September 1. diff --git a/website/docs/query/insight/operator_function/function/conditional_function.md b/website/docs/query/insight/operator_function/function/conditional_function.md index 44274c925c..9cf9d64b4a 100644 --- a/website/docs/query/insight/operator_function/function/conditional_function.md +++ b/website/docs/query/insight/operator_function/function/conditional_function.md @@ -22,4 +22,4 @@ last_update: | COALESCE(value, value [, value ]*) | Return the first not null value. | `COALESCE(NULL,NULL,5)`<br /> = 5 | ✔️ | ✔️ | ✔️ | ✔️ | | IFNULL(value1, value2) | Return value2 if value1 is NULL. Otherwise, return value1. | `IFNULL('kyligence','apache')`<br /> = 'kyligence' | ✔️ | ✔️ | ✔️ | ✔️ | | ISNULL(value) | Return true if value is NULL. Otherwise, return false. | `ISNULL('kyligence')` <br /> = false | ✔️ | ✔️ | ✔️ | ✔️ | -| NVL(value1, value2) | Return value2 if value1 is NULL. Otherwise, return value1. Value1, value2 must have same data type. Before Kyligence Enterprise 4.2.3, you need to add parameter `kylin.query.calcite.extras-props.FUN=standard,oracle` to kylin.properties before using this function. | `NVL('kyligence','apache')`<br /> = 'kyligence' | ✔️ | ✔️ | ✔️ | ✔️ | +| NVL(value1, value2) | Return value2 if value1 is NULL. Otherwise, return value1. Value1, value2 must have same data type. | `NVL('kylin','apache')`<br /> = 'kylin' | ✔️ | ✔️ | ✔️ | ✔️ | diff --git a/website/docs/query/insight/operator_function/operator/logical_operator.md b/website/docs/query/insight/operator_function/operator/logical_operator.md index a5d2a6634a..da48b93cba 100644 --- a/website/docs/query/insight/operator_function/operator/logical_operator.md +++ b/website/docs/query/insight/operator_function/operator/logical_operator.md @@ -17,7 +17,7 @@ last_update: ## Logical Operators -This section introduces the logical operators supported by Kyligence Enterprise. The values of logical propositions are TRUE, FALSE, and UNKNOWN. The following `boolean` refers to a logical proposition. +This section introduces the logical operators supported by Apache Kylin. The values of logical propositions are TRUE, FALSE, and UNKNOWN. The following `boolean` refers to a logical proposition. | Operator | Description | Syntax | Example | | ------------ | ---------------------------------------- | --------------------- | ----------------------------- | diff --git a/website/docs/quickstart/expert_mode_tutorial.md b/website/docs/quickstart/expert_mode_tutorial.md index cbafa0496e..b010131dd7 100644 --- a/website/docs/quickstart/expert_mode_tutorial.md +++ b/website/docs/quickstart/expert_mode_tutorial.md @@ -21,7 +21,7 @@ Kylin 5.0 provides which the modeling process dominated by user. In this section 1. Kylin 5.0 provides one mode: You are able to design your own models to fulfill your analysis demands and load data for your models. You can design the index manually and let the system continue to improve the index according your query habits and data characteristics. -2. We will use the SSB (Star Schema Benchmark) sample data to introduce the AI augmented mode project. You can find out how to import the sample data in the [Import Data from Hive](../datasource/import_hive.md) section. +2. We will use the SSB (Star Schema Benchmark) sample data to introduce the project. You can find out how to import the sample data in the [Import Data from Hive](../datasource/import_hive.md) section. ### <span id="project">Create Project</span> diff --git a/website/docs/quickstart/images/agg_group.png b/website/docs/quickstart/images/agg_group.png index 84f6fc9496..eb9ef5e23b 100644 Binary files a/website/docs/quickstart/images/agg_group.png and b/website/docs/quickstart/images/agg_group.png differ diff --git a/website/docs/quickstart/images/dataload.png b/website/docs/quickstart/images/dataload.png index 3372b7e1e1..e569106d3b 100644 Binary files a/website/docs/quickstart/images/dataload.png and b/website/docs/quickstart/images/dataload.png differ diff --git a/website/docs/quickstart/images/dataset.png b/website/docs/quickstart/images/dataset.png index d6eb9c5b41..4eb95036a1 100644 Binary files a/website/docs/quickstart/images/dataset.png and b/website/docs/quickstart/images/dataset.png differ diff --git a/website/docs/quickstart/images/datasource.png b/website/docs/quickstart/images/datasource.png index 6c0cf0ffa0..48684076f8 100644 Binary files a/website/docs/quickstart/images/datasource.png and b/website/docs/quickstart/images/datasource.png differ diff --git a/website/docs/quickstart/images/installation_query_result.png b/website/docs/quickstart/images/installation_query_result.png index f2bd43f594..9a6cb770c0 100644 Binary files a/website/docs/quickstart/images/installation_query_result.png and b/website/docs/quickstart/images/installation_query_result.png differ diff --git a/website/docs/quickstart/images/job.png b/website/docs/quickstart/images/job.png index 9422e463a5..d0f4a7c36a 100644 Binary files a/website/docs/quickstart/images/job.png and b/website/docs/quickstart/images/job.png differ diff --git a/website/docs/quickstart/images/list.png b/website/docs/quickstart/images/list.png index 937e7782c0..cfbd7db7ae 100644 Binary files a/website/docs/quickstart/images/list.png and b/website/docs/quickstart/images/list.png differ diff --git a/website/docs/quickstart/images/model.png b/website/docs/quickstart/images/model.png index 609b8d4e6f..4c542a644a 100644 Binary files a/website/docs/quickstart/images/model.png and b/website/docs/quickstart/images/model.png differ diff --git a/website/docs/quickstart/quick_start.md b/website/docs/quickstart/quick_start.md index 69c91df583..67e137036c 100644 --- a/website/docs/quickstart/quick_start.md +++ b/website/docs/quickstart/quick_start.md @@ -220,7 +220,7 @@ When the metadata is loaded successfully, at the **Insight** page, 6 sample hive ```sql SELECT LO_PARTKEY, SUM(LO_REVENUE) AS TOTAL_REVENUE FROM SSB.P_LINEORDER -WHERE LO_ORDERDATE between '19930601' AND '19940601' +WHERE LO_ORDERDATE between '1993-06-01' AND '1994-06-01' group by LO_PARTKEY order by SUM(LO_REVENUE) DESC ``` diff --git a/website/docs/quickstart/sample_dataset.md b/website/docs/quickstart/sample_dataset.md index 11a913b342..68aa91cb4e 100755 --- a/website/docs/quickstart/sample_dataset.md +++ b/website/docs/quickstart/sample_dataset.md @@ -36,10 +36,10 @@ The 5 tables together constitute the structure of the entire star data model. Be Join Relationships: ```sql -LINEORDER LEFT JOIN DATES ON LINEORDER.LO_ORDERDATE = DATES.D_DATEKEY -LINEORDER LEFT JOIN CUSTOMER ON LINEORDER.LO_CUSTKEY = CUSTOMER.C_CUSTKEY -LINEORDER LEFT JOIN SUPPLIER ON LINEORDER.LO_SUPPKEY = SUPPLIER.S_SUPPKEY -LINEORDER LEFT JOIN PART ON LINEORDER.LO_PARTKEY = PART.P_PARTKEY +P_LINEORDER INNER JOIN DATES ON P_LINEORDER.LO_ORDERDATE=DATES.D_DATEKEY +P_LINEORDER INNER JOIN CUSTOMER ON P_LINEORDER.LO_CUSTKEY=CUSTOMER.C_CUSTKEY +P_LINEORDER INNER JOIN PART ON P_LINEORDER.LO_PARTKEY=PART.P_PARTKEY +P_LINEORDER INNER JOIN SUPPLIER ON P_LINEORDER.LO_SUPPKEY=SUPPLIER.S_SUPPKEY ``` ### Import and check sample dataset diff --git a/website/docs/restapi/project_api.md b/website/docs/restapi/project_api.md index 646f140c13..80deaf9293 100644 --- a/website/docs/restapi/project_api.md +++ b/website/docs/restapi/project_api.md @@ -34,7 +34,7 @@ last_update: - HTTP Body: JSON Object - `name` - `required` `string`, project name. - `description` - `optional` `string`, project description. - - `maintain_model_type` - `required` `string`, project type, `MANUAL_MAINTAIN` for AI augmented mode. + - `maintain_model_type` - `required` `string`, project type, `MANUAL_MAINTAIN` for default. - Curl Request Example diff --git a/website/docs/tutorial/create-a-blog-post.md b/website/docs/tutorial/create-a-blog-post.md deleted file mode 100644 index ea472bbaf8..0000000000 --- a/website/docs/tutorial/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/website/docs/tutorial/create-a-document.md b/website/docs/tutorial/create-a-document.md deleted file mode 100644 index 3c92695c51..0000000000 --- a/website/docs/tutorial/create-a-document.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -module.exports = { - tutorialSidebar: [ - { - type: 'category', - label: 'Tutorial', - // highlight-next-line - items: ['hello'], - }, - ], -}; -``` diff --git a/website/docs/tutorial/create-a-page.md b/website/docs/tutorial/create-a-page.md deleted file mode 100644 index 20e2ac3005..0000000000 --- a/website/docs/tutorial/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - <Layout> - <h1>My React page</h1> - <p>This is a React page</p> - </Layout> - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/website/docs/tutorial/deploy-your-site.md b/website/docs/tutorial/deploy-your-site.md deleted file mode 100644 index 1c50ee063e..0000000000 --- a/website/docs/tutorial/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/website/docs/tutorial/markdown-features.mdx b/website/docs/tutorial/markdown-features.mdx deleted file mode 100644 index 62c606c726..0000000000 --- a/website/docs/tutorial/markdown-features.mdx +++ /dev/null @@ -1,145 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md - -``` - - - - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - - ```jsx title="src/components/HelloDocusaurus.js" - function HelloDocusaurus() { - return ( - <h1>Hello, Docusaurus!</h1> - ) - } - ``` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return <h1>Hello, Docusaurus!</h1>; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - - :::tip My tip - - Use this awesome feature option - - ::: - - :::danger Take care - - This action is dangerous - - ::: - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - <span - style={{ - backgroundColor: color, - borderRadius: '20px', - color: '#fff', - padding: '10px', - cursor: 'pointer', - }} - onClick={() => { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - </span> -); - -This is <Highlight color="#25c2a0">Docusaurus green</Highlight> ! - -This is <Highlight color="#1877F2">Facebook blue</Highlight> ! -``` - -export const Highlight = ({children, color}) => ( - <span - style={{ - backgroundColor: color, - borderRadius: '20px', - color: '#fff', - padding: '10px', - cursor: 'pointer', - }} - onClick={() => { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - </span> -); - -This is <Highlight color="#25c2a0">Docusaurus green</Highlight> ! - -This is <Highlight color="#1877F2">Facebook blue</Highlight> ! diff --git a/website/sidebars.js b/website/sidebars.js index 4a341fd9c5..6c699efdbc 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -48,28 +48,6 @@ const sidebars = { }, ], }, - { - type: 'category', - label: 'Tutorial', - items: [ - { - type: 'doc', - id: 'tutorial/create-a-page' - }, - { - type: 'doc', - id: 'tutorial/create-a-document' - }, - { - type: 'doc', - id: 'tutorial/create-a-blog-post' - }, - { - type: 'doc', - id: 'tutorial/deploy-your-site' - }, - ] - }, { type: 'category', label: 'Deployment',