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 #51073

Merged
merged 28 commits into from
Sep 18, 2024
Merged

[Doc] Autogen nav #51073

merged 28 commits into from
Sep 18, 2024

Conversation

DanRoscigno
Copy link
Contributor

@DanRoscigno DanRoscigno commented Sep 17, 2024 •
edited
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

@DanRoscigno
reduce links
b4b492b 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
move to snippet
a75051c 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
3c959ba 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
2fbc770 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
a63d523 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
7df3b66 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
25a888e 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
f410c88 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
49b38b3 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
make tips reusable
d07eab3 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
fix mdx issues
5092869 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
reduce links
7f2dd7f 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
move tip
7e8c7b9 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
remove link
d24683e 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
remove links
02a6a87 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
fix import
2094479 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
remove links
20090d9 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
remove links
1b29881 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
move multi-service to include
bd0e6fc 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
remove links
bc51893 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
remove links
1a2de53 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
fix link
e6632ae 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
fix link
7012af3 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
set sidebar positions
baf61d0 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
fix links
34a923c 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
move quick start overview
74c6b8e 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
autogen nav
3ca883d 
Signed-off-by: DanRoscigno <[email protected]>
@DanRoscigno
autonav tables
f032fc6 
Signed-off-by: DanRoscigno <[email protected]>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 17, 2024
@github-actions GitHub Actions
Copy link

[Java-Extensions Incremental Coverage Report]

coverage check fail. please retry. 😨

Please let me know when error again.

com.naver.nid.cover.parser.coverage.exception.ParseException: java.nio.file.NoSuchFileException: /var/local/env/java_extension_empty_coverage

@github-actions GitHub Actions
Copy link

[FE Incremental Coverage Report]

✅ pass : 0 / 0 (0%)

@github-actions GitHub Actions
Copy link

[BE Incremental Coverage Report]

✅ pass : 0 / 0 (0%)

@alvin-celerdata alvin-celerdata merged commit 0be4658 into main Sep 18, 2024
54 of 58 checks passed
@alvin-celerdata alvin-celerdata deleted the autogen-nav branch September 18, 2024 02:13
@github-actions GitHub Actions
Copy link

@Mergifyio backport branch-3.3

@github-actions github-actions bot removed the 3.3 label Sep 18, 2024
@github-actions GitHub Actions
Copy link

@Mergifyio backport branch-3.2

@github-actions github-actions bot removed the 3.2 label Sep 18, 2024
@github-actions GitHub Actions
Copy link

@Mergifyio backport branch-3.1

@github-actions github-actions bot removed the 3.1 label Sep 18, 2024
@mergify Mergify
Copy link
Contributor

mergify bot commented Sep 18, 2024 •
edited
Loading

backport branch-3.3

✅ Backports have been created

@mergify Mergify
Copy link
Contributor

mergify bot commented Sep 18, 2024 •
edited
Loading

backport branch-3.2

✅ Backports have been created

@mergify Mergify
Copy link
Contributor

mergify bot commented Sep 18, 2024 •
edited
Loading

backport branch-3.1

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Sep 18, 2024
@DanRoscigno @mergify
[Doc] Autogen nav (#51073)
8b0c23e 
Signed-off-by: DanRoscigno <[email protected]>
(cherry picked from commit 0be4658)

# Conflicts:
#	docs/en/introduction/Architecture.md
@mergify mergify bot mentioned this pull request Sep 18, 2024
Merged
42 tasks
mergify bot pushed a commit that referenced this pull request Sep 18, 2024
@DanRoscigno @mergify
[Doc] Autogen nav (#51073)
5999f58 
Signed-off-by: DanRoscigno <[email protected]>
(cherry picked from commit 0be4658)

# Conflicts:
#	docs/docusaurus/sidebars.json
#	docs/en/_assets/commonMarkdown/loadMethodIntro.md
#	docs/en/introduction/Architecture.md
#	docs/en/loading/InsertInto.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/table_design/indexes/Ngram_Bloom_Filter_Index.md
#	docs/en/table_design/indexes/inverted_index.md
#	docs/en/table_design/table_types/duplicate_key_table.md
#	docs/zh/sql-reference/sql-statements/materialized_view/CREATE_MATERIALIZED_VIEW.md
#	docs/zh/sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE.md
#	docs/zh/table_design/indexes/Ngram_Bloom_Filter_Index.md
#	docs/zh/table_design/indexes/inverted_index.md
#	docs/zh/table_design/table_types/duplicate_key_table.md
@mergify mergify bot mentioned this pull request Sep 18, 2024
Merged
42 tasks
mergify bot pushed a commit that referenced this pull request Sep 18, 2024
@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 mentioned this pull request Sep 18, 2024
Merged
42 tasks
wanpengfei-git pushed a commit that referenced this pull request Sep 18, 2024
@mergify @DanRoscigno
[Doc] Autogen nav (backport #51073) (#51078)
c5e3340 
Signed-off-by: DanRoscigno <[email protected]>
Signed-off-by: Dan Roscigno <[email protected]>
Co-authored-by: Dan Roscigno <[email protected]>
wanpengfei-git pushed a commit that referenced this pull request Sep 18, 2024
@mergify @DanRoscigno
[Doc] Autogen nav (backport #51073) (#51079)
8f0a1e3 
Signed-off-by: DanRoscigno <[email protected]>
Co-authored-by: Dan Roscigno <[email protected]>
wanpengfei-git pushed a commit that referenced this pull request Sep 18, 2024
@mergify @DanRoscigno
[Doc] Autogen nav (backport #51073) (#51080)
498e1cd 
Signed-off-by: DanRoscigno <[email protected]>
Co-authored-by: Dan Roscigno <[email protected]>
renzhimin7 pushed a commit to renzhimin7/starrocks that referenced this pull request Nov 7, 2024
@DanRoscigno @renzhimin7
[Doc] Autogen nav (StarRocks#51073)
9cf78f2 
Signed-off-by: DanRoscigno <[email protected]>
Signed-off-by: zhiminr.ren <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@DanRoscigno DanRoscigno

Labels
3.1-merged 3.2-merged 3.3-merged documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@DanRoscigno @alvin-celerdata