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

Updated from Slack to Discord #5196

Merged
merged 8 commits into from
Nov 27, 2024
Merged

Conversation

minhtuev
Copy link
Contributor

@minhtuev minhtuev commented Nov 27, 2024

What changes are proposed in this pull request?

Updated the Slack link to Discord link

How is this patch tested? If it is not, please explain why.

  • Local testing (✅ )

Web app seems to render correctly

image

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

Release Notes

  • New Features

    • Updated community links from Slack to Discord across various components and documentation.
    • Introduced a new Discord icon and link in the application interface.
  • Documentation

    • Enhanced troubleshooting guides to reflect Discord as the primary support channel.
    • Updated social links in documentation to direct users to the Discord community.
    • Modified FiftyOne Teams documentation to indicate Discord for enterprise support.
  • Style

    • Changed references in the navigation menu and footer from Slack to Discord.

Copy link
Contributor

coderabbitai bot commented Nov 27, 2024

Walkthrough

The changes in this pull request primarily involve replacing instances of the SlackLink component with the DiscordLink component across various files. This includes modifications in both the codebase and documentation, ensuring that references to Slack are updated to reflect the transition to Discord. The overall functionality and structure of the affected components and documents remain unchanged, with the primary focus on updating links and related content.

Changes

File Path Change Summary
app/packages/app/src/components/Nav.tsx Replaced SlackLink with DiscordLink in import and JSX.
app/packages/app/src/components/Setup.tsx Replaced SlackLink with DiscordLink in import and JSX.
app/packages/components/src/components/Icons/Icons.tsx Replaced SlackLink with DiscordLink, updated href and SVG path for the icon.
app/packages/components/src/components/Icons/index.ts Updated exports to replace SlackLink with DiscordLink.
fiftyone/core/session/session.py Changed welcome message link from Slack to Discord.
docs/source/getting_started/troubleshooting.rst Updated contact method from Slack to Discord and clarified troubleshooting guidance.
docs/source/index.rst Updated social links to replace Slack with Discord, including URL and image changes.
docs/source/_templates/layout.html Changed references from "Slack" to "Discord" in navigation and footer.
docs/source/conf.py Added a new entry for Discord link in the Sphinx configuration.
docs/source/teams/overview.rst Updated "Enterprise Support" entry from "Slack Community" to "Discord Community."

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • brimoor
  • findtopher
  • manivoxel51

🐰 In the meadow, hops a little hare,
With changes to links, we spread the care.
From Slack to Discord, we make the switch,
Join us in chat, without a hitch!
With every update, our community grows,
Together we thrive, as everyone knows! 🌼

Warning

Rate limit exceeded

@minhtuev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 10 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 3d45534 and 22083a3.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3d45534 and 22083a3.

📒 Files selected for processing (5)
  • app/packages/components/src/components/Icons/Icons.tsx (1 hunks)
  • docs/source/conf.py (1 hunks)
  • docs/source/getting_started/troubleshooting.rst (1 hunks)
  • docs/source/index.rst (2 hunks)
  • fiftyone/core/session/session.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
  • app/packages/components/src/components/Icons/Icons.tsx
  • docs/source/conf.py
  • docs/source/getting_started/troubleshooting.rst
  • docs/source/index.rst
  • fiftyone/core/session/session.py

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

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: 2

🧹 Outside diff range and nitpick comments (1)
app/packages/core/src/plugins/SchemaIO/components/FileExplorerView/icons/Discord.icon.tsx (1)

1-1: Add TypeScript type imports for better type safety.

Consider adding explicit type imports from @mui/material for better type safety and documentation.

-import SvgIcon from "@mui/material/SvgIcon";
+import { SvgIcon, SvgIconProps } from "@mui/material";
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 34961bb and 41d51ce.

