-
-
Notifications
You must be signed in to change notification settings - Fork 991
docs(community): update latest community documentation #4432
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(community): update latest community documentation #4432
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughDocumentation-only updates: one onboarding page switches an external GitHub link to a local CONTRIBUTING.md, and the meetings/communication guide replaces relative image paths with absolute raw GitHub URLs. No code or logic changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4432 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4432--asyncapi-website.netlify.app/ |
There was a problem hiding this 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
🧹 Nitpick comments (3)
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (3)
52-132: Avoid mutable ‘master’ raw URLs; pin images to a commit SHA or use a CDN.Linking to raw.githubusercontent.com on master risks silent drift/breakage. Prefer:
- Pin to a specific commit: https://raw.githubusercontent.com/asyncapi/community//assets/meetings/…
- Or use a CDN with caching (e.g., https://cdn.jsdelivr.net/gh/asyncapi/community@/assets/meetings/…).
This stabilizes the docs and improves cacheability.
To identify the current commit to pin, you can fetch the image’s latest commit SHA and update links accordingly.
68-81: Minor: unify image syntax for consistency.Mixed HTML
and Markdown images make widths inconsistent. Either:
- Use Markdown consistently (accept default sizing), or
- Use HTML consistently with explicit widths.
Optional, stylistic only.
52-132: Allowlisting remote image domains; optimization not configured
- next.config.mjs lacks an
images.domainsorremotePatternsentry—remote<img>tags (e.g., raw.githubusercontent.com) bypass Next.js image optimization. Addimages.domains: ['raw.githubusercontent.com'](or useremotePatterns) or host these assets locally to enable optimization.- netlify.toml defines no Content-Security-Policy header—external images load unrestricted. When you introduce CSP, include
raw.githubusercontent.comin yourimg-srcdirective.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
markdown/docs/community/000-onboarding/index.md(1 hunks)markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-11-13T20:34:18.998Z
Learnt from: bandantonio
PR: asyncapi/website#3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the `public` prefix (e.g., use `/img/avatars/...` instead of `/public/img/avatars/...`).
Applied to files:
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
| The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively. | ||
|
|
||
| > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md). | ||
| > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../../CONTRIBUTING.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Verify CONTRIBUTING.md path; current relative link likely off by one directory.
From markdown/docs/community/000-onboarding/index.md, ../../CONTRIBUTING.md resolves to markdown/docs/CONTRIBUTING.md. If CONTRIBUTING.md is at repo root or elsewhere, this link will 404. Please confirm location and adjust (e.g., ../../../CONTRIBUTING.md or an absolute site path) accordingly.
Run to locate the correct path and preview all inbound links to CONTRIBUTING.md:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Finding CONTRIBUTING files:"
fd -i 'contributing.md|CONTRIBUTING.md' -t f
echo
echo "Show current link usage in onboarding file:"
nl -ba markdown/docs/community/000-onboarding/index.md | sed -n '1,120p' | rg -n 'CONTRIBUTING\.md' -n -n -N
echo
echo "Check for a site-level Contributing page that might be preferable:"
rg -n -C2 -i 'contributing' --type md markdown | head -n 100Length of output: 129
Fix CONTRIBUTING.md link (markdown/docs/community/000-onboarding/index.md:9)
../../CONTRIBUTING.md resolves to markdown/docs/CONTRIBUTING.md (404); update to link the root CONTRIBUTING.md, e.g. /CONTRIBUTING.md or the correct relative path (../../../../CONTRIBUTING.md).
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/index.md around line 9, the
CONTRIBUTING.md link currently uses ../../CONTRIBUTING.md which resolves to
markdown/docs/CONTRIBUTING.md (404); update the link to point to the repository
root CONTRIBUTING.md (use /CONTRIBUTING.md) or correct the relative path
(../../../../CONTRIBUTING.md) so the link resolves to the root CONTRIBUTING.md.
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit