docs(slack) troubleshoot docs #11014
Conversation
WalkthroughThe recent changes enhance the DataHub documentation by introducing a dedicated troubleshooting guide for Slack integration. This update includes a new sidebar entry for quick access and a detailed markdown file that addresses common issues, providing step-by-step solutions to improve user support and the overall experience. 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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
github-actions
bot
added
docs
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs-website/sidebars.js (1 hunks)
- docs/managed-datahub/slack/saas-slack-troubleshoot.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/slack/saas-slack-troubleshoot.md
[grammar] ~8-~8: The verb ‘recommend’ is used with the gerund form.
Context: ...ation is working First and foremost, we recommend to use the 'Send a test notification' feature ...(ADMIT_ENJOY_VB)
[grammar] ~14-~14: Did you mean “There are several reasons”?
Context: ...iled with 'Re-Connect DataHub to Slack' There's several reasons why sending a test notification would f...(THERE_S_MANY)
[grammar] ~61-~61: Consider using the plural verb form for the plural noun “reasons”.
Context: ... works, but not receiving notifications There's a few reasons why you may not receive n...(THERE_IS_A_LOT_OF)
Markdownlint
docs/managed-datahub/slack/saas-slack-troubleshoot.md
64-64: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
11-11: 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)
39-39: null
Images should have alternate text (alt text)(MD045, no-alt-text)
44-44: null
Images should have alternate text (alt text)(MD045, no-alt-text)
49-49: null
Images should have alternate text (alt text)(MD045, no-alt-text)
53-53: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (3)
docs/managed-datahub/slack/saas-slack-troubleshoot.md (2)
30-59: LGTM!The instructions for installing a new app are clear and well-structured.
Tools
Markdownlint
39-39: null
Images should have alternate text (alt text)(MD045, no-alt-text)
44-44: null
Images should have alternate text (alt text)(MD045, no-alt-text)
49-49: null
Images should have alternate text (alt text)(MD045, no-alt-text)
53-53: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
67-69: LGTM!The concluding section is clear and provides appropriate guidance.
docs-website/sidebars.js (1)
252-256: LGTM!The new entry for the Slack troubleshooting documentation enhances the sidebar navigation.
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/managed-datahub/slack/saas-slack-troubleshoot.md (1 hunks)
Additional context used
Markdownlint
docs/managed-datahub/slack/saas-slack-troubleshoot.md
11-11: 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)
39-39: null
Images should have alternate text (alt text)(MD045, no-alt-text)
44-44: null
Images should have alternate text (alt text)(MD045, no-alt-text)
49-49: null
Images should have alternate text (alt text)(MD045, no-alt-text)
53-53: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (11)
docs/managed-datahub/slack/saas-slack-troubleshoot.md (11)
11-11: Add alt text to images.Images should have alternate text for better accessibility.
- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/setup_7.png"/> + <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/setup_7.png" alt="Slack setup step 7"/>Tools
Markdownlint
11-11: null
Images should have alternate text (alt text)(MD045, no-alt-text)
26-26: Add alt text to images.Images should have alternate text for better accessibility.
- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_1.png"/> + <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_1.png" alt="Slack re-connect step 1"/>Tools
Markdownlint
26-26: null
Images should have alternate text (alt text)(MD045, no-alt-text)
39-39: Add alt text to images.Images should have alternate text for better accessibility.
- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_1_1.png"/> + <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_1_1.png" alt="Slack re-connect step 1.1"/>Tools
Markdownlint
39-39: null
Images should have alternate text (alt text)(MD045, no-alt-text)
44-44: Add alt text to images.Images should have alternate text for better accessibility.
- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_2.png"/> + <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_2.png" alt="Slack re-connect step 2"/>Tools
Markdownlint
44-44: null
Images should have alternate text (alt text)(MD045, no-alt-text)
49-49: Add alt text to images.Images should have alternate text for better accessibility.
- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_3.png"/> + <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_3.png" alt="Slack re-connect step 3"/>Tools
Markdownlint
49-49: null
Images should have alternate text (alt text)(MD045, no-alt-text)
53-53: Add alt text to images.Images should have alternate text for better accessibility.
- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_4.png"/> + <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_4.png" alt="Slack re-connect step 4"/>Tools
Markdownlint
53-53: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: Add alt text to images.Images should have alternate text for better accessibility.
- <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_5.png"/> + <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/re_connect_5.png" alt="Slack re-connect step 5"/>Tools
Markdownlint
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
64-64: Fix punctuation in heading.Remove the trailing punctuation in the heading.
- ### 1. Actors do not receive notifications for their actions. + ### 1 Actors do not receive notifications for their actions
8-8: Fix grammatical error.The verb 'recommend' should be followed by the gerund form.
- we recommend to use the 'Send a test notification' feature + we recommend using the 'Send a test notification' feature
14-14: Fix grammatical error.The correct phrase is "There are several reasons."
- There's several reasons why sending a test notification would fail. + There are several reasons why sending a test notification would fail.
61-61: Fix grammatical error.The correct phrase is "There are a few reasons."
- There's a few reasons why you may not receive notifications + There are a few reasons why you may not receive notifications
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs-website/sidebars.js (1 hunks)
- docs/managed-datahub/slack/saas-slack-troubleshoot.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs-website/sidebars.js
Additional context used
Markdownlint
docs/managed-datahub/slack/saas-slack-troubleshoot.md
11-11: 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)
39-39: null
Images should have alternate text (alt text)(MD045, no-alt-text)
44-44: null
Images should have alternate text (alt text)(MD045, no-alt-text)
49-49: null
Images should have alternate text (alt text)(MD045, no-alt-text)
53-53: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (7)
docs/managed-datahub/slack/saas-slack-troubleshoot.md (7)
7-8: Fix grammatical error.The verb 'recommend' should be followed by the gerund form.
- we recommend to use the 'Send a test notification' feature + we recommend using the 'Send a test notification' feature
14-15: Fix grammatical error.The correct phrase is "There are several reasons."
- There's several reasons why sending a test notification would fail. + There are several reasons why sending a test notification would fail.
18-29: LGTM!The steps to refresh the existing app installation are clear and well-documented.
Tools
Markdownlint
26-26: null
Images should have alternate text (alt text)(MD045, no-alt-text)
30-58: LGTM!The steps to install a new app are clear and well-documented.
Tools
Markdownlint
39-39: null
Images should have alternate text (alt text)(MD045, no-alt-text)
44-44: null
Images should have alternate text (alt text)(MD045, no-alt-text)
49-49: null
Images should have alternate text (alt text)(MD045, no-alt-text)
53-53: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
61-62: Fix grammatical error.The correct phrase is "There are a few reasons."
- There's a few reasons why you may not receive notifications + There are a few reasons why you may not receive notifications
64-64: Fix punctuation in heading.Remove the trailing punctuation in the heading.
- ### 1. Actors do not receive notifications for their actions. + ### 1 Actors do not receive notifications for their actions
67-68: LGTM!The information about contacting support is clear and well-documented.
There was a problem hiding this comment.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/managed-datahub/slack/saas-slack-troubleshoot.md (1 hunks)
Additional context used
Markdownlint
docs/managed-datahub/slack/saas-slack-troubleshoot.md
13-13: null
Images should have alternate text (alt text)(MD045, no-alt-text)
28-28: null
Images should have alternate text (alt text)(MD045, no-alt-text)
41-41: null
Images should have alternate text (alt text)(MD045, no-alt-text)
46-46: null
Images should have alternate text (alt text)(MD045, no-alt-text)
51-51: null
Images should have alternate text (alt text)(MD045, no-alt-text)
55-55: null
Images should have alternate text (alt text)(MD045, no-alt-text)
59-59: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (5)
docs/managed-datahub/slack/saas-slack-troubleshoot.md (5)
1-2: LGTM!The import statement and the blank line for readability are correct.
3-8: LGTM!The title, introduction, and link to the setup guide are clear and correctly formatted.
16-19: LGTM!The section on test notification failures is clear and informative.
63-64: LGTM!The section on not receiving notifications is clear and informative.
66-70: LGTM!The section on specific reasons for not receiving notifications and suggesting contacting customer support is clear and informative.
Checklist
Summary by CodeRabbit
New Features
Documentation