📒 Files selected for processing (6)
  • app/packages/app/src/components/Nav.tsx (2 hunks)
  • app/packages/app/src/components/Setup.tsx (2 hunks)
  • app/packages/components/src/components/Icons/Icons.tsx (1 hunks)
  • app/packages/components/src/components/Icons/index.ts (1 hunks)
  • app/packages/core/src/plugins/SchemaIO/components/FileExplorerView/icons/Discord.icon.tsx (1 hunks)
  • fiftyone/core/session/session.py (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • app/packages/app/src/components/Nav.tsx
  • app/packages/components/src/components/Icons/index.ts
  • fiftyone/core/session/session.py
🧰 Additional context used
📓 Path-based instructions (3)
app/packages/app/src/components/Setup.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

app/packages/components/src/components/Icons/Icons.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

app/packages/core/src/plugins/SchemaIO/components/FileExplorerView/icons/Discord.icon.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

🔇 Additional comments (3)
app/packages/components/src/components/Icons/Icons.tsx (1)

Line range hint 11-24: LGTM: DiscordLink component implementation

The component follows the established pattern of other link components in the file, properly utilizing ExternalLink and SvgIcon with consistent styling through theme.palette.text.secondary.

app/packages/app/src/components/Setup.tsx (2)

5-5: LGTM! Import statement updated correctly.

The import statement has been properly updated to use DiscordLink from the components package.


193-193: LGTM! Component usage updated consistently.

The DiscordLink component is properly integrated in the Header's icon container, maintaining consistency with other social links.

Let's verify that this change is consistent across other files:

✅ Verification successful

Component usage verified and consistent across the codebase

The verification confirms that:

  • DiscordLink is properly imported and used in both Nav.tsx and Setup.tsx
  • The component is correctly defined in the shared components library (Icons.tsx)
  • No legacy SlackLink references remain in the codebase
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that SlackLink has been completely replaced with DiscordLink

# Check for any remaining SlackLink references
rg "SlackLink" 

# Check for consistent DiscordLink usage
rg "DiscordLink"

Length of output: 436

Comment on lines 3 to 9
export default function DiscordIcon() {
return (
<SvgIcon>
<path d="M6 15a2 2 0 0 1-2 2a2 2 0 0 1-2-2a2 2 0 0 1 2-2h2v2m1 0a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-5m2-8a2 2 0 0 1-2-2a2 2 0 0 1 2-2a2 2 0 0 1 2 2v2H9m0 1a2 2 0 0 1 2 2a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5m8 2a2 2 0 0 1 2-2a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-2v-2m-1 0a2 2 0 0 1-2 2a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5m-2 8a2 2 0 0 1 2 2a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-2h2m0-1a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-5z" />
</SvgIcon>
);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance component with TypeScript types, accessibility, and performance optimizations.

The component implementation could benefit from several improvements:

  1. Add TypeScript interface for props
  2. Add accessibility attributes
  3. Implement memoization
  4. Add documentation

Consider applying these improvements:

+import { memo } from "react";
-import SvgIcon from "@mui/material/SvgIcon";
+import { SvgIcon, SvgIconProps } from "@mui/material";

+interface DiscordIconProps extends SvgIconProps {}
+
+/**
+ * Discord icon component using Material-UI SvgIcon
+ */
-export default function DiscordIcon() {
+const DiscordIcon = memo(function DiscordIcon(props: DiscordIconProps) {
   return (
-    <SvgIcon>
+    <SvgIcon 
+      {...props}
+      aria-label="Discord"
+      role="img"
+    >
       <path d="M6 15a2 2 0 0 1-2 2a2 2 0 0 1-2-2a2 2 0 0 1 2-2h2v2m1 0a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-5m2-8a2 2 0 0 1-2-2a2 2 0 0 1 2-2a2 2 0 0 1 2 2v2H9m0 1a2 2 0 0 1 2 2a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5m8 2a2 2 0 0 1 2-2a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-2v-2m-1 0a2 2 0 0 1-2 2a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5m-2 8a2 2 0 0 1 2 2a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-2h2m0-1a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-5z" />
     </SvgIcon>
   );
-}
+});
+
+export default DiscordIcon;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
export default function DiscordIcon() {
return (
<SvgIcon>
<path d="M6 15a2 2 0 0 1-2 2a2 2 0 0 1-2-2a2 2 0 0 1 2-2h2v2m1 0a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-5m2-8a2 2 0 0 1-2-2a2 2 0 0 1 2-2a2 2 0 0 1 2 2v2H9m0 1a2 2 0 0 1 2 2a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5m8 2a2 2 0 0 1 2-2a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-2v-2m-1 0a2 2 0 0 1-2 2a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5m-2 8a2 2 0 0 1 2 2a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-2h2m0-1a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-5z" />
</SvgIcon>
);
}
import { memo } from "react";
import { SvgIcon, SvgIconProps } from "@mui/material";
interface DiscordIconProps extends SvgIconProps {}
/**
* Discord icon component using Material-UI SvgIcon
*/
const DiscordIcon = memo(function DiscordIcon(props: DiscordIconProps) {
return (
<SvgIcon
{...props}
aria-label="Discord"
role="img"
>
<path d="M6 15a2 2 0 0 1-2 2a2 2 0 0 1-2-2a2 2 0 0 1 2-2h2v2m1 0a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-5m2-8a2 2 0 0 1-2-2a2 2 0 0 1 2-2a2 2 0 0 1 2 2v2H9m0 1a2 2 0 0 1 2 2a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5m8 2a2 2 0 0 1 2-2a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-2v-2m-1 0a2 2 0 0 1-2 2a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2a2 2 0 0 1 2 2v5m-2 8a2 2 0 0 1 2 2a2 2 0 0 1-2 2a2 2 0 0 1-2-2v-2h2m0-1a2 2 0 0 1-2-2a2 2 0 0 1 2-2h5a2 2 0 0 1 2 2a2 2 0 0 1-2 2h-5z" />
</SvgIcon>
);
});
export default DiscordIcon;

<ExternalLink
className={iconLink}
href={"https://slack.voxel51.com"}
title={"Slack"}
href={"http://community.voxel51.com/"}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Use HTTPS for external links

The external link to the Discord community uses HTTP which is insecure. Consider updating to HTTPS for better security.

-    href={"http://community.voxel51.com/"}
+    href={"https://community.voxel51.com/"}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
href={"http://community.voxel51.com/"}
href={"https://community.voxel51.com/"}

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.

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 1

🛑 Comments failed to post (1)
docs/source/getting_started/troubleshooting.rst (1)

12-12: 💡 Codebase verification

Consider updating the Discord link to use HTTPS and the final destination URL

The current link http://community.voxel51.com works but goes through multiple redirects before reaching the final Discord invite URL. For better user experience and security, consider updating to: https://discord.gg/fiftyone-community

  • The current link works but requires 3 redirects:
    • http://community.voxel51.comhttps://community.voxel51.comhttps://discord.gg/fiftyone-communityhttps://discord.com/invite/fiftyone-community
  • Using HTTPS by default is a security best practice
  • Using the direct Discord invite link reduces latency
🔗 Analysis chain

LGTM! Let's verify the Discord link.

The update from Slack to Discord is consistent with the PR objectives.

Let's verify the Discord link is accessible:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the Discord community link is accessible
# Expected: HTTP 200 OK response, indicating the link is valid

curl -I http://community.voxel51.com

Length of output: 559


Script:

#!/bin/bash
# Follow the redirect to verify the HTTPS endpoint
curl -IL https://community.voxel51.com

Length of output: 7183

@sashankaryal sashankaryal requested a review from a team November 27, 2024 20:34
@@ -0,0 +1,9 @@
import SvgIcon from "@mui/material/SvgIcon";
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if we ever use it, but I added it for parity with Slack.icon.tsx

sashankaryal
sashankaryal previously approved these changes Nov 27, 2024
Copy link
Contributor

@sashankaryal sashankaryal left a comment

Choose a reason for hiding this comment

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

lgtm

@minhtuev minhtuev merged commit 9f690fe into release/v1.1.0 Nov 27, 2024
11 checks passed
@minhtuev minhtuev deleted the feat/update-community branch November 27, 2024 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants