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.

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

docs(slack) overhauled setup instructions and screenshots #10922

Merged
merged 23 commits into from
Jul 17, 2024

Conversation

jayacryl
Copy link
Collaborator

@jayacryl jayacryl commented Jul 16, 2024

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

  • Documentation
    • Introduced the DataHub Slack App, enabling data discovery, asset previews, and incident management directly within Slack.
    • Added a detailed guide on configuring Slack for notifications in DataHub, including installation, token generation, and integration steps.

Copy link
Contributor

coderabbitai bot commented Jul 16, 2024

Walkthrough

The changes introduce the DataHub Slack App and provide a comprehensive guide to its configuration. The app enhances data discovery and management by allowing users to search for data assets, subscribe to notifications, and handle data incidents all within Slack. The setup guide details steps for integrating Slack with DataHub, generating necessary tokens, and sending notifications.

Changes

File Path Change Summary
docs/managed-datahub/slack/... Introduces the DataHub Slack App, detailing its features such as data asset search, notifications, and incident management within Slack. Provides a setup guide for installing the app, generating tokens, and integrating with Slack.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Slack
    participant DataHub

    User->>Slack: Search for data assets
    Slack->>DataHub: Query data assets
    DataHub-->>Slack: Return search results
    Slack-->>User: Display search results

    User->>Slack: Subscribe to notifications
    Slack->>DataHub: Register subscription
    DataHub-->>Slack: Confirm subscription
    Slack-->>User: Subscription confirmed

    User->>Slack: Report a data incident
    Slack->>DataHub: Log incident details
    DataHub-->>Slack: Incident logged
    Slack-->>User: Incident management options
Loading

Poem

In Slack's embrace, data flows free,
Search and find with a command from thee.
Notifications ring with timely grace,
Incidents handled, all in one place.
DataHub and Slack, a perfect blend,
Enhancing discovery, beginning to end.
🎉📊🚀


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added docs Issues and Improvements to docs community-contribution PR or Issue raised by member(s) of DataHub Community labels Jul 16, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (3)
docs/managed-datahub/slack/saas-slack-app.md (1)

1-1: Consider adding explanatory comments for imports.

It's a good practice to comment on the purpose of imports, especially for custom components like FeatureAvailability, which might not be immediately clear to new contributors.

docs/managed-datahub/managed-datahub-overview.md (1)

59-60: Ensure detailed documentation for new monitoring tasks.

The new monitoring tasks "Monitor Table Column Integrity" and "Monitor Table with Custom SQL" are only mentioned in the overview. To help users understand and utilize these features effectively, please add detailed documentation for these tasks.

  • Add detailed documentation for "Monitor Table Column Integrity".
  • Add detailed documentation for "Monitor Table with Custom SQL".
Analysis chain

Confirm the addition of new monitoring tasks.

The addition of "Monitor Table Column Integrity" and "Monitor Table with Custom SQL" enhances the monitoring capabilities. Ensure these features are well-documented elsewhere in the DataHub documentation to assist users in understanding and utilizing these new tasks.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for documentation on the new monitoring tasks.

rg --type markdown "Monitor Table Column Integrity|Monitor Table with Custom SQL" docs/

Length of output: 272

docs/managed-datahub/subscription-and-notification.md (1)

8-11: Clarify the scope of notifications and provide detailed setup instructions.

The addition of email notifications expands the notification options. Ensure the setup instructions for both Slack and email notifications are clear and easily accessible. Currently, the setup instructions for Slack notifications are available in docs/managed-datahub/slack/saas-slack-setup.md, but there are no detailed setup instructions for email notifications.

  • Add detailed setup instructions for email notifications in the documentation.
Analysis chain

Clarify the scope of notifications and provide detailed setup instructions.

The addition of email notifications expands the notification options. Ensure the setup instructions for both Slack and email notifications are clear and easily accessible.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the clarity and accessibility of setup instructions for notifications.

rg --type markdown "configure notifications" docs/

Length of output: 52


Script:

#!/bin/bash
# Description: Verify the clarity and accessibility of setup instructions for Slack and email notifications.

# Search for Slack setup instructions
rg --type markdown "slack" docs/

# Search for email setup instructions
rg --type markdown "email" docs/

Length of output: 24642

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 642fb40 and c83f5a4.

Files selected for processing (4)
  • docs/managed-datahub/managed-datahub-overview.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-setup.md (2 hunks)
  • docs/managed-datahub/subscription-and-notification.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/slack/saas-slack-app.md

[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ing soon.* This document will cover the full range capabilities available within the Slack...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

docs/managed-datahub/slack/saas-slack-setup.md

[grammar] ~21-~21: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...creenshot here] 7. Congrats 🎉 Slack is setup! Now try it out by going to the **Platf...

(BE_VB_OR_NN)


[typographical] ~103-~103: Consider adding a comma here.
Context: ...saving. --> ## Sending Notifications For now we support sending notifications to - S...

(FOR_NOW_COMMA)


