docs(slack): fix broken Slack links and improve onboarding#714
docs(slack): fix broken Slack links and improve onboarding#714abhishek-8081 wants to merge 1 commit intokubeedge:masterfrom
Conversation
kubeedge-bot
added
the
do-not-merge/invalid-commit-message
|
Welcome @abhishek-8081! It looks like this is your first PR to kubeedge/website 🎉 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @abhishek-8081, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request aims to significantly improve the onboarding experience for new KubeEdge community members by fixing broken Slack links and providing comprehensive guidance on joining and navigating the CNCF Slack workspace. It replaces outdated direct links with a clear, step-by-step joining process and organizes channel information for better accessibility.
Highlights
- Improved Slack Onboarding: Replaced authentication-required Slack links with a new, accessible onboarding flow starting from https://slack.cncf.io.
- Organized Channel Directory: Introduced a categorized directory of KubeEdge Slack channels (General, Development, SIGs) with descriptions and intended use cases.
- Enhanced User Guidance: Added sections for tips for new contributors, best practices for Slack usage, and troubleshooting steps to assist users in finding channels.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
kubeedge-bot
added
the
size/M
There was a problem hiding this comment.
Code Review
This pull request does a great job of improving the documentation for joining the KubeEdge Slack community, making it much more accessible for new contributors. The step-by-step guide and channel directory are excellent additions.
My review focuses on ensuring consistency in the provided Slack channel links to fully align with the PR's goal of improving accessibility. I've suggested changing all channel links to a web-friendly format that avoids forcing users into the Slack client, which can be a barrier for those not yet logged in. This also resolves a contradiction with the PR description which correctly identified the problematic link format. I've also included a minor formatting fix for consistency.
| - [#kubeedge](https://cloud-native.slack.com/archives/C066UJZJKQE) – General discussion and community questions | ||
| - [#kubeedge-announcement](https://app.slack.com/client/T08PSQ7BQ/C06BCA5MR5Y) – Official project updates and announcements | ||
|
|
||
| ### Development & Technical | ||
| - [#kubeedge-dev](https://app.slack.com/client/T08PSQ7BQ/C06C13NGR0Q) – Development discussions and technical questions | ||
| - [#kubeedge-dashboard](https://app.slack.com/client/T08PSQ7BQ/C066LNA3015) – Dashboard-related development and issues | ||
| - [#kubeedge-docs](https://app.slack.com/client/T08PSQ7BQ/C06BCA5V1LJ) – Documentation improvements and discussions | ||
|
|
||
| ### Special Interest Groups (SIGs) | ||
| - [#kubeedge-sig-ai](https://app.slack.com/client/T08PSQ7BQ/C06BQURDQQ1) – AI/ML workloads on edge computing | ||
| - [#kubeedge-sig-device-iot](https://app.slack.com/client/T08PSQ7BQ/C06BC6VQHFD) – IoT device integration and management | ||
| - [#kubeedge-sig-robotics](https://cloud-native.slack.com/archives/C066LNMUME3) – Robotics applications and use cases | ||
| - [#kubeedge-sig-security](https://app.slack.com/client/T08PSQ7BQ/C06C13NN1UG) – Security best practices and discussions | ||
| - [#kubeedge-sig-mec](https://app.slack.com/client/T08PSQ7BQ/C06B5LRV3B8) – Mobile Edge Computing (MEC) topics |
There was a problem hiding this comment.
There are a couple of issues with the channel directory list:
-
Inconsistent URL format: The PR description correctly identifies that
app.slack.com/client/...URLs are problematic for new users, yet many of the new links use this format. For a better user experience and consistency, all channel links should use thehttps://cloud-native.slack.com/archives/CHANNEL_IDformat. This format is more web-friendly as it opens in the browser. -
Inconsistent formatting: The line for
#kubeedge-announcementis missing the trailing two spaces for a hard line break, which is used on other similar lines.
I've provided a suggestion that fixes both issues by updating the URLs to the cloud-native.slack.com/archives/ format and ensuring consistent formatting.
| - [#kubeedge](https://cloud-native.slack.com/archives/C066UJZJKQE) – General discussion and community questions | |
| - [#kubeedge-announcement](https://app.slack.com/client/T08PSQ7BQ/C06BCA5MR5Y) – Official project updates and announcements | |
| ### Development & Technical | |
| - [#kubeedge-dev](https://app.slack.com/client/T08PSQ7BQ/C06C13NGR0Q) – Development discussions and technical questions | |
| - [#kubeedge-dashboard](https://app.slack.com/client/T08PSQ7BQ/C066LNA3015) – Dashboard-related development and issues | |
| - [#kubeedge-docs](https://app.slack.com/client/T08PSQ7BQ/C06BCA5V1LJ) – Documentation improvements and discussions | |
| ### Special Interest Groups (SIGs) | |
| - [#kubeedge-sig-ai](https://app.slack.com/client/T08PSQ7BQ/C06BQURDQQ1) – AI/ML workloads on edge computing | |
| - [#kubeedge-sig-device-iot](https://app.slack.com/client/T08PSQ7BQ/C06BC6VQHFD) – IoT device integration and management | |
| - [#kubeedge-sig-robotics](https://cloud-native.slack.com/archives/C066LNMUME3) – Robotics applications and use cases | |
| - [#kubeedge-sig-security](https://app.slack.com/client/T08PSQ7BQ/C06C13NN1UG) – Security best practices and discussions | |
| - [#kubeedge-sig-mec](https://app.slack.com/client/T08PSQ7BQ/C06B5LRV3B8) – Mobile Edge Computing (MEC) topics | |
| - [#kubeedge](https://cloud-native.slack.com/archives/C066UJZJKQE) – General discussion and community questions | |
| - [#kubeedge-announcement](https://cloud-native.slack.com/archives/C06BCA5MR5Y) – Official project updates and announcements | |
| ### Development & Technical | |
| - [#kubeedge-dev](https://cloud-native.slack.com/archives/C06C13NGR0Q) – Development discussions and technical questions | |
| - [#kubeedge-dashboard](https://cloud-native.slack.com/archives/C066LNA3015) – Dashboard-related development and issues | |
| - [#kubeedge-docs](https://cloud-native.slack.com/archives/C06BCA5V1LJ) – Documentation improvements and discussions | |
| ### Special Interest Groups (SIGs) | |
| - [#kubeedge-sig-ai](https://cloud-native.slack.com/archives/C06BQURDQQ1) – AI/ML workloads on edge computing | |
| - [#kubeedge-sig-device-iot](https://cloud-native.slack.com/archives/C06BC6VQHFD) – IoT device integration and management | |
| - [#kubeedge-sig-robotics](https://cloud-native.slack.com/archives/C066LNMUME3) – Robotics applications and use cases | |
| - [#kubeedge-sig-security](https://cloud-native.slack.com/archives/C06C13NN1UG) – Security best practices and discussions | |
| - [#kubeedge-sig-mec](https://cloud-native.slack.com/archives/C06B5LRV3B8) – Mobile Edge Computing (MEC) topics |
|
this closes kubeedge/kubeedge#6440 |
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
this page gets old and outdated, lgtm
|
@dependabot rebase |
|
@Shelley-BaoYue i would love to see this merged, is there any way that we can rebase this without asking contributor? |
|
Greetings @fujitatomoya , |
|
@abhishek-8081 thanks! please chime in #756, if anything you wanna share with it. i think we should not ask author to rebase every time... 😓 |
abhishek-8081
changed the title
|
@Mergifyio rebase |
|
https://github.com/Mergifyio rebase |
|
@Mergifyio rebase |
1 similar comment
|
@Mergifyio rebase |
Resolves broken Slack links and improves accessibility for new contributors joining the KubeEdge community. 1. **Broken Links Fixed** * **Before:** Direct Slack URLs required authentication (e.g., `https://app.slack.com/client/T08PSQ7BQ/C06BCA5MR5Y`) * **After:** Implemented an accessible CNCF Slack joining flow starting from `https://slack.cncf.io` 2. **Improved New User Experience** * **Before:** No clear guidance on how to join or find channels * **After:** Added step-by-step joining process and organized channel directory * Replaced authentication-required links with accessible onboarding flow * Categorized channels by purpose (General, Development, SIGs) * Added channel descriptions and intended use cases * Included best practices and troubleshooting tips * Verified all listed channels exist in CNCF Slack workspace * All links tested with an unauthenticated browser (no login barriers) * Step-by-step CNCF Slack joining process validated * Channel names verified in the current CNCF Slack workspace * Documentation reviewed for style consistency **For New Contributors:** * Seamless onboarding experience from documentation to active participation * Clear guidance on channel selection based on topic **For the Community:** * Fewer questions about broken links or joining process * More organized channel usage with clear purposes **For Maintainers:** * Reduced support load for Slack access issues * More efficient contributor engagement * [x] Links accessible to new users * [x] Channel information accurate and up to date * [x] Documentation style consistent with project guidelines * [x] Commit message follows conventional format * [x] Changes tested thoroughly Signed-off-by: Abhishek Kumar <abhishekrajputji2004@gmail.com>
abhishek-8081
force-pushed
the
patch-2
branch
from
0c03389 to
e720163
Compare
|
New changes are detected. LGTM label has been removed. |
kubeedge-bot
removed
lgtm
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: fujitatomoya The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
@fujitatomoya @Shelley-BaoYue
Ready for final approval . |
4 participants
Summary
Fixes #6440 — Resolves broken Slack links and improves accessibility for new contributors joining the KubeEdge community.
Problems Solved
Broken Links Fixed
https://app.slack.com/client/T08PSQ7BQ/C06BCA5MR5Y)https://slack.cncf.ioImproved New User Experience
Changes Made
Testing Completed
Impact
For New Contributors:
For the Community:
For Maintainers:
Checklist
@rzr