docs: fix broken Slack links and improve accessibility for new users … #714#716
docs: fix broken Slack links and improve accessibility for new users … #714#716eshentials wants to merge 2 commits intokubeedge:masterfrom
Conversation
…#6440 in kubeedge repo
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
|
Welcome @eshentials! It looks like this is your first PR to kubeedge/website 🎉 |
There was a problem hiding this comment.
Summary of Changes
Hello @eshentials, 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 significantly enhances the KubeEdge community's onboarding experience by revamping the Slack documentation. It aims to reduce confusion for new contributors by providing a streamlined process for joining the CNCF Slack workspace and effectively engaging with the KubeEdge channels.
Highlights
- Slack Link Fixes: Replaced outdated and auth-restricted Slack invite links with the official CNCF Slack onboarding flow.
- Improved Onboarding: Added clear, step-by-step instructions for new users to join and navigate the KubeEdge community on CNCF Slack.
- Channel Organization: Introduced a categorized table of KubeEdge Slack channels, complete with descriptions for better clarity.
- Community Best Practices: Included essential guidelines for community participation within the Slack workspace.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request significantly improves the documentation for joining the KubeEdge Slack community. The new step-by-step instructions are much clearer for new users, and replacing the direct channel links with a guide on how to find them within the CNCF Slack workspace makes the documentation more robust against broken links. The addition of a table describing each channel's purpose is also a great enhancement for navigability. My review includes a minor suggestion to improve the Markdown formatting for better consistency and maintainability.
|
this resolves issue #714 |
|
/assign @Shelley-BaoYue |
fujitatomoya
left a comment
There was a problem hiding this comment.
i would create the PR against #714 instead of taking over that, because this PR includes the original fixes provided by #714. or at least put @abhishek-8081 as co-author.
…#6440 in kubeEdge repo
Which issue(s) this PR fixes:
Fixes #6440 in the KubeEdge main repository.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Docs update
What is the current behavior? (You can also link to an open issue here)
The Slack community page
references outdated / auth-restricted links, and lacks clear guidance on joining and navigating the CNCF Slack workspace.
What is the new behavior (if this is a feature change)?
-Updated Slack invite links to use CNCF’s official Slack onboarding flow
-Added step-by-step instructions for new contributors
-Organized channels by category with descriptions
-Included best practices for community participation
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information:
This improves new contributor onboarding by reducing confusion around Slack links and channels, while aligning with CNCF Slack workspace structure.