[grammar] ~112-~112: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...k *Note we recommend just using the slack channel name for simplicity (eg. `#trou...

(ON_SKYPE)


[uncategorized] ~112-~112: The abbreviation “e.g.” (= for example) requires two periods.
Context: ... the slack channel name for simplicity (eg. #troubleshoot)* Via Slack App: 1...

(E_G)


[style] ~122-~122: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .... Go to the Slack channel for which you want to get channel ID 2. Check the URL e.g. fo...

(REP_WANT_TO_VB)


[uncategorized] ~123-~123: A comma might be missing here.
Context: ...you want to get channel ID 2. Check the URL e.g. for the troubleshoot channel in OS...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[grammar] ~123-~123: The word ‘troubleshoot’ is a verb. Did you mean the noun “troubleshooting” or “troubleshooting guide”?
Context: ...hannel ID 2. Check the URL e.g. for the troubleshoot channel in OSS DataHub slack ![](https:...

(PREPOSITION_VERB)


[grammar] ~139-~139: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...* 1. Click their profile picture in the slack message [screenshot here] 2. Now hit th...

(ON_SKYPE)

Markdownlint
docs/managed-datahub/slack/saas-slack-app.md

9-9: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/managed-datahub/slack/saas-slack-setup.md

10-10: null
Bare URL used

(MD034, no-bare-urls)


127-127: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


128-128: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


132-132: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


138-138: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


124-124: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (1)
docs/managed-datahub/slack/saas-slack-app.md (1)

5-5: Confirm the use of the FeatureAvailability component.

Ensure that the FeatureAvailability component's saasOnly prop is correctly implemented to restrict this feature to SaaS users only, as intended.

docs/managed-datahub/slack/saas-slack-app.md Outdated Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-setup.md Outdated Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-setup.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c83f5a4 and bf440fc.

Files selected for processing (2)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-setup.md (1 hunks)
Additional context used
Markdownlint
docs/managed-datahub/slack/saas-slack-app.md

9-9: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/managed-datahub/slack/saas-slack-setup.md

151-151: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


152-152: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


15-15: null
Bare URL used

(MD034, no-bare-urls)


156-156: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


166-166: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


30-30: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


34-34: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


38-38: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


42-42: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


138-138: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


142-142: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


148-148: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


159-159: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


163-163: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


169-169: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


173-173: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

LanguageTool
docs/managed-datahub/slack/saas-slack-setup.md

[typographical] ~123-~123: Consider adding a comma here.
Context: ...saving. --> ## Sending Notifications For now we support sending notifications to - S...

(FOR_NOW_COMMA)


[uncategorized] ~132-~132: The abbreviation “e.g.” (= for example) requires two periods.
Context: ... the Slack channel name for simplicity (eg. #troubleshoot)* Via Slack App: 1...

(E_G)


[uncategorized] ~135-~135: You might be missing the article “a” here.
Context: ...Slack channel for which you want to get channel ID 2. Click the channel name at the top...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[style] ~146-~146: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .... Go to the Slack channel for which you want to get channel ID 2. Check the URL e.g. fo...

(REP_WANT_TO_VB)


[uncategorized] ~147-~147: A comma might be missing here.
Context: ...you want to get channel ID 2. Check the URL e.g. for the troubleshoot channel in OS...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[grammar] ~147-~147: The word ‘troubleshoot’ is a verb. Did you mean the noun “troubleshooting” or “troubleshooting guide”?
Context: ...hannel ID 2. Check the URL e.g. for the troubleshoot channel in OSS DataHub Slack ![](https:...

(PREPOSITION_VERB)

Additional comments not posted (1)
docs/managed-datahub/slack/saas-slack-app.md (1)

13-13: Hyphenation correction is correctly applied.

The phrase "full-range capabilities" is now correctly hyphenated, improving readability.

docs/managed-datahub/slack/saas-slack-app.md Outdated Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-setup.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
docs-website/sidebars.js (1)

214-214: Update references to the new document path.

The document path has been updated to docs/managed-datahub/slack/saas-slack-setup. However, there are still references to the old path in the following files, which will result in broken links:

  • docs/managed-datahub/subscription-and-notification.md
  • docs/managed-datahub/managed-datahub-overview.md
  • docs/managed-datahub/observe/assertions.md
  • docs/incidents/incidents.md

Please update these references to the new path to ensure there are no broken links.

Analysis chain

Verify the updated document path.

The path for the Slack setup documentation has been updated. Please verify that the new path docs/managed-datahub/slack/saas-slack-setup exists and that there are no broken links as a result of this change.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of the new document path and check for broken links.

# Test: Search for the document. Expect: The document should exist.
fd 'saas-slack-setup.md' 'docs/managed-datahub/slack'

# Test: Check for broken links in the documentation.
# Note: This is a placeholder as actual link checking would require a tool not available in this environment.
echo "Please use a link checker to verify no broken links."

Length of output: 213


Script:

#!/bin/bash
# Description: Check for references to the old document path and verify if they have been updated to the new path.

# Test: Search for references to the old path in the documentation.
rg 'docs/managed-datahub/saas-slack-setup'

# Test: Search for references to the new path in the documentation.
rg 'docs/managed-datahub/slack/saas-slack-setup'

Length of output: 1250

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bf440fc and 5e4c885.

Files selected for processing (1)
  • docs-website/sidebars.js (2 hunks)
Additional comments not posted (1)
docs-website/sidebars.js (1)

250-263: New Slack documentation entries added.

The new entries for Slack setup and Slack app documentation have been added to the sidebar. This should improve the discoverability of these features.

Please ensure that these new entries are functional and correctly link to their respective documentation pages.

@jayacryl jayacryl changed the title docs(slack) Slack docs overhauled docs(slack) overhauled setup instructions and screenshots Jul 16, 2024
docs-website/sidebars.js Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5e4c885 and ebe0bd8.

Files selected for processing (7)
  • docs/actions/actions/slack.md (1 hunks)
  • docs/incidents/incidents.md (1 hunks)
  • docs/managed-datahub/managed-datahub-overview.md (2 hunks)
  • docs/managed-datahub/observe/assertions.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-setup.md (1 hunks)
  • docs/managed-datahub/subscription-and-notification.md (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • docs/managed-datahub/managed-datahub-overview.md
Additional context used
LanguageTool
docs/managed-datahub/slack/saas-slack-app.md

[uncategorized] ~13-~13: A comma might be missing here.
Context: ...a1df" /> ## Coming soon In the coming weeks this document will cover the full-range...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

docs/managed-datahub/observe/assertions.md

[grammar] ~41-~41: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...I calls, you can also get notified via [slack messages](/docs/managed-datahub/slack/s...

(ON_SKYPE)

docs/managed-datahub/slack/saas-slack-setup.md

[typographical] ~123-~123: Consider adding a comma here.
Context: ...saving. --> ## Sending Notifications For now we support sending notifications to - S...

(FOR_NOW_COMMA)


[uncategorized] ~132-~132: The abbreviation “e.g.” (= for example) requires two periods.
Context: ... the Slack channel name for simplicity (eg. #troubleshoot)* Via Slack App: 1...

(E_G)


[uncategorized] ~135-~135: You might be missing the article “a” here.
Context: ...Slack channel for which you want to get channel ID 2. Click the channel name at the top...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[style] ~146-~146: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .... Go to the Slack channel for which you want to get channel ID 2. Check the URL e.g. fo...

(REP_WANT_TO_VB)


[uncategorized] ~147-~147: A comma might be missing here.
Context: ...you want to get channel ID 2. Check the URL e.g. for the troubleshoot channel in OS...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[grammar] ~147-~147: The word ‘troubleshoot’ is a verb. Did you mean the noun “troubleshooting” or “troubleshooting guide”?
Context: ...hannel ID 2. Check the URL e.g. for the troubleshoot channel in OSS DataHub Slack ![](https:...

(PREPOSITION_VERB)

docs/managed-datahub/subscription-and-notification.md

[uncategorized] ~10-~10: Possible missing comma found.
Context: ...f box. For installing the DataHub Slack App see: 👉 [Configure Slack for Notificati...

(AI_HYDRA_LEO_MISSING_COMMA)

Markdownlint
docs/managed-datahub/slack/saas-slack-app.md

9-9: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/managed-datahub/slack/saas-slack-setup.md

151-151: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


152-152: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


15-15: null
Bare URL used

(MD034, no-bare-urls)


156-156: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


166-166: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


30-30: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


34-34: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


38-38: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


42-42: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


138-138: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


142-142: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


148-148: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


159-159: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


163-163: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


169-169: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


173-173: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (3)
docs/managed-datahub/subscription-and-notification.md (1)

8-8: Expand notification options.

The update enhances notification options by adding support for email notifications, which is a significant improvement for user flexibility.

docs/incidents/incidents.md (1)

430-430: Updated hyperlink to Slack Integration Guide

The hyperlink has been updated to point to the correct location. This change is crucial for ensuring that users are directed to the appropriate documentation.

docs/actions/actions/slack.md (1)

141-141: Updated hyperlink to Configuring Notifications

The hyperlink in the Managed DataHub guide has been updated to point to the correct location for configuring Slack notifications. This change enhances user navigation and ensures that users have access to the correct setup instructions.

docs/managed-datahub/slack/saas-slack-app.md Outdated Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-app.md Outdated Show resolved Hide resolved
docs/managed-datahub/observe/assertions.md Outdated Show resolved Hide resolved
docs/managed-datahub/subscription-and-notification.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ebe0bd8 and 49f0a96.

Files selected for processing (4)
  • docs/managed-datahub/observe/assertions.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-setup.md (1 hunks)
  • docs/managed-datahub/subscription-and-notification.md (2 hunks)
Files skipped from review as they are similar to previous changes (3)
  • docs/managed-datahub/observe/assertions.md
  • docs/managed-datahub/slack/saas-slack-app.md
  • docs/managed-datahub/subscription-and-notification.md
Additional context used
LanguageTool
docs/managed-datahub/slack/saas-slack-setup.md

[typographical] ~123-~123: Consider adding a comma here.
Context: ...saving. --> ## Sending Notifications For now we support sending notifications to - S...

(FOR_NOW_COMMA)


[uncategorized] ~135-~135: You might be missing the article “a” here.
Context: ...Slack channel for which you want to get channel ID 2. Click the channel name at the top...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[style] ~146-~146: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .... Go to the Slack channel for which you want to get channel ID 2. Check the URL e.g. fo...

(REP_WANT_TO_VB)


[uncategorized] ~147-~147: Possible missing comma found.
Context: ...you want to get channel ID 2. Check the URL e.g. for the troubleshoot channel in OS...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~147-~147: The word ‘troubleshoot’ is a verb. Did you mean the noun “troubleshooting” or “troubleshooting guide”?
Context: ...hannel ID 2. Check the URL e.g. for the troubleshoot channel in OSS DataHub Slack ![](https:...

(PREPOSITION_VERB)

Markdownlint
docs/managed-datahub/slack/saas-slack-setup.md

151-151: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


152-152: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


15-15: null
Bare URL used

(MD034, no-bare-urls)


156-156: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


166-166: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


30-30: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


34-34: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


38-38: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


42-42: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


138-138: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


142-142: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


148-148: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


159-159: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


163-163: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


169-169: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


173-173: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/managed-datahub/slack/saas-slack-setup.md Outdated Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-setup.md Outdated Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-setup.md Outdated Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-setup.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 49f0a96 and 02fb533.

Files selected for processing (1)
  • docs-website/sidebars.js (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • docs-website/sidebars.js

Copy link
Collaborator

@yoonhyejin yoonhyejin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM, left a nitpick comment

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 02fb533 and fe67467.

Files selected for processing (2)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-setup.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/slack/saas-slack-app.md

[uncategorized] ~16-~16: This expression is usually spelled with a hyphen.
Context: ...ou.* ## Slack Command Capabilities The command based capabilities on the Slack App revolve a...

(BASED_HYPHEN)


[typographical] ~24-~24: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ...app_search_1.png" />

Right within Slack you'll be presented with results matchi...

(IN_NNP_COMMA)

docs/managed-datahub/slack/saas-slack-setup.md

[style] ~148-~148: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .... Go to the Slack channel for which you want to get a channel ID 2. Check the URL e.g. ...

(REP_WANT_TO_VB)


[uncategorized] ~149-~149: Possible missing comma found.
Context: ...u want to get a channel ID 2. Check the URL e.g. for the troubleshoot channel in OS...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~149-~149: The word ‘troubleshoot’ is a verb. Did you mean the noun “troubleshooting” or “troubleshooting guide”?
Context: ...hannel ID 2. Check the URL e.g. for the troubleshoot channel in OSS DataHub Slack ![](https:...

(PREPOSITION_VERB)

Markdownlint
docs/managed-datahub/slack/saas-slack-setup.md

153-153: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


154-154: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


158-158: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


168-168: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


30-30: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


34-34: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


38-38: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


42-42: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


140-140: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


144-144: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


150-150: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


161-161: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


165-165: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


171-171: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


175-175: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (12)
docs/managed-datahub/slack/saas-slack-app.md (5)

7-11: Review of the Overview Section

The content is clear and introduces the capabilities well. Ensure that the previous comments about hyphenation and comma usage are addressed in this section.
The previous comments are still valid and do not need to be repeated.


18-24: Querying for Assets Section Review

The section is well-detailed and provides a clear example of how to use the search command. The images include alt text, which is great for accessibility.

Tools
LanguageTool

[typographical] ~24-~24: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ...app_search_1.png" />

Right within Slack you'll be presented with results matchi...

(IN_NNP_COMMA)


34-39: Review of the Subscription Feature Section

The explanation is clear, and the use of images with alt text enhances the understanding and accessibility.


41-55: Incident Management Features Review

The section clearly explains the incident management features within the Slack App. The images are well-integrated and include alt text.


57-59: Review of the Coming Soon Section

This section effectively teases future features, maintaining interest in upcoming updates.

docs/managed-datahub/slack/saas-slack-setup.md (7)

7-10: Review of Installation Overview

The section provides a clear high-level overview of the installation process. Ensure that all images include alt text for accessibility.
The previous comments about adding alt text are still valid and do not need to be repeated.


10-12: Video Walkthrough Section Review

The inclusion of a video walkthrough is a helpful visual aid for users. The iframe is properly formatted and accessible.


13-44: Step-by-Step Guide Review

The detailed steps are clearly outlined, enhancing the user's understanding of the installation process. Ensure that all images include alt text as previously noted.
The previous comments about adding alt text are still valid and do not need to be repeated.

Tools
Markdownlint

18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


30-30: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


34-34: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


38-38: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


42-42: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


45-46: Subscriptions and Notifications Section Review

This section effectively directs users to further documentation on subscriptions and notifications, enhancing the user journey.


47-98: Review of the Bot Token Method Section

This section is correctly commented out and marked as not recommended, which is appropriate given the context. It's good to have this documentation available for potential future use.


99-120: Review of the Configuring Notifications Section

This section is detailed and provides valuable information on configuring notifications. It is correctly commented out, which is appropriate given the current context.


122-130: Review of the Sending Notifications Section

This section clearly outlines how notifications can be sent through the Slack App. Ensure that the previous comments about adding a comma for clarity are addressed.
The previous comments are still valid and do not need to be repeated.

docs/managed-datahub/slack/saas-slack-app.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
docs/managed-datahub/slack/saas-slack-app.md (1)

18-32: Good use of alternative text for images.

The inclusion of alternative text for images as suggested in past comments has been properly implemented.

Consider adding a comma for clarity.

According to static analysis, a comma might improve readability.

- Right within Slack you'll be presented with results matching your query, and a handful of quick-actions for your convenience.
+ Right within Slack, you'll be presented with results matching your query, and a handful of quick-actions for your convenience.
Tools
LanguageTool

[typographical] ~24-~24: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ...app_search_1.png" />

Right within Slack you'll be presented with results matchi...

(IN_NNP_COMMA)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fe67467 and 7702acf.

Files selected for processing (1)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/slack/saas-slack-app.md

[typographical] ~24-~24: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ...app_search_1.png" />

Right within Slack you'll be presented with results matchi...

(IN_NNP_COMMA)


[uncategorized] ~51-~51: Possible missing article found.
Context: ...u will be presented with the ability to Reopen Incident should you choose.

...

(AI_HYDRA_LEO_MISSING_THE)

Additional comments not posted (5)
docs/managed-datahub/slack/saas-slack-app.md (5)

7-11: Reiterate past comments on hyphenation and comma usage.

The past comments about hyphenation and comma usage are still relevant and have not been addressed in this section.


15-16: Reiterate past comment on hyphenation in "command-based".

The past comment about needing a hyphen in "command-based" has been addressed.


34-38: LGTM! Clear explanation of the subscription feature.

The section clearly explains how to subscribe to notifications for data assets within Slack.


41-54: Well-documented incident management features.

This section effectively describes the incident management capabilities within the Slack App, and the images include alternative text, enhancing accessibility.

Tools
LanguageTool

[uncategorized] ~51-~51: Possible missing article found.
Context: ...u will be presented with the ability to Reopen Incident should you choose.

...

(AI_HYDRA_LEO_MISSING_THE)


57-59: Appropriate preview of upcoming features.

The "Coming Soon" section appropriately sets expectations for future updates without going into unnecessary detail.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7702acf and fe867d3.

Files selected for processing (2)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
  • docs/managed-datahub/slack/saas-slack-setup.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/slack/saas-slack-app.md

[typographical] ~24-~24: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ...app_search_1.png" />

Right within Slack you'll be presented with results matchi...

(IN_NNP_COMMA)


[uncategorized] ~51-~51: Possible missing article found.
Context: ...u will be presented with the ability to Reopen Incident should you choose.

...

(AI_HYDRA_LEO_MISSING_THE)

docs/managed-datahub/slack/saas-slack-setup.md

[style] ~148-~148: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .... Go to the Slack channel for which you want to get a channel ID 2. Check the URL e.g. ...

(REP_WANT_TO_VB)


[uncategorized] ~149-~149: Possible missing comma found.
Context: ...u want to get a channel ID 2. Check the URL e.g. for the troubleshoot channel in OS...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~149-~149: The word ‘troubleshoot’ is a verb. Did you mean the noun “troubleshooting” or “troubleshooting guide”?
Context: ...hannel ID 2. Check the URL e.g. for the troubleshoot channel in OSS DataHub Slack ![](https:...

(PREPOSITION_VERB)

Markdownlint
docs/managed-datahub/slack/saas-slack-setup.md

153-153: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


154-154: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)


158-158: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


168-168: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


30-30: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


34-34: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


38-38: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


42-42: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


140-140: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


144-144: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


150-150: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


161-161: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


165-165: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


171-171: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


175-175: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (5)
docs/managed-datahub/slack/saas-slack-app.md (3)

46-46: Ensure links are correct and functional.

Verify that the links to other documentation pages are correctly formatted and lead to the intended pages.


21-21: Add alternative text to images for accessibility.

Images should include alternative text to improve accessibility and SEO. This was previously noted but still needs to be addressed.

- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/slack_app_search_1.png" />
+ <img width="70%" alt="Example of an in-Slack Acryl search command being performed." src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/slack_app_search_1.png" />

Likely invalid or redundant comment.


5-5: Ensure feature availability component is correctly used.

The <FeatureAvailability saasOnly /> tag is used to conditionally display content based on the deployment type. Ensure this tag is appropriately used throughout the documentation to maintain consistency and correct information display.

Verification successful

Verified: Correct usage of the FeatureAvailability component.

The <FeatureAvailability saasOnly /> tag is used correctly in the docs/managed-datahub/slack/saas-slack-app.md file. The usage is consistent with other documentation files, ensuring accurate information display based on deployment type.

  • docs/managed-datahub/slack/saas-slack-app.md (line 5)
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistent use of the FeatureAvailability component across the documentation.

# Test: Search for the FeatureAvailability usage. Expect: Consistent usage with correct attributes.
rg --type md -A 5 '<FeatureAvailability'

Length of output: 22672

docs/managed-datahub/slack/saas-slack-setup.md (2)

36-36: Grammar check: Use of 'set up'

The phrase 'Slack is set up' is correctly used here as 'set up' is the correct form when used as a verb.


45-45: Link verification needed.

Ensure that the links provided lead to the correct pages and that they are accessible.

docs/managed-datahub/slack/saas-slack-app.md Show resolved Hide resolved
docs/managed-datahub/slack/saas-slack-app.md Outdated Show resolved Hide resolved
@jayacryl jayacryl enabled auto-merge (squash) July 17, 2024 19:06
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fe867d3 and 378d9f4.

Files selected for processing (1)
  • docs/managed-datahub/slack/saas-slack-app.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • docs/managed-datahub/slack/saas-slack-app.md

@jayacryl jayacryl dismissed yoonhyejin’s stale review July 17, 2024 20:52

already said lgtm

@jayacryl jayacryl merged commit 998d7d1 into master Jul 17, 2024
33 checks passed
@jayacryl jayacryl deleted the jp--datahub-slack-docs branch July 17, 2024 20:52
aviv-julienjehannet pushed a commit to aviv-julienjehannet/datahub that referenced this pull request Jul 25, 2024
arosanda added a commit to infobip/datahub that referenced this pull request Sep 23, 2024
* feat(forms) Handle deleting forms references when hard deleting forms (datahub-project#10820)

* refactor(ui): Misc improvements to the setup ingestion flow (ingest uplift 1/2)  (datahub-project#10764)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* fix(ingestion/airflow-plugin): pipeline tasks discoverable in search (datahub-project#10819)

* feat(ingest/transformer): tags to terms transformer (datahub-project#10758)

Co-authored-by: Aseem Bansal <[email protected]>

* fix(ingestion/unity-catalog): fixed issue with profiling with GE turned on (datahub-project#10752)

Co-authored-by: Aseem Bansal <[email protected]>

* feat(forms) Add java SDK for form entity PATCH + CRUD examples (datahub-project#10822)

* feat(SDK) Add java SDK for structuredProperty entity PATCH + CRUD examples (datahub-project#10823)

* feat(SDK) Add StructuredPropertyPatchBuilder in python sdk and provide sample CRUD files (datahub-project#10824)

* feat(forms) Add CRUD endpoints to GraphQL for Form entities (datahub-project#10825)

* add flag for includeSoftDeleted in scroll entities API (datahub-project#10831)

* feat(deprecation) Return actor entity with deprecation aspect (datahub-project#10832)

* feat(structuredProperties) Add CRUD graphql APIs for structured property entities (datahub-project#10826)

* add scroll parameters to openapi v3 spec (datahub-project#10833)

* fix(ingest): correct profile_day_of_week implementation (datahub-project#10818)

* feat(ingest/glue): allow ingestion of empty databases from Glue (datahub-project#10666)

Co-authored-by: Harshal Sheth <[email protected]>

* feat(cli): add more details to get cli (datahub-project#10815)

* fix(ingestion/glue): ensure date formatting works on all platforms for aws glue (datahub-project#10836)

* fix(ingestion): fix datajob patcher (datahub-project#10827)

* fix(smoke-test): add suffix in temp file creation (datahub-project#10841)

* feat(ingest/glue): add helper method to permit user or group ownership (datahub-project#10784)

* feat(): Show data platform instances in policy modal if they are set on the policy (datahub-project#10645)

Co-authored-by: Hendrik Richert <[email protected]>

* docs(patch): add patch documentation for how implementation works (datahub-project#10010)

Co-authored-by: John Joyce <[email protected]>

* fix(jar): add missing custom-plugin-jar task (datahub-project#10847)

* fix(): also check exceptions/stack trace when filtering log messages (datahub-project#10391)

Co-authored-by: John Joyce <[email protected]>

* docs(): Update posts.md (datahub-project#9893)

Co-authored-by: Hyejin Yoon <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* chore(ingest): update acryl-datahub-classify version (datahub-project#10844)

* refactor(ingest): Refactor structured logging to support infos, warnings, and failures structured reporting to UI (datahub-project#10828)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>

* fix(restli): log aspect-not-found as a warning rather than as an error (datahub-project#10834)

* fix(ingest/nifi): remove duplicate upstream jobs (datahub-project#10849)

* fix(smoke-test): test access to create/revoke personal access tokens (datahub-project#10848)

* fix(smoke-test): missing test for move domain (datahub-project#10837)

* ci: update usernames to not considered for community (datahub-project#10851)

* env: change defaults for data contract visibility (datahub-project#10854)

* fix(ingest/tableau): quote special characters in external URL (datahub-project#10842)

* fix(smoke-test): fix flakiness of auto complete test

* ci(ingest): pin dask dependency for feast (datahub-project#10865)

* fix(ingestion/lookml): liquid template resolution and view-to-view cll (datahub-project#10542)

* feat(ingest/audit): add client id and version in system metadata props (datahub-project#10829)

* chore(ingest): Mypy 1.10.1 pin (datahub-project#10867)

* docs: use acryl-datahub-actions as expected python package to install (datahub-project#10852)

* docs: add new js snippet (datahub-project#10846)

* refactor(ingestion): remove company domain for security reason (datahub-project#10839)

* fix(ingestion/spark): Platform instance and column level lineage fix (datahub-project#10843)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat(ingestion/tableau): optionally ingest multiple sites and create site containers (datahub-project#10498)

Co-authored-by: Yanik Häni <[email protected]>

* fix(ingestion/looker): Add sqlglot dependency and remove unused sqlparser (datahub-project#10874)

* fix(manage-tokens): fix manage access token policy (datahub-project#10853)

* Batch get entity endpoints (datahub-project#10880)

* feat(system): support conditional write semantics (datahub-project#10868)

* fix(build): upgrade vercel builds to Node 20.x (datahub-project#10890)

* feat(ingest/lookml): shallow clone repos (datahub-project#10888)

* fix(ingest/looker): add missing dependency (datahub-project#10876)

* fix(ingest): only populate audit stamps where accurate (datahub-project#10604)

* fix(ingest/dbt): always encode tag urns (datahub-project#10799)

* fix(ingest/redshift): handle multiline alter table commands (datahub-project#10727)

* fix(ingestion/looker): column name missing in explore (datahub-project#10892)

* fix(lineage) Fix lineage source/dest filtering with explored per hop limit (datahub-project#10879)

* feat(conditional-writes): misc updates and fixes (datahub-project#10901)

* feat(ci): update outdated action (datahub-project#10899)

* feat(rest-emitter): adding async flag to rest emitter (datahub-project#10902)

Co-authored-by: Gabe Lyons <[email protected]>

* feat(ingest): add snowflake-queries source (datahub-project#10835)

* fix(ingest): improve `auto_materialize_referenced_tags_terms` error handling (datahub-project#10906)

* docs: add new company to adoption list (datahub-project#10909)

* refactor(redshift): Improve redshift error handling with new structured reporting system (datahub-project#10870)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>

* feat(ui) Finalize support for all entity types on forms (datahub-project#10915)

* Index ExecutionRequestResults status field (datahub-project#10811)

* feat(ingest): grafana connector (datahub-project#10891)

Co-authored-by: Shirshanka Das <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>

* fix(gms) Add Form entity type to EntityTypeMapper (datahub-project#10916)

* feat(dataset): add support for external url in Dataset (datahub-project#10877)

* docs(saas-overview) added missing features to observe section (datahub-project#10913)

Co-authored-by: John Joyce <[email protected]>

* fix(ingest/spark): Fixing Micrometer warning (datahub-project#10882)

* fix(structured properties): allow application of structured properties without schema file (datahub-project#10918)

* fix(data-contracts-web) handle other schedule types (datahub-project#10919)

* fix(ingestion/tableau): human-readable message for PERMISSIONS_MODE_SWITCHED error (datahub-project#10866)

Co-authored-by: Harshal Sheth <[email protected]>

* Add feature flag for view defintions (datahub-project#10914)

Co-authored-by: Ethan Cartwright <[email protected]>

* feat(ingest/BigQuery): refactor+parallelize dataset metadata extraction (datahub-project#10884)

* fix(airflow): add error handling around render_template() (datahub-project#10907)

* feat(ingestion/sqlglot): add optional `default_dialect` parameter to sqlglot lineage (datahub-project#10830)

* feat(mcp-mutator): new mcp mutator plugin (datahub-project#10904)

* fix(ingest/bigquery): changes helper function to decode unicode scape sequences (datahub-project#10845)

* feat(ingest/postgres): fetch table sizes for profile (datahub-project#10864)

* feat(ingest/abs): Adding azure blob storage ingestion source (datahub-project#10813)

* fix(ingest/redshift): reduce severity of SQL parsing issues (datahub-project#10924)

* fix(build): fix lint fix web react (datahub-project#10896)

* fix(ingest/bigquery): handle quota exceeded for project.list requests (datahub-project#10912)

* feat(ingest): report extractor failures more loudly (datahub-project#10908)

* feat(ingest/snowflake): integrate snowflake-queries into main source (datahub-project#10905)

* fix(ingest): fix docs build (datahub-project#10926)

* fix(ingest/snowflake): fix test connection (datahub-project#10927)

* fix(ingest/lookml): add view load failures to cache (datahub-project#10923)

* docs(slack) overhauled setup instructions and screenshots (datahub-project#10922)

Co-authored-by: John Joyce <[email protected]>

* fix(airflow): Add comma parsing of owners to DataJobs (datahub-project#10903)

* fix(entityservice): fix merging sideeffects (datahub-project#10937)

* feat(ingest): Support System Ingestion Sources, Show and hide system ingestion sources with Command-S (datahub-project#10938)

Co-authored-by: John Joyce <[email protected]>

* chore() Set a default lineage filtering end time on backend when a start time is present (datahub-project#10925)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* Added relationships APIs to V3. Added these generic APIs to V3 swagger doc. (datahub-project#10939)

* docs: add learning center to docs (datahub-project#10921)

* doc: Update hubspot form id (datahub-project#10943)

* chore(airflow): add python 3.11 w/ Airflow 2.9 to CI (datahub-project#10941)

* fix(ingest/Glue): column upstream lineage between S3 and Glue (datahub-project#10895)

* fix(ingest/abs): split abs utils into multiple files (datahub-project#10945)

* doc(ingest/looker): fix doc for sql parsing documentation (datahub-project#10883)

Co-authored-by: Harshal Sheth <[email protected]>

* fix(ingest/bigquery): Adding missing BigQuery types (datahub-project#10950)

* fix(ingest/setup): feast and abs source setup (datahub-project#10951)

* fix(connections) Harden adding /gms to connections in backend (datahub-project#10942)

* feat(siblings) Add flag to prevent combining siblings in the UI (datahub-project#10952)

* fix(docs): make graphql doc gen more automated (datahub-project#10953)

* feat(ingest/athena): Add option for Athena partitioned profiling (datahub-project#10723)

* fix(spark-lineage): default timeout for future responses (datahub-project#10947)

* feat(datajob/flow): add environment filter using info aspects (datahub-project#10814)

* fix(ui/ingest): correct privilege used to show tab (datahub-project#10483)

Co-authored-by: Kunal-kankriya <[email protected]>

* feat(ingest/looker): include dashboard urns in browse v2 (datahub-project#10955)

* add a structured type to batchGet in OpenAPI V3 spec (datahub-project#10956)

* fix(ui): scroll on the domain sidebar to show all domains (datahub-project#10966)

* fix(ingest/sagemaker): resolve incorrect variable assignment for SageMaker API call (datahub-project#10965)

* fix(airflow/build): Pinning mypy (datahub-project#10972)

* Fixed a bug where the OpenAPI V3 spec was incorrect. The bug was introduced in datahub-project#10939. (datahub-project#10974)

* fix(ingest/test): Fix for mssql integration tests (datahub-project#10978)

* fix(entity-service) exist check correctly extracts status (datahub-project#10973)

* fix(structuredProps) casing bug in StructuredPropertiesValidator (datahub-project#10982)

* bugfix: use anyOf instead of allOf when creating references in openapi v3 spec (datahub-project#10986)

* fix(ui): Remove ant less imports (datahub-project#10988)

* feat(ingest/graph): Add get_results_by_filter to DataHubGraph (datahub-project#10987)

* feat(ingest/cli): init does not actually support environment variables (datahub-project#10989)

* fix(ingest/graph): Update get_results_by_filter graphql query (datahub-project#10991)

* feat(ingest/spark): Promote beta plugin (datahub-project#10881)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat(ingest): support domains in meta -> "datahub" section (datahub-project#10967)

* feat(ingest): add `check server-config` command (datahub-project#10990)

* feat(cli): Make consistent use of DataHubGraphClientConfig (datahub-project#10466)

Deprecates get_url_and_token() in favor of a more complete option: load_graph_config() that returns a full DatahubClientConfig.
This change was then propagated across previous usages of get_url_and_token so that connections to DataHub server from the client respect the full breadth of configuration specified by DatahubClientConfig.

I.e: You can now specify disable_ssl_verification: true in your ~/.datahubenv file so that all cli functions to the server work when ssl certification is disabled.

Fixes datahub-project#9705

* fix(ingest/s3): Fixing container creation when there is no folder in path (datahub-project#10993)

* fix(ingest/looker): support platform instance for dashboards & charts (datahub-project#10771)

* feat(ingest/bigquery): improve handling of information schema in sql parser (datahub-project#10985)

* feat(ingest): improve `ingest deploy` command (datahub-project#10944)

* fix(backend): allow excluding soft-deleted entities in relationship-queries; exclude soft-deleted members of groups (datahub-project#10920)

- allow excluding soft-deleted entities in relationship-queries
- exclude soft-deleted members of groups

* fix(ingest/looker): downgrade missing chart type log level (datahub-project#10996)

* doc(acryl-cloud): release docs for 0.3.4.x (datahub-project#10984)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: RyanHolstien <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Pedro Silva <[email protected]>

* fix(protobuf/build): Fix protobuf check jar script (datahub-project#11006)

* fix(ui/ingest): Support invalid cron jobs (datahub-project#10998)

* fix(ingest): fix graph config loading (datahub-project#11002)

Co-authored-by: Pedro Silva <[email protected]>

* feat(docs): Document __DATAHUB_TO_FILE_ directive (datahub-project#10968)

Co-authored-by: Harshal Sheth <[email protected]>

* fix(graphql/upsertIngestionSource): Validate cron schedule; parse error in CLI (datahub-project#11011)

* feat(ece): support custom ownership type urns in ECE generation (datahub-project#10999)

* feat(assertion-v2): changed Validation tab to Quality and created new Governance tab (datahub-project#10935)

* fix(ingestion/glue): Add support for missing config options for profiling in Glue (datahub-project#10858)

* feat(propagation): Add models for schema field docs, tags, terms (datahub-project#2959) (datahub-project#11016)

Co-authored-by: Chris Collins <[email protected]>

* docs: standardize terminology to DataHub Cloud (datahub-project#11003)

* fix(ingestion/transformer): replace the externalUrl container (datahub-project#11013)

* docs(slack) troubleshoot docs (datahub-project#11014)

* feat(propagation): Add graphql API (datahub-project#11030)

Co-authored-by: Chris Collins <[email protected]>

* feat(propagation):  Add models for Action feature settings (datahub-project#11029)

* docs(custom properties): Remove duplicate from sidebar (datahub-project#11033)

* feat(models): Introducing Dataset Partitions Aspect (datahub-project#10997)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* feat(propagation): Add Documentation Propagation Settings (datahub-project#11038)

* fix(models): chart schema fields mapping, add dataHubAction entity, t… (datahub-project#11040)

* fix(ci): smoke test lint failures (datahub-project#11044)

* docs: fix learning center color scheme & typo (datahub-project#11043)

* feat: add cloud main page (datahub-project#11017)

Co-authored-by: Jay <[email protected]>

* feat(restore-indices): add additional step to also clear system metadata service (datahub-project#10662)

Co-authored-by: John Joyce <[email protected]>

* docs: fix typo (datahub-project#11046)

* fix(lint): apply spotless (datahub-project#11050)

* docs(airflow): example query to get datajobs for a dataflow (datahub-project#11034)

* feat(cli): Add run-id option to put sub-command (datahub-project#11023)

Adds an option to assign run-id to a given put command execution. 
This is useful when transformers do not exist for a given ingestion payload, we can follow up with custom metadata and assign it to an ingestion pipeline.

* fix(ingest): improve sql error reporting calls (datahub-project#11025)

* fix(airflow): fix CI setup (datahub-project#11031)

* feat(ingest/dbt): add experimental `prefer_sql_parser_lineage` flag (datahub-project#11039)

* fix(ingestion/lookml): enable stack-trace in lookml logs (datahub-project#10971)

* (chore): Linting fix (datahub-project#11015)

* chore(ci): update deprecated github actions (datahub-project#10977)

* Fix ALB configuration example (datahub-project#10981)

* chore(ingestion-base): bump base image packages (datahub-project#11053)

* feat(cli): Trim report of dataHubExecutionRequestResult to max GMS size (datahub-project#11051)

* fix(ingestion/lookml): emit dummy sql condition for lookml custom condition tag (datahub-project#11008)

Co-authored-by: Harshal Sheth <[email protected]>

* fix(ingestion/powerbi): fix issue with broken report lineage (datahub-project#10910)

* feat(ingest/tableau): add retry on timeout (datahub-project#10995)

* change generate kafka connect properties from env (datahub-project#10545)

Co-authored-by: david-leifker <[email protected]>

* fix(ingest): fix oracle cronjob ingestion (datahub-project#11001)

Co-authored-by: david-leifker <[email protected]>

* chore(ci): revert update deprecated github actions (datahub-project#10977) (datahub-project#11062)

* feat(ingest/dbt-cloud): update metadata_endpoint inference (datahub-project#11041)

* build: Reduce size of datahub-frontend-react image by 50-ish% (datahub-project#10878)

Co-authored-by: david-leifker <[email protected]>

* fix(ci): Fix lint issue in datahub_ingestion_run_summary_provider.py (datahub-project#11063)

* docs(ingest): update developing-a-transformer.md (datahub-project#11019)

* feat(search-test): update search tests from datahub-project#10408 (datahub-project#11056)

* feat(cli): add aspects parameter to DataHubGraph.get_entity_semityped (datahub-project#11009)

Co-authored-by: Harshal Sheth <[email protected]>

* docs(airflow): update min version for plugin v2 (datahub-project#11065)

* doc(ingestion/tableau): doc update for derived permission (datahub-project#11054)

Co-authored-by: Pedro Silva <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Harshal Sheth <[email protected]>

* fix(py): remove dep on types-pkg_resources (datahub-project#11076)

* feat(ingest/mode): add option to exclude restricted (datahub-project#11081)

* fix(ingest): set lastObserved in sdk when unset (datahub-project#11071)

* doc(ingest): Update capabilities (datahub-project#11072)

* chore(vulnerability): Log Injection (datahub-project#11090)

* chore(vulnerability): Information exposure through a stack trace (datahub-project#11091)

* chore(vulnerability): Comparison of narrow type with wide type in loop condition (datahub-project#11089)

* chore(vulnerability): Insertion of sensitive information into log files (datahub-project#11088)

* chore(vulnerability): Risky Cryptographic Algorithm (datahub-project#11059)

* chore(vulnerability): Overly permissive regex range (datahub-project#11061)

Co-authored-by: Harshal Sheth <[email protected]>

* fix: update customer data (datahub-project#11075)

* fix(models): fixing the datasetPartition models (datahub-project#11085)

Co-authored-by: John Joyce <[email protected]>

* fix(ui): Adding view, forms GraphQL query, remove showing a fallback error message on unhandled GraphQL error (datahub-project#11084)

Co-authored-by: John Joyce <[email protected]>

* feat(docs-site): hiding learn more from cloud page (datahub-project#11097)

* fix(docs): Add correct usage of orFilters in search API docs (datahub-project#11082)

Co-authored-by: Jay <[email protected]>

* fix(ingest/mode): Regexp in mode name matcher didn't allow underscore (datahub-project#11098)

* docs: Refactor customer stories section (datahub-project#10869)

Co-authored-by: Jeff Merrick <[email protected]>

* fix(release): fix full/slim suffix on tag (datahub-project#11087)

* feat(config): support alternate hashing algorithm for doc id (datahub-project#10423)

Co-authored-by: david-leifker <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* fix(emitter): fix typo in get method of java kafka emitter (datahub-project#11007)

* fix(ingest): use correct native data type in all SQLAlchemy sources by compiling data type using dialect (datahub-project#10898)

Co-authored-by: Harshal Sheth <[email protected]>

* chore: Update contributors list in PR labeler (datahub-project#11105)

* feat(ingest): tweak stale entity removal messaging (datahub-project#11064)

* fix(ingestion): enforce lastObserved timestamps in SystemMetadata (datahub-project#11104)

* fix(ingest/powerbi): fix broken lineage between chart and dataset (datahub-project#11080)

* feat(ingest/lookml): CLL support for sql set in sql_table_name attribute of lookml view (datahub-project#11069)

* docs: update graphql docs on forms & structured properties (datahub-project#11100)

* test(search): search openAPI v3 test (datahub-project#11049)

* fix(ingest/tableau): prevent empty site content urls (datahub-project#11057)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat(entity-client): implement client batch interface (datahub-project#11106)

* fix(snowflake): avoid reporting warnings/info for sys tables (datahub-project#11114)

* fix(ingest): downgrade column type mapping warning to info (datahub-project#11115)

* feat(api): add AuditStamp to the V3 API entity/aspect response (datahub-project#11118)

* fix(ingest/redshift): replace r'\n' with '\n' to avoid token error redshift serverless… (datahub-project#11111)

* fix(entiy-client): handle null entityUrn case for restli (datahub-project#11122)

* fix(sql-parser): prevent bad urns from alter table lineage (datahub-project#11092)

* fix(ingest/bigquery): use small batch size if use_tables_list_query_v2 is set (datahub-project#11121)

* fix(graphql): add missing entities to EntityTypeMapper and EntityTypeUrnMapper (datahub-project#10366)

* feat(ui): Changes to allow editable dataset name (datahub-project#10608)

Co-authored-by: Jay Kadambi <[email protected]>

* fix: remove saxo (datahub-project#11127)

* feat(mcl-processor): Update mcl processor hooks (datahub-project#11134)

* fix(openapi): fix openapi v2 endpoints & v3 documentation update

* Revert "fix(openapi): fix openapi v2 endpoints & v3 documentation update"

This reverts commit 573c1cb.

* docs(policies): updates to policies documentation (datahub-project#11073)

* fix(openapi): fix openapi v2 and v3 docs update (datahub-project#11139)

* feat(auth): grant type and acr values custom oidc parameters support (datahub-project#11116)

* fix(mutator): mutator hook fixes (datahub-project#11140)

* feat(search): support sorting on multiple fields (datahub-project#10775)

* feat(ingest): various logging improvements (datahub-project#11126)

* fix(ingestion/lookml): fix for sql parsing error (datahub-project#11079)

Co-authored-by: Harshal Sheth <[email protected]>

* feat(docs-site) cloud page spacing and content polishes (datahub-project#11141)

* feat(ui) Enable editing structured props on fields (datahub-project#11042)

* feat(tests): add md5 and last computed to testResult model (datahub-project#11117)

* test(openapi): openapi regression smoke tests (datahub-project#11143)

* fix(airflow): fix tox tests + update docs (datahub-project#11125)

* docs: add chime to adoption stories (datahub-project#11142)

* fix(ingest/databricks): Updating code to work with Databricks sdk 0.30 (datahub-project#11158)

* fix(kafka-setup): add missing script to image (datahub-project#11190)

* fix(config): fix hash algo config (datahub-project#11191)

* test(smoke-test): updates to smoke-tests (datahub-project#11152)

* fix(elasticsearch): refactor idHashAlgo setting (datahub-project#11193)

* chore(kafka): kafka version bump (datahub-project#11211)

* readd UsageStatsWorkUnit

* fix merge problems

* change logo

---------

Co-authored-by: Chris Collins <[email protected]>
Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>
Co-authored-by: dushayntAW <[email protected]>
Co-authored-by: sagar-salvi-apptware <[email protected]>
Co-authored-by: Aseem Bansal <[email protected]>
Co-authored-by: Kevin Chun <[email protected]>
Co-authored-by: jordanjeremy <[email protected]>
Co-authored-by: skrydal <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>
Co-authored-by: david-leifker <[email protected]>
Co-authored-by: sid-acryl <[email protected]>
Co-authored-by: Julien Jehannet <[email protected]>
Co-authored-by: Hendrik Richert <[email protected]>
Co-authored-by: Hendrik Richert <[email protected]>
Co-authored-by: RyanHolstien <[email protected]>
Co-authored-by: Felix Lüdin <[email protected]>
Co-authored-by: Pirry <[email protected]>
Co-authored-by: Hyejin Yoon <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: cburroughs <[email protected]>
Co-authored-by: ksrinath <[email protected]>
Co-authored-by: Mayuri Nehate <[email protected]>
Co-authored-by: Kunal-kankriya <[email protected]>
Co-authored-by: Shirshanka Das <[email protected]>
Co-authored-by: ipolding-cais <[email protected]>
Co-authored-by: Tamas Nemeth <[email protected]>
Co-authored-by: Shubham Jagtap <[email protected]>
Co-authored-by: haeniya <[email protected]>
Co-authored-by: Yanik Häni <[email protected]>
Co-authored-by: Gabe Lyons <[email protected]>
Co-authored-by: Gabe Lyons <[email protected]>
Co-authored-by: 808OVADOZE <[email protected]>
Co-authored-by: noggi <[email protected]>
Co-authored-by: Nicholas Pena <[email protected]>
Co-authored-by: Jay <[email protected]>
Co-authored-by: ethan-cartwright <[email protected]>
Co-authored-by: Ethan Cartwright <[email protected]>
Co-authored-by: Nadav Gross <[email protected]>
Co-authored-by: Patrick Franco Braz <[email protected]>
Co-authored-by: pie1nthesky <[email protected]>
Co-authored-by: Joel Pinto Mata (KPN-DSH-DEX team) <[email protected]>
Co-authored-by: Ellie O'Neil <[email protected]>
Co-authored-by: Ajoy Majumdar <[email protected]>
Co-authored-by: deepgarg-visa <[email protected]>
Co-authored-by: Tristan Heisler <[email protected]>
Co-authored-by: Andrew Sikowitz <[email protected]>
Co-authored-by: Davi Arnaut <[email protected]>
Co-authored-by: Pedro Silva <[email protected]>
Co-authored-by: amit-apptware <[email protected]>
Co-authored-by: Sam Black <[email protected]>
Co-authored-by: Raj Tekal <[email protected]>
Co-authored-by: Steffen Grohsschmiedt <[email protected]>
Co-authored-by: jaegwon.seo <[email protected]>
Co-authored-by: Renan F. Lima <[email protected]>
Co-authored-by: Matt Exchange <[email protected]>
Co-authored-by: Jonny Dixon <[email protected]>
Co-authored-by: Pedro Silva <[email protected]>
Co-authored-by: Pinaki Bhattacharjee <[email protected]>
Co-authored-by: Jeff Merrick <[email protected]>
Co-authored-by: skrydal <[email protected]>
Co-authored-by: AndreasHegerNuritas <[email protected]>
Co-authored-by: jayasimhankv <[email protected]>
Co-authored-by: Jay Kadambi <[email protected]>
Co-authored-by: David Leifker <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution PR or Issue raised by member(s) of DataHub Community docs Issues and Improvements to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants