Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] Autogen nav (backport #51073) #51080

Merged
merged 6 commits into from
Sep 18, 2024
Merged

[Doc] Autogen nav (backport #51073) #51080

merged 6 commits into from
Sep 18, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Sep 18, 2024 •
edited by github-actions bot
Loading

  • Move table design docs into folders that match the nav so that we can auto-generate the nav.
  • Downgrades Docusaurus in the dev Docker image to match production version

This PR depends on #51066

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function
  • This is a backport pr

Bugfix cherry-pick branch check:

  • I have checked the version labels which the pr will be auto-backported to the target branch
    • 3.3
    • 3.2
    • 3.1
    • 3.0
    • 2.5
This is an automatic backport of pull request #51073 done by [Mergify](https://mergify.com). - Move table design docs into folders that match the nav so that we can auto-generate the nav. - Downgrades Docusaurus in the dev Docker image to match production version

This PR depends on #51066

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function
  • This is a backport pr

@DanRoscigno @mergify
[Doc] Autogen nav (#51073)
610aff6 
Signed-off-by: DanRoscigno <[email protected]>
(cherry picked from commit 0be4658)

# Conflicts:
#	docs/docusaurus/sidebars.json
#	docs/en/_assets/commonMarkdown/loadMethodIntro.md
#	docs/en/administration/management/resource_management/be_label.md
#	docs/en/data_source/catalog/iceberg_catalog.md
#	docs/en/introduction/Architecture.md
#	docs/en/loading/BrokerLoad.md
#	docs/en/loading/Etl_in_loading.md
#	docs/en/loading/Flink_cdc_load.md
#	docs/en/loading/InsertInto.md
#	docs/en/loading/Load_to_Primary_Key_tables.md
#	docs/en/loading/RoutineLoad.md
#	docs/en/loading/StreamLoad.md
#	docs/en/sql-reference/information_schema/loads.md
#	docs/en/sql-reference/sql-functions/table-functions/files.md
#	docs/en/sql-reference/sql-statements/Resource/CREATE_RESOURCE.md
#	docs/en/sql-reference/sql-statements/loading_unloading/INSERT.md
#	docs/en/sql-reference/sql-statements/loading_unloading/SHOW_LOAD.md
#	docs/en/sql-reference/sql-statements/loading_unloading/STREAM_LOAD.md
#	docs/en/sql-reference/sql-statements/loading_unloading/routine_load/CREATE_ROUTINE_LOAD.md
#	docs/en/sql-reference/sql-statements/materialized_view/CREATE_MATERIALIZED_VIEW.md
#	docs/en/sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md
#	docs/en/sql-reference/sql-statements/table_bucket_part_index/SHOW_CREATE_TABLE.md
#	docs/en/table_design/StarRocks_table_design.md
#	docs/en/table_design/data_distribution/Data_distribution.md
#	docs/en/table_design/hybrid_table.md
#	docs/en/table_design/indexes/Ngram_Bloom_Filter_Index.md
#	docs/en/table_design/indexes/Prefix_index_sort_key.md
#	docs/en/table_design/indexes/inverted_index.md
#	docs/en/table_design/table_design.md
#	docs/en/table_design/table_types/aggregate_table.md
#	docs/en/table_design/table_types/duplicate_key_table.md
#	docs/en/table_design/table_types/primary_key_table.md
#	docs/en/table_design/table_types/unique_key_table.md
#	docs/en/using_starrocks/_category_.yml
#	docs/en/using_starrocks/indexes.md
#	docs/zh/loading/BrokerLoad.md
#	docs/zh/loading/Etl_in_loading.md
#	docs/zh/loading/Flink_cdc_load.md
#	docs/zh/loading/InsertInto.md
#	docs/zh/loading/Load_to_Primary_Key_tables.md
#	docs/zh/loading/RoutineLoad.md
#	docs/zh/loading/StreamLoad.md
#	docs/zh/sql-reference/sql-statements/loading_unloading/INSERT.md
#	docs/zh/sql-reference/sql-statements/materialized_view/CREATE_MATERIALIZED_VIEW.md
#	docs/zh/sql-reference/sql-statements/table_bucket_part_index/ALTER_TABLE.md
#	docs/zh/sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md
#	docs/zh/sql-reference/sql-statements/table_bucket_part_index/SHOW_CREATE_TABLE.md
#	docs/zh/table_design/StarRocks_table_design.md
#	docs/zh/table_design/Table_design.md
#	docs/zh/table_design/data_distribution/Data_distribution.md
#	docs/zh/table_design/data_distribution/Temporary_partition.md
#	docs/zh/table_design/data_distribution/expression_partitioning.md
#	docs/zh/table_design/data_distribution/list_partitioning.md
#	docs/zh/table_design/hybrid_table.md
#	docs/zh/table_design/indexes/Ngram_Bloom_Filter_Index.md
#	docs/zh/table_design/indexes/Prefix_index_sort_key.md
#	docs/zh/table_design/indexes/inverted_index.md
#	docs/zh/table_design/table_design.md
#	docs/zh/table_design/table_types/aggregate_table.md
#	docs/zh/table_design/table_types/duplicate_key_table.md
#	docs/zh/table_design/table_types/primary_key_table.md
#	docs/zh/table_design/table_types/unique_key_table.md
#	docs/zh/using_starrocks/_category_.yml
#	docs/zh/using_starrocks/indexes.md
@mergify mergify bot added the conflicts label Sep 18, 2024
@mergify Mergify
Copy link
Contributor Author

mergify bot commented Sep 18, 2024

Cherry-pick of 0be4658 has failed:

On branch mergify/bp/branch-3.1/pr-51073
Your branch is up to date with 'origin/branch-3.1'.

You are currently cherry-picking commit 0be46582cf.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/docusaurus/package.json
	modified:   docs/docusaurus/yarn.lock
	new file:   docs/en/_assets/commonMarkdown/multi-service-access.mdx
	new file:   docs/en/_assets/commonMarkdown/quickstart-iceberg-tip.mdx
	new file:   docs/en/_assets/commonMarkdown/quickstart-overview-tip.mdx
	new file:   docs/en/_assets/commonMarkdown/quickstart-routine-load-tip.mdx
	new file:   docs/en/_assets/commonMarkdown/quickstart-shared-data.mdx
	new file:   docs/en/_assets/commonMarkdown/quickstart-shared-nothing-tip.mdx
	modified:   docs/en/administration/management/Backup_and_restore.md
	modified:   docs/en/administration/management/resource_management/Blacklist.md
	modified:   docs/en/administration/management/resource_management/Load_balance.md
	modified:   docs/en/administration/management/resource_management/Memory_management.md
	modified:   docs/en/administration/management/resource_management/Query_management.md
	modified:   docs/en/administration/management/resource_management/Replica.md
	modified:   docs/en/administration/management/resource_management/filemanager.md
	modified:   docs/en/administration/management/resource_management/query_queues.md
	modified:   docs/en/administration/management/resource_management/resource_group.md
	deleted:    docs/en/administration/management/resource_management/resource_management.mdx
	modified:   docs/en/administration/management/resource_management/spill_to_disk.md
	modified:   docs/en/deployment/post_deployment_setup.md
	modified:   docs/en/sql-reference/data-types/semi_structured/Array.md
	modified:   docs/en/sql-reference/data-types/semi_structured/JSON.md
	modified:   docs/en/sql-reference/sql-functions/like-predicate-functions/regexp_extract.md
	modified:   docs/en/sql-reference/sql-statements/account-management/GRANT.md
	modified:   docs/en/sql-reference/sql-statements/account-management/REVOKE.md
	modified:   docs/en/sql-reference/sql-statements/account-management/SET_PASSWORD.md
	modified:   docs/en/sql-reference/sql-statements/cluster-management/nodes_processes/ALTER_SYSTEM.md
	modified:   docs/en/sql-reference/sql-statements/loading_unloading/BROKER_LOAD.md
	modified:   docs/en/sql-reference/sql-statements/loading_unloading/routine_load/ALTER_ROUTINE_LOAD.md
	modified:   docs/en/sql-reference/sql-statements/loading_unloading/routine_load/SHOW_ROUTINE_LOAD_TASK.md
	modified:   docs/en/sql-reference/sql-statements/loading_unloading/unloading/EXPORT.md
	modified:   docs/en/sql-reference/sql-statements/loading_unloading/unloading/SHOW_EXPORT.md
	modified:   docs/en/sql-reference/sql-statements/table_bucket_part_index/SHOW_PARTITIONS.md
	deleted:    docs/en/table_design/Data_distribution.md
	deleted:    docs/en/table_design/Table_design.md
	modified:   docs/en/table_design/data_compression.md
	renamed:    docs/en/table_design/Temporary_partition.md -> docs/en/table_design/data_distribution/Temporary_partition.md
	renamed:    docs/en/table_design/dynamic_partitioning.md -> docs/en/table_design/data_distribution/dynamic_partitioning.md
	renamed:    docs/en/table_design/expression_partitioning.md -> docs/en/table_design/data_distribution/expression_partitioning.md
	renamed:    docs/en/table_design/feature-support-data-distribution.md -> docs/en/table_design/data_distribution/feature-support-data-distribution.md
	renamed:    docs/en/table_design/list_partitioning.md -> docs/en/table_design/data_distribution/list_partitioning.md
	new file:   docs/en/table_design/table_types/_category_.yml
	modified:   docs/en/table_design/table_types/table_capabilities.md
	modified:   docs/en/using_starrocks/Bitmap_index.md
	modified:   docs/en/using_starrocks/Bloomfilter_index.md
	modified:   docs/en/using_starrocks/block_cache.md
	modified:   docs/en/using_starrocks/data_lake_query_acceleration_with_materialized_views.md
	modified:   docs/zh/administration/management/Backup_and_restore.md
	modified:   docs/zh/administration/management/FE_configuration.md
	modified:   docs/zh/sql-reference/sql-statements/loading_unloading/BROKER_LOAD.md
	modified:   docs/zh/sql-reference/sql-statements/loading_unloading/STREAM_LOAD.md
	deleted:    docs/zh/table_design/Data_distribution.md
	deleted:    docs/zh/table_design/Temporary_partition.md
	modified:   docs/zh/table_design/data_compression.md
	renamed:    docs/zh/table_design/dynamic_partitioning.md -> docs/zh/table_design/data_distribution/dynamic_partitioning.md
	renamed:    docs/zh/table_design/feature-support-data-distribution.md -> docs/zh/table_design/data_distribution/feature-support-data-distribution.md
	deleted:    docs/zh/table_design/expression_partitioning.md
	deleted:    docs/zh/table_design/list_partitioning.md
	new file:   docs/zh/table_design/table_types/_category_.yml
	modified:   docs/zh/table_design/table_types/table_capabilities.md
	modified:   docs/zh/using_starrocks/Bitmap_index.md
	modified:   docs/zh/using_starrocks/Bloomfilter_index.md

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   docs/docusaurus/sidebars.json
	both modified:   docs/en/_assets/commonMarkdown/loadMethodIntro.md
	deleted by us:   docs/en/administration/management/resource_management/be_label.md
	both modified:   docs/en/data_source/catalog/iceberg_catalog.md
	both modified:   docs/en/introduction/Architecture.md
	both modified:   docs/en/loading/BrokerLoad.md
	both modified:   docs/en/loading/Etl_in_loading.md
	both modified:   docs/en/loading/Flink_cdc_load.md
	both modified:   docs/en/loading/InsertInto.md
	both modified:   docs/en/loading/Load_to_Primary_Key_tables.md
	both modified:   docs/en/loading/RoutineLoad.md
	both modified:   docs/en/loading/StreamLoad.md
	deleted by us:   docs/en/sql-reference/information_schema/loads.md
	both modified:   docs/en/sql-reference/sql-functions/table-functions/files.md
	both modified:   docs/en/sql-reference/sql-statements/Resource/CREATE_RESOURCE.md
	both modified:   docs/en/sql-reference/sql-statements/loading_unloading/INSERT.md
	both modified:   docs/en/sql-reference/sql-statements/loading_unloading/SHOW_LOAD.md
	both modified:   docs/en/sql-reference/sql-statements/loading_unloading/STREAM_LOAD.md
	both modified:   docs/en/sql-reference/sql-statements/loading_unloading/routine_load/CREATE_ROUTINE_LOAD.md
	both modified:   docs/en/sql-reference/sql-statements/materialized_view/CREATE_MATERIALIZED_VIEW.md
	both modified:   docs/en/sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md
	both modified:   docs/en/sql-reference/sql-statements/table_bucket_part_index/SHOW_CREATE_TABLE.md
	both modified:   docs/en/table_design/StarRocks_table_design.md
	both modified:   docs/en/table_design/data_distribution/Data_distribution.md
	deleted by us:   docs/en/table_design/hybrid_table.md
	deleted by us:   docs/en/table_design/indexes/Ngram_Bloom_Filter_Index.md
	deleted by us:   docs/en/table_design/indexes/Prefix_index_sort_key.md
	deleted by us:   docs/en/table_design/indexes/inverted_index.md
	deleted by us:   docs/en/table_design/table_design.md
	both modified:   docs/en/table_design/table_types/aggregate_table.md
	both modified:   docs/en/table_design/table_types/duplicate_key_table.md
	both modified:   docs/en/table_design/table_types/primary_key_table.md
	both modified:   docs/en/table_design/table_types/unique_key_table.md
	added by them:   docs/en/using_starrocks/_category_.yml
	deleted by us:   docs/en/using_starrocks/indexes.md
	both modified:   docs/zh/loading/BrokerLoad.md
	both modified:   docs/zh/loading/Etl_in_loading.md
	both modified:   docs/zh/loading/Flink_cdc_load.md
	both modified:   docs/zh/loading/InsertInto.md
	both modified:   docs/zh/loading/Load_to_Primary_Key_tables.md
	both modified:   docs/zh/loading/RoutineLoad.md
	both modified:   docs/zh/loading/StreamLoad.md
	both modified:   docs/zh/sql-reference/sql-statements/loading_unloading/INSERT.md
	both modified:   docs/zh/sql-reference/sql-statements/materialized_view/CREATE_MATERIALIZED_VIEW.md
	both modified:   docs/zh/sql-reference/sql-statements/table_bucket_part_index/ALTER_TABLE.md
	both modified:   docs/zh/sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md
	both modified:   docs/zh/sql-reference/sql-statements/table_bucket_part_index/SHOW_CREATE_TABLE.md
	both modified:   docs/zh/table_design/StarRocks_table_design.md
	deleted by them: docs/zh/table_design/Table_design.md
	both modified:   docs/zh/table_design/data_distribution/Data_distribution.md
	both modified:   docs/zh/table_design/data_distribution/Temporary_partition.md
	both modified:   docs/zh/table_design/data_distribution/expression_partitioning.md
	both modified:   docs/zh/table_design/data_distribution/list_partitioning.md
	deleted by us:   docs/zh/table_design/hybrid_table.md
	deleted by us:   docs/zh/table_design/indexes/Ngram_Bloom_Filter_Index.md
	deleted by us:   docs/zh/table_design/indexes/Prefix_index_sort_key.md
	deleted by us:   docs/zh/table_design/indexes/inverted_index.md
	deleted by us:   docs/zh/table_design/table_design.md
	both modified:   docs/zh/table_design/table_types/aggregate_table.md
	both modified:   docs/zh/table_design/table_types/duplicate_key_table.md
	both modified:   docs/zh/table_design/table_types/primary_key_table.md
	both modified:   docs/zh/table_design/table_types/unique_key_table.md
	added by them:   docs/zh/using_starrocks/_category_.yml
	deleted by us:   docs/zh/using_starrocks/indexes.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot mentioned this pull request Sep 18, 2024
Merged
24 tasks
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 18, 2024
@mergify Mergify
Copy link
Contributor Author

mergify bot commented Sep 18, 2024

@mergify[bot]: Backport conflict, please reslove the conflict and resubmit the pr

@mergify mergify bot closed this Sep 18, 2024
@mergify mergify bot deleted the mergify/bp/branch-3.1/pr-51073 branch September 18, 2024 02:17
@DanRoscigno DanRoscigno restored the mergify/bp/branch-3.1/pr-51073 branch September 18, 2024 15:59
@DanRoscigno DanRoscigno reopened this Sep 18, 2024
@wanpengfei-git wanpengfei-git enabled auto-merge (squash) September 18, 2024 16:00
@DanRoscigno
resolve conflict
0fb8513 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
resolve conflict
ae97cae 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
resolve conflict
fdae301 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
broken link
2151475 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
broken link
af2d3a2 
Signed-off-by: DanRoscigno <[email protected]>
@wanpengfei-git wanpengfei-git merged commit 498e1cd into branch-3.1 Sep 18, 2024
30 checks passed
@wanpengfei-git wanpengfei-git deleted the mergify/bp/branch-3.1/pr-51073 branch September 18, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DanRoscigno DanRoscigno DanRoscigno approved these changes

Assignees

@DanRoscigno DanRoscigno

Labels
automerge conflicts documentation Improvements or additions to documentation version:3.1.16
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@DanRoscigno @wanpengfei-git