feat: overhaul navbar titles & add slack logo and button #11067
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe recent updates to the documentation site focus on enhancing user experience through streamlined navigation and improved organization. Key changes include the removal of the promotional announcement bar, the introduction of a new Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- docs-website/docusaurus.config.js (5 hunks)
- docs-website/src/components/SecondNavbar/SecondNavbar.js (1 hunks)
- docs-website/src/components/SecondNavbar/styles.module.scss (1 hunks)
- docs-website/src/styles/global.scss (1 hunks)
- docs-website/src/theme/Layout/index.js (1 hunks)
- docs-website/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.js (3 hunks)
Files skipped from review due to trivial changes (1)
- docs-website/src/styles/global.scss
Additional comments not posted (19)
docs-website/src/theme/Layout/index.js (2)
1-3: Import statements are appropriate.The import statements correctly bring in the necessary components and modules.
5-13: Component structure is clear and functional.The
LayoutWrappercomponent correctly wraps the originalLayoutcomponent and adds theSecondNavbarcomponent. The use of props and JSX is appropriate.docs-website/src/components/SecondNavbar/styles.module.scss (6)
1-11: Styles for secondary navbar are well-defined.The styles for the secondary navbar, including dark mode variations, are appropriately defined.
13-18: Container styles are appropriate.The container styles ensure proper alignment and spacing for the navbar elements.
20-24: Core cloud switch styles are appropriate.The styles for the core cloud switch section are well-defined.
26-41: Button styles are well-defined.The styles for the buttons, including hover effects and active states, are appropriately defined.
47-53: Dark mode button styles are appropriate.The styles for the buttons in dark mode are well-defined and ensure good contrast.
55-64: Search box and right navbar item styles are appropriate.The styles for the search box and right-aligned navbar items are well-defined.
docs-website/src/components/SecondNavbar/SecondNavbar.js (3)
1-8: Import statements are appropriate.The import statements correctly bring in the necessary components and modules.
11-18: Conditional rendering is appropriate.The conditional rendering based on the pathname ensures that the secondary navbar is only displayed on documentation pages.
20-61: Component structure is clear and functional.The
SecondNavbarcomponent is well-structured, with appropriate use of JSX and class names. The integration of the color mode toggle and search bar enhances the functionality.docs-website/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.js (2)
16-19: Addition of default prop values.The addition of default values for
docsPluginId,dropdownActiveClassDisabled,dropdownItemsBefore, anddropdownItemsAfterimproves the robustness and usability of the component by ensuring it behaves predictably even when these props are not supplied.
36-77: Enhancement: Inclusion of archived versions.The addition of archived versions to the dropdown items enhances the user experience by providing access to older documentation directly within the dropdown. This is a valuable feature for users who may need to refer to previous versions of the documentation.
docs-website/docusaurus.config.js (6)
55-58: Addition of color mode configuration.The addition of the color mode configuration with
disableSwitchset totrueanddefaultModeset tolightensures a consistent appearance by disabling the color mode switch and defaulting to the light mode.
68-80: Restructuring of the navbar: Product dropdown.The addition of the "Product" dropdown consolidates links to "DataHub Core" and "DataHub Cloud," enhancing accessibility to product-related information. This change improves the organization and user experience of the navbar.
89-109: Restructuring of the navbar: Learn dropdown.The transformation of the "Learn" section into a dropdown that encompasses links to "Use Cases," "Adoption Stories," a blog, and a YouTube channel broadens the educational resources available to users. This change improves the organization and user experience of the navbar.
124-136: Update of Community section labels.The updates to the labels in the "Community" section, such as changing "Join Slack" to "DataHub Slack" and "Community Forum" to "DataHub Discourse," align with the DataHub identity and improve clarity.
145-153: Addition of Slack logo link.The addition of a direct link to Slack with custom HTML for a Slack logo provides a more visually engaging representation and quick access to Slack for users.
157-159: Addition of DataHub Cloud button.The addition of a button linking to "Try DataHub Cloud Free" enhances the call to action and provides users with a clear and direct way to try DataHub Cloud.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
docs-website/sidebars.js (2)
861-1523: Action Required: Verify and Correct Documentation PathsThe following files mentioned in the sidebar configuration are missing from the documentation directory. Please verify their paths or ensure these files are created:
docs/businessattributesdocs/glossary/business-glossarydocs/features/feature-guides/documentation-formsdocs/domainsdocs/ui-ingestiondocs/generated/lineage/lineage-feature-guidedocs/act-on-metadata/impact-analysisdocs/features/feature-guides/ui-lineagedocs/features/feature-guides/propertiesdocs/schema-historydocs/how/searchdocs/tagsdocs/features/dataset-usage-and-query-historydocs/managed-datahub/approval-workflowsdocs/managed-datahub/chrome-extensiondocs/managed-datahub/observe/data-contractdocs/ownership/ownership-typesdocs/authorization/access-policies-guidedocs/managed-datahub/observe/assertionsdocs/managed-datahub/observe/column-assertionsdocs/managed-datahub/observe/custom-sql-assertionsdocs/managed-datahub/observe/freshness-assertionsdocs/managed-datahub/observe/schema-assertionsdocs/managed-datahub/observe/volume-assertionsdocs/assertions/open-assertions-specdocs/assertions/snowflake/snowflake_dmfsdocs/dataproductsdocs/incidents/incidentsdocs/tests/metadata-testsdocs/managed-datahub/subscription-and-notificationdocs/sync-statusdocs/managed-datahub/slack/saas-slack-setupdocs/managed-datahub/slack/saas-slack-appdocs/managed-datahub/slack/saas-slack-troubleshootdocs/managed-datahub/integrations/aws-privatelinkdocs/managed-datahub/integrations/oidc-sso-integrationdocs/managed-datahub/operator-guide/setting-up-remote-ingestion-executordocs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridgePlease ensure these files are correctly linked or created to maintain the integrity of the documentation.
Analysis chain
LGTM!
The addition of several new categories and items under the "acrylSidebar" configuration enhances the organization and accessibility of the documentation, providing a comprehensive structure for various topics.
However, ensure that the added items have been correctly updated in their respective documentation files.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correctness of added items in the documentation files. # Test: Search for the added items. Expect: Occurrences in the new locations. rg --type markdown -l 'docs/businessattributes' 'docs/glossary/business-glossary' 'docs/features/feature-guides/documentation-forms' 'docs/domains' 'docs/ui-ingestion' 'docs/generated/lineage/lineage-feature-guide' 'docs/act-on-metadata/impact-analysis' 'docs/features/feature-guides/ui-lineage' 'docs/features/feature-guides/properties' 'docs/schema-history' 'docs/how/search' 'docs/tags' 'docs/features/dataset-usage-and-query-history' 'docs/managed-datahub/approval-workflows' 'docs/managed-datahub/chrome-extension' 'docs/managed-datahub/observe/data-contract' 'docs/ownership/ownership-types' 'docs/authorization/access-policies-guide' 'docs/managed-datahub/observe/assertions' 'docs/managed-datahub/observe/column-assertions' 'docs/managed-datahub/observe/custom-sql-assertions' 'docs/managed-datahub/observe/freshness-assertions' 'docs/managed-datahub/observe/schema-assertions' 'docs/managed-datahub/observe/volume-assertions' 'docs/assertions/open-assertions-spec' 'docs/assertions/snowflake/snowflake_dmfs' 'docs/dataproducts' 'docs/incidents/incidents' 'docs/tests/metadata-tests' 'docs/managed-datahub/subscription-and-notification' 'docs/sync-status' 'docs/managed-datahub/slack/saas-slack-setup' 'docs/managed-datahub/slack/saas-slack-app' 'docs/managed-datahub/slack/saas-slack-troubleshoot' 'docs/managed-datahub/integrations/aws-privatelink' 'docs/managed-datahub/integrations/oidc-sso-integration' 'docs/managed-datahub/operator-guide/setting-up-remote-ingestion-executor' 'docs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridge'Length of output: 4423
Script:
#!/bin/bash # Description: List all files in the documentation directory to verify the existence of the specified files. # List all markdown files in the documentation directory fd --type f --extension md --exec echo {}Length of output: 15508
Missing Documentation File:
The file
docs/generated/lineage/lineage-feature-guidereferenced in thesidebars.jsfile does not exist in the repository. Please verify the path or ensure that the file is added to the repository.
docs/generated/lineage/lineage-feature-guideAnalysis chain
Line range hint
44-107:
LGTM!The renaming of the "Features" category to "Data Discovery" and the restructuring of items under this category align with the shift in emphasis towards data exploration and governance. The added items enhance the clarity and accessibility of relevant documentation.
However, ensure that the moved items have been correctly updated in their respective documentation files.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correctness of moved items in the documentation files. # Test: Search for the moved items. Expect: Only occurrences in the new locations. rg --type markdown -l 'docs/businessattributes' 'docs/glossary/business-glossary' 'docs/features/feature-guides/documentation-forms' 'docs/domains' 'docs/ui-ingestion' 'docs/generated/lineage/lineage-feature-guide' 'docs/act-on-metadata/impact-analysis' 'docs/features/feature-guides/ui-lineage' 'docs/features/feature-guides/properties' 'docs/schema-history' 'docs/how/search' 'docs/tags' 'docs/features/dataset-usage-and-query-history'Length of output: 1259
Script:
#!/bin/bash # Description: Verify the existence of the specified documentation files. # List of documentation files to check docs_files=( "docs/businessattributes" "docs/glossary/business-glossary" "docs/features/feature-guides/documentation-forms" "docs/domains" "docs/ui-ingestion" "docs/generated/lineage/lineage-feature-guide" "docs/act-on-metadata/impact-analysis" "docs/features/feature-guides/ui-lineage" "docs/features/feature-guides/properties" "docs/schema-history" "docs/how/search" "docs/tags" "docs/features/dataset-usage-and-query-history" ) # Check for the existence of each file for file in "${docs_files[@]}"; do fd -t f -e md "$(basename "$file")" doneLength of output: 2510
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- docs-website/docusaurus.config.js (5 hunks)
- docs-website/sidebars.js (9 hunks)
- docs-website/src/components/SecondNavbar/SecondNavbar.js (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- docs-website/docusaurus.config.js
- docs-website/src/components/SecondNavbar/SecondNavbar.js
Additional comments not posted (8)
docs-website/sidebars.js (8)
37-41: LGTM!The addition of the HTML divider for "Features" enhances the visual separation of sections, improving user navigation.
461-471: LGTM!The addition of items related to "AWS PrivateLink Integration" and "OIDC SSO Integration" under the "Advanced Guides" category enhances the documentation by providing guides for advanced integrations.
552-552: LGTM!The addition of the link to "docs/api/datahub-apis" under the "API" category improves the accessibility of API documentation.
751-751: LGTM!The addition of the "Guides" section consolidates tutorial resources, enhancing the clarity and accessibility of relevant documentation.
860-860: LGTM!The addition of the HTML divider for "Overview" under the "acrylSidebar" configuration enhances the visual separation of sections, improving user navigation.
112-131: LGTM!The addition of the "Data Governance" category and the restructuring of items under this category prioritize governance-related content, enhancing the organization of the documentation.
However, ensure that the moved items have been correctly updated in their respective documentation files.
Verification successful
The moved items have been correctly updated in their respective documentation files.
The following files were found in the expected locations:
docs/managed-datahub/approval-workflows.mddocs/managed-datahub/chrome-extension.mddocs/managed-datahub/observe/data-contract.mddocs/ownership/ownership-types.mddocs/authorization/access-policies-guide.mdScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correctness of moved items in the documentation files. # Test: Search for the moved items. Expect: Only occurrences in the new locations. rg --type markdown -l 'docs/managed-datahub/approval-workflows' 'docs/managed-datahub/chrome-extension' 'docs/managed-datahub/observe/data-contract' 'docs/ownership/ownership-types' 'docs/authorization/access-policies-guide'Length of output: 529
Script:
#!/bin/bash # Description: Verify the existence of the moved items in the documentation files. # Search for the files in the repository to confirm their presence and correct paths. fd 'approval-workflows.md' 'chrome-extension.md' 'data-contract.md' 'ownership-types.md' 'access-policies-guide.md'Length of output: 413
Script:
#!/bin/bash # Description: Verify the existence of the moved items in the documentation files. # Search for the filenames within the repository to confirm their presence and correct paths. fd 'approval-workflows.md' fd 'chrome-extension.md' fd 'data-contract.md' fd 'ownership-types.md' fd 'access-policies-guide.md'Length of output: 335
216-239: LGTM!The addition of the "Notifications" section and the restructuring of items under this section improve the organization of notification-related documentation.
However, ensure that the moved items have been correctly updated in their respective documentation files.
Verification successful
LGTM!
The addition of the "Notifications" section and the restructuring of items under this section improve the organization of notification-related documentation. The paths specified in the
sidebars.jsfile are correct, and the documentation files exist at the expected locations.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correctness of moved items in the documentation files. # Test: Search for the moved items. Expect: Only occurrences in the new locations. rg --type markdown -l 'docs/managed-datahub/subscription-and-notification' 'docs/managed-datahub/slack/saas-slack-setup' 'docs/managed-datahub/slack/saas-slack-app' 'docs/managed-datahub/slack/saas-slack-troubleshoot'Length of output: 468
Script:
#!/bin/bash # Description: Verify the existence and correct paths of the moved items in the documentation files. # Search for the 'subscription-and-notification' file in the entire repository fd 'subscription-and-notification.md' # Search for the 'saas-slack-setup' file in the entire repository fd 'saas-slack-setup.md' # Search for the 'saas-slack-app' file in the entire repository fd 'saas-slack-app.md' # Search for the 'saas-slack-troubleshoot' file in the entire repository fd 'saas-slack-troubleshoot.md'Length of output: 317
135-213: LGTM!The addition of the "Data Quality" category and the restructuring of items under this category consolidate quality-related resources, enhancing the clarity and accessibility of relevant documentation.
However, ensure that the moved items have been correctly updated in their respective documentation files.
Verification successful
Ensure the documentation files exist and are correctly referenced.
The previous verification script encountered errors because the specified files or directories do not exist. Let's search for the correct locations of the documentation files within the repository.
Verify the correctness of paths in
sidebars.js.The documentation files have been located. Let's ensure that the paths in the
sidebars.jsfile match these actual locations.
The paths in the
sidebars.jsfile are correctly referenced.The paths in the
sidebars.jsfile match the actual locations of the documentation files found in the repository, confirming that the changes are correctly implemented.
docs/managed-datahub/observe/assertionsdocs/managed-datahub/observe/column-assertionsdocs/managed-datahub/observe/custom-sql-assertionsdocs/managed-datahub/observe/freshness-assertionsdocs/managed-datahub/observe/schema-assertionsdocs/managed-datahub/observe/volume-assertionsdocs/assertions/open-assertions-specdocs/assertions/snowflake/snowflake_dmfsdocs/dataproductsdocs/incidents/incidentsdocs/tests/metadata-testsdocs/managed-datahub/subscription-and-notificationdocs/sync-statusScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correctness of moved items in the documentation files. # Test: Search for the moved items. Expect: Only occurrences in the new locations. rg --type markdown -l 'docs/managed-datahub/observe/assertions' 'docs/managed-datahub/observe/column-assertions' 'docs/managed-datahub/observe/custom-sql-assertions' 'docs/managed-datahub/observe/freshness-assertions' 'docs/managed-datahub/observe/schema-assertions' 'docs/managed-datahub/observe/volume-assertions' 'docs/assertions/open-assertions-spec' 'docs/assertions/snowflake/snowflake_dmfs' 'docs/dataproducts' 'docs/incidents/incidents' 'docs/tests/metadata-tests' 'docs/managed-datahub/subscription-and-notification' 'docs/sync-status'Length of output: 1457
Script:
#!/bin/bash # Description: Find the correct locations of the documentation files. # Search for the filenames without the full paths to locate their actual positions. rg --files | grep -E 'assertions|column-assertions|custom-sql-assertions|freshness-assertions|schema-assertions|volume-assertions|open-assertions-spec|snowflake_dmfs|dataproducts|incidents|metadata-tests|subscription-and-notification|sync-status'Length of output: 2526
Script:
#!/bin/bash # Description: Verify that the paths in the sidebars.js file match the actual locations of the documentation files. # Check if the paths in sidebars.js match the actual locations of the documentation files. grep -E 'docs/managed-datahub/observe/assertions|docs/managed-datahub/observe/column-assertions|docs/managed-datahub/observe/custom-sql-assertions|docs/managed-datahub/observe/freshness-assertions|docs/managed-datahub/observe/schema-assertions|docs/managed-datahub/observe/volume-assertions|docs/assertions/open-assertions-spec|docs/assertions/snowflake/snowflake_dmfs|docs/dataproducts|docs/incidents/incidents|docs/tests/metadata-tests|docs/managed-datahub/subscription-and-notification|docs/sync-status' docs-website/sidebars.jsLength of output: 2150
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs-website/docusaurus.config.js (5 hunks)
- docs-website/sidebars.js (9 hunks)
- docs-website/src/components/SecondNavbar/SecondNavbar.js (1 hunks)
- docs-website/src/components/SecondNavbar/styles.module.scss (1 hunks)
Files skipped from review due to trivial changes (1)
- docs-website/src/components/SecondNavbar/styles.module.scss
Files skipped from review as they are similar to previous changes (3)
- docs-website/docusaurus.config.js
- docs-website/sidebars.js
- docs-website/src/components/SecondNavbar/SecondNavbar.js
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs-website/src/components/SecondNavbar/SecondNavbar.js (1 hunks)
Files skipped from review due to trivial changes (1)
- docs-website/src/components/SecondNavbar/SecondNavbar.js
Checklist
Summary by CodeRabbit
New Features
User Interface Enhancements
Bug Fixes
Style Changes