From 9363f0b48190e84d87b264f83cd2517355e4363c Mon Sep 17 00:00:00 2001 From: Sami Ahmed Siddiqui Date: Tue, 9 Jul 2024 19:06:18 +0500 Subject: [PATCH] [Docs] Upgrade Go, Hugo, Docsy and Node dependencies (#22646) * Upgrade Go, Hugo, and Docsy * Fixing issues with Bootstrap 5 * Hugo render hook for headings and change tab param in shortcodes * Upgrade Node packages * Renamed config.toml to hugo.toml * Replace params.algolia_docsearch deprecated config * Fix similar release version number issue * Hide header image if not exist * Replace data-toggle with data-bs-toggle for Bootstrap 5 in shortcodes * Replace data-toggle with data-bs-toggle for Bootstrap 5 in content * Add lead SCSS back * Add style removed mistakenly * Fix tab active on product-tabs shortcode * Replace data-toggle with data-bs-toggle in stable and v2.20 versions --- docs/assets/scss/_code_block.scss | 20 +- docs/assets/scss/_nav.scss | 32 +- docs/assets/scss/_search.scss | 8 +- docs/assets/scss/_styles_project.scss | 47 +- docs/assets/scss/_tables.scss | 23 +- docs/assets/scss/_yb_buttons.scss | 4 + docs/assets/scss/_yb_container.scss | 5 + docs/assets/scss/_yb_headings.scss | 14 + .../_default/{config.toml => hugo.toml} | 0 docs/config/_default/params.toml | 6 +- docs/config/fast/{config.toml => hugo.toml} | 0 .../production/{config.toml => hugo.toml} | 0 .../contribute/docs/widgets-and-shortcodes.md | 8 +- .../async-transactional-failover.md | 10 +- .../async-transactional-setup.md | 12 +- docs/content/preview/explore/_index.md | 12 +- .../explore/going-beyond-sql/tablespaces.md | 4 +- .../preview/quick-start/explore/ycql.md | 8 +- .../preview/quick-start/explore/ysql.md | 8 +- .../chapter1-debuting-with-postgres.md | 4 +- .../chapter2-scaling-with-yugabytedb.md | 4 +- .../chapter3-tolerating-outages.md | 8 +- .../build-and-learn/chapter4-going-global.md | 8 +- .../chapter5-going-cloud-native.md | 4 +- .../preview/yedis/quick-start/_index.md | 8 +- .../cloud-connect/connect-client-shell.md | 4 +- .../anywhere-rbac.md | 4 +- .../on-premises-nodes.md | 4 +- .../create-deployments/connect-to-universe.md | 6 +- .../cloud-permissions-ear.md | 6 +- .../cloud-permissions-storage.md | 8 +- .../cloud-permissions-yba.md | 10 +- .../yugabyte-platform/prepare/networking.md | 8 +- .../prepare/server-nodes-hardware.md | 10 +- .../yugabyte-voyager/install-yb-voyager.md | 12 +- .../migrate/live-fall-back.md | 4 +- .../migrate/live-fall-forward.md | 8 +- .../yugabyte-voyager/migrate/live-migrate.md | 4 +- .../yugabyte-voyager/migrate/migrate-steps.md | 6 +- .../async-transactional-failover.md | 10 +- .../async-transactional-setup.md | 12 +- docs/content/stable/explore/_index.md | 12 +- .../explore/going-beyond-sql/tablespaces.md | 4 +- .../anywhere-rbac.md | 4 +- .../on-premises-nodes.md | 4 +- .../create-deployments/connect-to-universe.md | 6 +- .../cloud-permissions-ear.md | 6 +- .../cloud-permissions-storage.md | 8 +- .../cloud-permissions-yba.md | 10 +- .../yugabyte-platform/prepare/networking.md | 8 +- .../prepare/server-nodes-hardware.md | 10 +- .../invocation-syntax-semantics.md | 12 +- .../invocation-syntax-semantics.md | 12 +- .../statements/cmd_analyze.md | 4 +- .../the-sql-language/statements/cmd_call.md | 4 +- .../the-sql-language/statements/cmd_copy.md | 4 +- .../the-sql-language/statements/cmd_do.md | 4 +- .../the-sql-language/statements/cmd_reset.md | 4 +- .../the-sql-language/statements/cmd_set.md | 4 +- .../the-sql-language/statements/cmd_show.md | 4 +- .../dcl_alter_default_privileges.md | 4 +- .../statements/dcl_alter_group.md | 4 +- .../statements/dcl_alter_policy.md | 4 +- .../statements/dcl_alter_role.md | 4 +- .../statements/dcl_alter_user.md | 4 +- .../statements/dcl_create_group.md | 4 +- .../statements/dcl_create_policy.md | 4 +- .../statements/dcl_create_role.md | 4 +- .../statements/dcl_create_user.md | 4 +- .../statements/dcl_drop_group.md | 4 +- .../statements/dcl_drop_owned.md | 4 +- .../statements/dcl_drop_policy.md | 4 +- .../statements/dcl_drop_role.md | 4 +- .../statements/dcl_drop_user.md | 4 +- .../the-sql-language/statements/dcl_grant.md | 4 +- .../statements/dcl_reassign_owned.md | 4 +- .../the-sql-language/statements/dcl_revoke.md | 4 +- .../statements/dcl_set_role.md | 4 +- .../dcl_set_session_authorization.md | 4 +- .../statements/ddl_alter_db.md | 4 +- .../statements/ddl_alter_domain.md | 4 +- .../ddl_alter_foreign_data_wrapper.md | 4 +- .../statements/ddl_alter_foreign_table.md | 4 +- .../statements/ddl_alter_function.md | 4 +- .../statements/ddl_alter_procedure.md | 4 +- .../statements/ddl_alter_sequence.md | 4 +- .../statements/ddl_alter_server.md | 4 +- .../statements/ddl_alter_table.md | 4 +- .../statements/ddl_comment.md | 4 +- .../statements/ddl_create_aggregate.md | 4 +- .../statements/ddl_create_cast.md | 4 +- .../statements/ddl_create_database.md | 4 +- .../statements/ddl_create_domain.md | 4 +- .../statements/ddl_create_extension.md | 4 +- .../ddl_create_foreign_data_wrapper.md | 4 +- .../statements/ddl_create_foreign_table.md | 4 +- .../statements/ddl_create_function.md | 4 +- .../statements/ddl_create_index.md | 4 +- .../statements/ddl_create_matview.md | 4 +- .../statements/ddl_create_operator.md | 4 +- .../statements/ddl_create_operator_class.md | 4 +- .../statements/ddl_create_procedure.md | 4 +- .../statements/ddl_create_rule.md | 4 +- .../statements/ddl_create_schema.md | 4 +- .../statements/ddl_create_sequence.md | 4 +- .../statements/ddl_create_server.md | 4 +- .../statements/ddl_create_table.md | 4 +- .../statements/ddl_create_table_as.md | 4 +- .../statements/ddl_create_trigger.md | 4 +- .../statements/ddl_create_type.md | 4 +- .../statements/ddl_create_user_mapping.md | 4 +- .../statements/ddl_create_view.md | 4 +- .../statements/ddl_drop_aggregate.md | 4 +- .../statements/ddl_drop_cast.md | 4 +- .../statements/ddl_drop_database.md | 4 +- .../statements/ddl_drop_domain.md | 4 +- .../statements/ddl_drop_extension.md | 4 +- .../ddl_drop_foreign_data_wrapper.md | 4 +- .../statements/ddl_drop_foreign_table.md | 4 +- .../statements/ddl_drop_function.md | 4 +- .../statements/ddl_drop_matview.md | 4 +- .../statements/ddl_drop_operator.md | 4 +- .../statements/ddl_drop_operator_class.md | 4 +- .../statements/ddl_drop_procedure.md | 4 +- .../statements/ddl_drop_rule.md | 4 +- .../statements/ddl_drop_sequence.md | 4 +- .../statements/ddl_drop_server.md | 4 +- .../statements/ddl_drop_table.md | 4 +- .../statements/ddl_drop_trigger.md | 4 +- .../statements/ddl_drop_type.md | 4 +- .../statements/ddl_import_foreign_schema.md | 4 +- .../statements/ddl_refresh_matview.md | 4 +- .../statements/ddl_truncate.md | 4 +- .../the-sql-language/statements/dml_delete.md | 4 +- .../the-sql-language/statements/dml_insert.md | 4 +- .../the-sql-language/statements/dml_select.md | 4 +- .../the-sql-language/statements/dml_update.md | 4 +- .../the-sql-language/statements/dml_values.md | 4 +- .../statements/perf_deallocate.md | 4 +- .../statements/perf_execute.md | 4 +- .../statements/perf_explain.md | 4 +- .../statements/perf_prepare.md | 4 +- .../statements/savepoint_create.md | 4 +- .../statements/savepoint_release.md | 4 +- .../statements/savepoint_rollback.md | 4 +- .../the-sql-language/statements/txn_abort.md | 4 +- .../the-sql-language/statements/txn_begin.md | 4 +- .../the-sql-language/statements/txn_commit.md | 4 +- .../the-sql-language/statements/txn_end.md | 4 +- .../the-sql-language/statements/txn_lock.md | 4 +- .../statements/txn_rollback.md | 4 +- .../the-sql-language/statements/txn_set.md | 4 +- .../statements/txn_set_constraints.md | 4 +- .../the-sql-language/statements/txn_show.md | 4 +- .../with-clause/recursive-cte.md | 4 +- .../with-clause-syntax-semantics.md | 4 +- .../_index.md | 4 +- .../subprogram-attributes/_index.md | 20 +- .../subprogram-overloading.md | 8 +- .../going-beyond-sql/tablespaces.md | 4 +- .../content/v2.14/quick-start/explore/ycql.md | 8 +- .../content/v2.14/quick-start/explore/ysql.md | 8 +- docs/content/v2.18/explore/_index.md | 12 +- .../going-beyond-sql/tablespaces.md | 4 +- .../async-transactional-failover.md | 10 +- .../async-transactional-setup.md | 12 +- docs/content/v2.20/explore/_index.md | 12 +- .../going-beyond-sql/tablespaces.md | 4 +- .../anywhere-rbac.md | 4 +- .../on-premises-nodes.md | 4 +- .../create-deployments/connect-to-universe.md | 6 +- docs/go.mod | 6 +- docs/go.sum | 14 +- .../_default/_markup/render-heading.html | 4 + docs/layouts/_default/content.html | 5 +- docs/layouts/indexpage/list.html | 5 +- docs/layouts/partials/contribute_list.html | 2 +- docs/layouts/partials/hooks/body-end.html | 4 +- docs/layouts/partials/hooks/head-end.html | 4 - .../partials/navbar-version-selector.html | 5 +- docs/layouts/partials/navbar.html | 2 +- docs/layouts/partials/search-input.html | 2 +- docs/layouts/shortcodes/api-tabs.html | 4 + .../shortcodes/cluster-setup-tabs.html | 6 +- docs/layouts/shortcodes/ebnf.html | 6 +- docs/layouts/shortcodes/nav/tab.html | 2 +- docs/layouts/shortcodes/nav/tabs.html | 6 +- docs/layouts/shortcodes/product-tabs.html | 6 +- docs/netlify.toml | 11 +- docs/package-lock.json | 12275 +++------------- docs/package.json | 32 +- 191 files changed, 3077 insertions(+), 10325 deletions(-) rename docs/config/_default/{config.toml => hugo.toml} (100%) rename docs/config/fast/{config.toml => hugo.toml} (100%) rename docs/config/production/{config.toml => hugo.toml} (100%) create mode 100644 docs/layouts/_default/_markup/render-heading.html diff --git a/docs/assets/scss/_code_block.scss b/docs/assets/scss/_code_block.scss index 44404f836f6f..8546a5136394 100644 --- a/docs/assets/scss/_code_block.scss +++ b/docs/assets/scss/_code_block.scss @@ -65,6 +65,15 @@ main { > pre, .highlight { margin: 20px 0; + position: relative; + display: flex; + flex-direction: column; + min-width: 0; + word-wrap: break-word; + background-color: #fff; + background-clip: border-box; + border: 1px solid rgba(0, 0, 0, .125); + border-radius: .25rem; } li > p + pre, @@ -90,6 +99,7 @@ main { background: transparent !important; padding: 0 !important; margin: 0; + border: 0; position: relative !important; overflow-y: auto; overflow-x: visible; @@ -117,11 +127,11 @@ main { overflow: auto; scrollbar-width: thin; - &:only-child { + &:nth-child(2):last-child { padding: 11px 15px; } - &:not(:only-child) { + &:not(:last-child) { > span > span { padding-right: 40px; } @@ -140,7 +150,6 @@ main { .highlight { margin-bottom: 20px !important; - > pre { margin-top: 1rem; margin-bottom: 1rem; @@ -232,6 +241,7 @@ main { pre.can-be-copied { width: calc(100% + 20px); padding-right: 20px !important; + border: 0; max-width: none; min-height: 85px; @@ -252,6 +262,10 @@ main { border-radius: 5px; } + .click-to-copy { + display: none; + } + button.copy { right: 27px; diff --git a/docs/assets/scss/_nav.scss b/docs/assets/scss/_nav.scss index 65eef929b012..e669f7568d13 100644 --- a/docs/assets/scss/_nav.scss +++ b/docs/assets/scss/_nav.scss @@ -1125,22 +1125,26 @@ body { } } -body>header .td-navbar.navbar-expand .page-header .navbar-nav form .td-search-input::-webkit-input-placeholder, -body>header .td-navbar.navbar-expand .top-nav .navbar-nav form .td-search-input::-webkit-input-placeholder{ - width:98% +body > header .td-navbar.navbar-expand .page-header .navbar-nav form .td-search-input::-webkit-input-placeholder, +body > header .td-navbar.navbar-expand .top-nav .navbar-nav form .td-search-input::-webkit-input-placeholder { + width: 98%; } + @media (max-width: 1129px) { - body>header .td-navbar.navbar-expand .page-header .navbar-nav form .td-search-input, - body>header .td-navbar.navbar-expand .top-nav .navbar-nav form .td-search-input { - width: 185px !important; - text-indent: 33px; - } + body > header .td-navbar.navbar-expand .page-header .navbar-nav form .td-search-input, + body > header .td-navbar.navbar-expand .top-nav .navbar-nav form .td-search-input { + width: 185px !important; + text-indent: 33px; + } } -@media(max-width:1042px) AND (min-width:992px){ - body>header .td-navbar.navbar-expand .page-header .navbar-nav.right-nav li, - body>header .td-navbar.navbar-expand .top-nav .navbar-nav.right-nav li { - margin-right: 0px; - } - body .tritiery-btn:not(.btn-priority) { padding: 0 8px 0 5px;} +@media(max-width:1042px) AND (min-width:992px) { + body > header .td-navbar.navbar-expand .page-header .navbar-nav.right-nav li, + body > header .td-navbar.navbar-expand .top-nav .navbar-nav.right-nav li { + margin-right: 0px; + } + + body .tritiery-btn:not(.btn-priority) { + padding: 0 8px 0 5px; + } } diff --git a/docs/assets/scss/_search.scss b/docs/assets/scss/_search.scss index d114b41b7ac4..8efcbabf11bc 100644 --- a/docs/assets/scss/_search.scss +++ b/docs/assets/scss/_search.scss @@ -508,8 +508,10 @@ body.td-searchpage .td-content { width: 280px !important; } } + @media (max-width: 767px) { - body>header .td-navbar.navbar-expand .page-header .navbar-nav form .td-search-input, body>header .td-navbar.navbar-expand .top-nav .navbar-nav form .td-search-input { - width: 100% !important; - } + body > header .td-navbar.navbar-expand .page-header .navbar-nav form .td-search-input, + body > header .td-navbar.navbar-expand .top-nav .navbar-nav form .td-search-input { + width: 100% !important; + } } diff --git a/docs/assets/scss/_styles_project.scss b/docs/assets/scss/_styles_project.scss index 930917ffe6cc..5823659c15c6 100644 --- a/docs/assets/scss/_styles_project.scss +++ b/docs/assets/scss/_styles_project.scss @@ -1,4 +1,4 @@ -// Font Awesome Pro +// Font Awesome Pro 6 @import "../vendor/Font-Awesome-Pro/scss/fontawesome.scss"; @import "../vendor/Font-Awesome-Pro/scss/brands.scss"; @import "../vendor/Font-Awesome-Pro/scss/duotone.scss"; @@ -46,6 +46,45 @@ html { -moz-osx-font-smoothing: grayscale; } +a { + color: #3176d9; + text-decoration: none; + background-color: transparent; +} + +.tab-body { + color: inherit; +} + +.tab-body > :last-child { + margin-bottom: inherit; +} +.td-content { + .highlight { + .click-to-copy { + display: none; + } + } +} + +.dropdown-list .dropdown-menu[data-popper-placement="top-start"] { + margin-bottom: -2px !important; +} + +.dropdown-list .dropdown-menu[data-popper-placement="bottom-start"] { + margin-top: -1px !important; +} + +.navbar-expand > .container, +.navbar-expand > .container-fluid, +.navbar-expand > .container-sm, +.navbar-expand > .container-md, +.navbar-expand > .container-lg, +.navbar-expand > .container-xl { + padding-right: 0; + padding-left: 0; +} + /******* Variables for Color Theme Switcher **********/ :root { --theme-color: #312965; @@ -75,10 +114,14 @@ html { .breadcrumb-item { font-size: 12px; - line-height: 28px; + line-height: 22px; display: flex; align-items: center; + &.active { + color: #4e5f6d; + } + &:only-child { visibility: hidden; } diff --git a/docs/assets/scss/_tables.scss b/docs/assets/scss/_tables.scss index 4273bf36ca5a..ce2e233534f5 100644 --- a/docs/assets/scss/_tables.scss +++ b/docs/assets/scss/_tables.scss @@ -13,6 +13,7 @@ main { margin: 0 !important; border: none; box-shadow: none; + display: table; @media (max-width:900px) { min-width:650px; @@ -40,6 +41,24 @@ main { } } + .table > :not(caption) > * > *, + .td-table:not(.td-initial) > :not(caption) > * > *, + .td-content table:not(.td-initial) > :not(caption) > * > *, + .td-box table:not(.td-initial) > :not(caption) > * > *{ + padding: 12.75px 15px; + } + + .table-striped > tbody > tr:nth-of-type(odd) > *, + .td-table:not(.td-initial) > tbody > tr:nth-of-type(odd) > *, + .td-content table:not(.td-initial) > tbody > tr:nth-of-type(odd) > *, + .td-box table:not(.td-initial) > tbody > tr:nth-of-type(odd) > * { + --bs-table-bg-type: #fbfcfd; + color: #25323d; + background-color: transparent; + border-width: 0; + } + + table { box-shadow: 0 0 0 1px #e9eef2; border-radius: 6px; @@ -150,7 +169,7 @@ main { border-width: 0; font-family: 'Inter'; font-style: normal; - color: #4e5f6d; + color: #4e5f6d!important; text-transform: uppercase; font-weight: 600; font-size: 12px; @@ -166,7 +185,7 @@ main { font-size: 14px; line-height: 26px; color: #4e5f6d; - padding: 11.5px 16px; + padding: 11.5px 16px!important; } } } diff --git a/docs/assets/scss/_yb_buttons.scss b/docs/assets/scss/_yb_buttons.scss index cde13db7514b..85f216f1a57a 100644 --- a/docs/assets/scss/_yb_buttons.scss +++ b/docs/assets/scss/_yb_buttons.scss @@ -44,6 +44,10 @@ body { background: #5d5fef; color: #fff; } + + &[data-bs-toggle="tab"]:hover { + background: inherit; + } } .secondary-btn:not(.btn-priority) { diff --git a/docs/assets/scss/_yb_container.scss b/docs/assets/scss/_yb_container.scss index 6b67bb2e00a9..99b75ee0562a 100644 --- a/docs/assets/scss/_yb_container.scss +++ b/docs/assets/scss/_yb_container.scss @@ -3,6 +3,11 @@ html { } /******* Container Styling **********/ +.row { + margin-left: -15px; + margin-right: -15px; +} + .left-menu-scrolling .td-main { aside.td-sidebar .left-sidebar-wrap { transition: none !important; diff --git a/docs/assets/scss/_yb_headings.scss b/docs/assets/scss/_yb_headings.scss index 227d80e8bd5e..585e12c0a630 100644 --- a/docs/assets/scss/_yb_headings.scss +++ b/docs/assets/scss/_yb_headings.scss @@ -156,3 +156,17 @@ } } } + +.td-heading-self-link:before { + content: ""; + background: url(/icons/heading-link.svg) 50% no-repeat; + height: 15px; + width: 15px; + display: inline-block; +} + +@media (hover: none) and (pointer: coarse), (max-width: 576px) { + .td-heading-self-link { + visibility: hidden; + } +} diff --git a/docs/config/_default/config.toml b/docs/config/_default/hugo.toml similarity index 100% rename from docs/config/_default/config.toml rename to docs/config/_default/hugo.toml diff --git a/docs/config/_default/params.toml b/docs/config/_default/params.toml index 77ac627b51c2..cfa573e41716 100644 --- a/docs/config/_default/params.toml +++ b/docs/config/_default/params.toml @@ -2,8 +2,6 @@ author = "Team Yugabyte" description = "YugabyteDB, the transactional, high-performance database for building internet-scale, globally-distributed apps." copyright = "Yugabyte, Inc." privacy_policy = "https://www.yugabyte.com/privacy-policy/" -algolia_docsearch = true -algolia_sequence_expressions = true kapa_ai = true drift_snippet = true search_banner = true @@ -13,6 +11,10 @@ version_menu = "Releases" # versions from the dropdown menu. version_menu_pagelinks = true +[search] + algolia_docsearch = true + algolia_sequence_expressions = true + [path_base_for_github_subdir] from = "content/en/(.*?)/" to = "content/$1/" diff --git a/docs/config/fast/config.toml b/docs/config/fast/hugo.toml similarity index 100% rename from docs/config/fast/config.toml rename to docs/config/fast/hugo.toml diff --git a/docs/config/production/config.toml b/docs/config/production/hugo.toml similarity index 100% rename from docs/config/production/config.toml rename to docs/config/production/hugo.toml diff --git a/docs/content/preview/contribute/docs/widgets-and-shortcodes.md b/docs/content/preview/contribute/docs/widgets-and-shortcodes.md index e9474a5e32d5..2399da8d9e28 100644 --- a/docs/content/preview/contribute/docs/widgets-and-shortcodes.md +++ b/docs/content/preview/contribute/docs/widgets-and-shortcodes.md @@ -146,28 +146,28 @@ The corresponding code for this widget is as follows. Note that the actual conte ```html