chore: add engineering onboarding documentation #21
Conversation
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> - Introduced a comprehensive guide for new developers covering essential tools, platforms, and access procedures. - Included sections on security, development tools, project management, monitoring, and design resources. - Added a separate guide for Linux Foundation platforms with setup instructions and getting started resources. This documentation aims to streamline the onboarding process and provide quick access to necessary resources for effective development. Generated with [Claude Code](https://anthropic.com/claude-code)
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds four onboarding documentation pages: a developer tools overview and three editor-specific extension/plugin guides (Cursor, Zed, Neovim). Each guide contains getting-started steps and curated extensions/plugins with IDs/repos, purposes, and usage notes. No code, APIs, or exported entities were changed. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces comprehensive onboarding documentation for Linux Foundation developers, creating structured guides to streamline the developer onboarding process and centralize essential resources.
- Adds detailed developer tools and platforms documentation covering security, development environments, monitoring, and collaboration tools
- Provides platform-specific setup instructions focused on LFX platforms with troubleshooting guidance
- Establishes documentation maintenance guidelines and best practices for new team members
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| onboarding/frontend.md | Comprehensive developer guide covering tools, platforms, environments, and onboarding procedures |
| onboarding/lf-platforms-list.md | Focused setup guide for LFX platforms with repository links and getting started resources |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
onboarding/lf-platforms-list.md
Outdated
|
|
||
| --- | ||
|
|
||
| *This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code! |
There was a problem hiding this comment.
The sentence has incomplete punctuation and unclear wording. Consider revising to: 'This guide focuses on LFX platforms and their Getting Started wikis, where developers can build their local environment and actively contribute code.'
| *This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code! | |
| *This guide focuses on LFX platforms and their Getting Started wikis, where developers can set up their local environment and actively contribute code.* |
onboarding/frontend.md
Outdated
|
|
||
| ### LFX-Engineering Onboarding Platforms List | ||
| - **Purpose**: List of LFX-related platforms along with their `Getting Started` wiki | ||
| - **URL**: [https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lf-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lf-platforms-list) |
There was a problem hiding this comment.
The URL points to a directory path that references the file being created in this PR. This creates a circular reference and the link will not work as intended. Consider linking to the actual file: lf-platforms-list.md or updating the path structure.
| - **URL**: [https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lf-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lf-platforms-list) | |
| - **URL**: [https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lf-platforms-list.md](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lf-platforms-list.md) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (7)
onboarding/lf-platforms-list.md (5)
5-10: Tighten “Getting Started” guidance and standardize escalation pathMirror the escalation path used in onboarding/frontend.md so new devs don’t bounce between docs. Recommend linking to the IT Help Center and calling out Slack as the first stop for quick questions.
Apply this diff to clarify steps and add the help link:
## 🚀 Getting Started -1. **Review each platform section** to understand what you'll be working with -2. **Request access** to needed platforms from your manager or tech lead -3. **Follow the getting started guides** linked in each section -4. **Contact your team lead** if you encounter setup issues +1. **Review each platform section** to understand what you'll be working with. +2. **Request access** to needed platforms from your manager or tech lead. +3. **Follow the Getting Started guides** linked in each section. +4. **If you get stuck**: ask in your team’s Slack channel first; for access issues use the IT Help Center: + https://jira.linuxfoundation.org/plugins/servlet/desk (sign in with your LF email).
16-20: Cross-link environments to avoid duplication (DRY) or add them hereMany readers will expect DEV/STG/PROD URLs here (they’re in onboarding/frontend.md lines 86–100). Either add an “Environments” bullet here or link to that section to keep things DRY.
Here’s a minimal cross-link approach:
### LFX-PCC (Project Control Center) - **Purpose**: Platform for managing Linux Foundation projects, meetings, and committees - **Key Repository**: [https://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - **Getting Started Guide**: [https://github.com/linuxfoundation/lfx-pcc/wiki](https://github.com/linuxfoundation/lfx-pcc/wiki) + - **Environments**: See “Platform Environments” in the Frontend Onboarding doc + (onboarding/frontend.md#-platform-environments).
23-27: Make “Need Help?” consistent and actionableMatch the org-wide support flow (Slack → manager/tech lead → IT Help Center). This avoids “manager-only” guidance that can slow people down.
## 🆘 Need Help? -- **Setup Issues**: Check the getting started wiki first. If issues persist, contact your manager or fellow developers -- **Access Problems**: Contact your manager or tech lead +- **Setup Issues**: Check the Getting Started wiki first. If issues persist, ask in your team’s Slack channel or contact a fellow developer. +- **Access Problems**: Contact your manager or tech lead, or open a ticket in the IT Help Center: + https://jira.linuxfoundation.org/plugins/servlet/desk
30-31: Polish: casing, tone, and EOF newline
- Use consistent casing for “Getting Started”.
- Drop the exclamation to keep a neutral tone in procedural docs.
- Add a trailing newline at EOF (common style, avoids some diff noise).
-*This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code! +*This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code.* +
1-3: Add “Last reviewed” metadata for freshnessDocs age fast; adding a stamped “Last reviewed” line helps teams schedule upkeep.
# Linux Foundation Platforms - Developer Setup Guide +> Last reviewed: 2025-08-21 + This guide provides setup instructions and getting started resources for key Linux Foundation platforms that developers work with directly.onboarding/frontend.md (2)
219-228: Add “Last reviewed” and owners to keep the doc currentA stamped “Last reviewed” date plus an explicit owner makes it easier to keep this live.
## 🔄 Keeping This File Updated @@ -*For questions about this documentation or updates to this document, please submit a pull request or contact the development team.* +> Doc owners: Platform Eng TLs • Last reviewed: 2025-08-21 + +*For questions about this documentation or updates to this document, please submit a pull request or contact the development team.*
49-50: Minor copy nits: standardize “manager or tech lead,” and “LF email” phrasingKeep phrasing consistent across the doc to reduce cognitive load.
-**Account Setup**: Request team access from your director or tech lead and access with your Linux Foundation email account +**Account Setup**: Request team access from your manager or tech lead; sign in with your Linux Foundation email. -**Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email account +**Account Setup**: Request invitation from your manager or tech lead; sign in with your Linux Foundation email. -**Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account +**Account Setup**: Request invitation from your manager or tech lead; sign in with your Linux Foundation email.Also applies to: 175-176, 125-126, 138-139, 147-148
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
onboarding/frontend.md(1 hunks)onboarding/lf-platforms-list.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit Inference Engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/frontend.mdonboarding/lf-platforms-list.md
🪛 LanguageTool
onboarding/frontend.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password managem...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...ity and Access Management ### 1Password - Purpose: Password management and secur...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...hentication backup - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...il account --- ## 🔧 Development Tools ### Version Control - GitHub - **Main Organiz...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...n**: https://github.com/linuxfoundation - Key Repositories: - **PCC Repository...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...linuxfoundation) - Key Repositories: - PCC Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - ITX Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...: https://github.com/linuxfoundation-it - **Engineering Artifact and Notes Repositor...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Purpose: Source code management and co...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...Source code management and collaboration - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...tegrated Development Environments (IDEs) #### Cursor - Purpose: AI-powered code e...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...ation with popular extensions and themes - Account Setup: Request team access fro...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~54-~54: There might be a mistake here.
Context: ...code editor - URL: https://zed.dev/ - What it does: - Lightning-fast perfo...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: .../](https://zed.dev/) - What it does: - Lightning-fast performance with native s...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...tning-fast performance with native speed - Real-time collaborative editing - Buil...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...peed - Real-time collaborative editing - Built-in terminal and Git integration ...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ... - Built-in terminal and Git integration - Minimalist design with powerful features...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ...Minimalist design with powerful features - Account Setup: Download and install fr...
(QB_NEW_EN)
[grammar] ~64-~64: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~65-~65: There might be a mistake here.
Context: ...xt editor - URL: https://neovim.io/ - What it does: - Highly customizable ...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...(https://neovim.io/) - What it does: - Highly customizable and extensible - P...
(QB_NEW_EN)
[grammar] ~67-~67: There might be a mistake here.
Context: ...: - Highly customizable and extensible - Powerful keyboard-driven editing - Ext...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...ble - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scrip...
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...n editing - Extensive plugin ecosystem - Lua scripting for configuration - **Acco...
(QB_NEW_EN)
[grammar] ~70-~70: There might be a mistake here.
Context: ...stem - Lua scripting for configuration - Account Setup: Install via package man...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ation is local --- ## 📈 LFX Platforms ### LFX-Engineering Onboarding Platforms List...
(QB_NEW_EN)
[grammar] ~77-~77: There might be a mistake here.
Context: ...FX-Engineering Onboarding Platforms List - Purpose: List of LFX-related platforms...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ... along with their Getting Started wiki - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~79-~79: There might be a mistake here.
Context: ...g/tree/main/onboarding/lf-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lf-platforms-list) - What to do: Review the list and follow...
(QB_NEW_EN)
[grammar] ~84-~84: There might be a mistake here.
Context: ... with --- ## 🏗️ Platform Environments ### Development Environment - Purpose: De...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...nvironments ### Development Environment - Purpose: Development environment for t...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...://pcc.dev.platform.linuxfoundation.org/](https://pcc.dev.platform.linuxfoundation.org/) - Access: All developers should have acc...
(QB_NEW_EN)
[grammar] ~91-~91: There might be a mistake here.
Context: ...uld have access ### Staging Environment - Purpose: Pre-production environment fo...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...ment for final testing before deployment - URL: [https://pcc.staging.platform.lin...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...cc.staging.platform.linuxfoundation.org/](https://pcc.staging.platform.linuxfoundation.org/) - Access: All developers should have acc...
(QB_NEW_EN)
[grammar] ~96-~96: There might be a mistake here.
Context: ... have access ### Production Environment - Purpose: Live production environment s...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ...production environment serving end users - URL: [https://projectadmin.lfx.linuxfo...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...://projectadmin.lfx.linuxfoundation.org/](https://projectadmin.lfx.linuxfoundation.org/) - Access: View-only for most developers,...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...estricted --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API ga...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...# 🗃️ API Documentation ### API Gateway - Purpose: Central API gateway for routi...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~107-~107: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~108-~108: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation - Authentication and...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...ndpoint management - API documentation - Authentication and authorization - **Acc...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ...ion - Authentication and authorization - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proje...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...ect Management & Collaboration ### Jira - Purpose: Issue tracking, project manag...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning - *...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ... - Project roadmap and release planning - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...d release planning - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...unt --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfor...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...📊 Monitoring and Analytics ### DataDog - Purpose: Application performance monit...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~133-~133: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application...
(QB_NEW_EN)
[grammar] ~134-~134: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~135-~135: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and traces for debugging - T...
(QB_NEW_EN)
[grammar] ~136-~136: There might be a mistake here.
Context: ...e - View logs and traces for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~137-~137: There might be a mistake here.
Context: ... Track infrastructure metrics and alerts - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~138-~138: There might be a mistake here.
Context: ...metrics and alerts - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ... Foundation email account ### Snowflake - Purpose: Cloud data platform for data ...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~142-~142: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~143-~143: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting - **Account Setu...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ...ence queries - Analytics and reporting - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...tics and reporting - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...--- ## Design & Planning ### Whimsical - Purpose: Visual collaboration platform...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...or wireframes, flowcharts, and mind maps - URL: [https://whimsical.com/](https://...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ... maps - URL: https://whimsical.com/ - Key Workspaces: - LFX-Datalake: ...
(QB_NEW_EN)
[grammar] ~156-~156: There might be a mistake here.
Context: ...://whimsical.com/) - Key Workspaces: - LFX-Datalake: [https://whimsical.com/l...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ....com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and w...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and wireframes - Docume...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...oes**: - Create mockups and wireframes - Document processes and workflows - Col...
(QB_NEW_EN)
[grammar] ~160-~160: There might be a mistake here.
Context: ...mes - Document processes and workflows - Collaborate on designs and architecture ...
(QB_NEW_EN)
[grammar] ~161-~161: There might be a mistake here.
Context: ... Collaborate on designs and architecture - Mind mapping and brainstorming - **Accou...
(QB_NEW_EN)
[grammar] ~162-~162: There might be a mistake here.
Context: ...cture - Mind mapping and brainstorming - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~165-~165: There might be a mistake here.
Context: ...our manager or tech lead ### Lucidchart - Organization Structure: [https://lucid...
(QB_NEW_EN)
[grammar] ~166-~166: There might be a mistake here.
Context: ...ization Structure**: https://lucid.app/ - Purpose: Visual diagramming and organi...
(QB_NEW_EN)
[grammar] ~167-~167: There might be a mistake here.
Context: ...al diagramming and organizational charts - Key Workspaces: - **Linux P&E organi...
(QB_NEW_EN)
[grammar] ~168-~168: There might be a mistake here.
Context: ...anizational charts - Key Workspaces: - Linux P&E organization: [https://lucid...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ...93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - What it does: - View company structu...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...4f81/edit?page=0_0#) - What it does: - View company structure and team organiza...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...e diagram creation - Account Setup: Request invitation from your director or tech l...
(QB_NEW_EN)
[grammar] ~179-~179: There might be a mistake here.
Context: ...t --- ## 📁 Documents & Internal Tools ### Google Workspace - Google Drive: [htt...
(QB_NEW_EN)
[grammar] ~181-~181: There might be a mistake here.
Context: ...s & Internal Tools ### Google Workspace - Google Drive: [https://drive.google.co...
(QB_NEW_EN)
[grammar] ~182-~182: There might be a mistake here.
Context: ...ogle Drive**: https://drive.google.com/ - Purpose: File storage, sharing, and co...
(QB_NEW_EN)
[grammar] ~183-~183: There might be a mistake here.
Context: ...File storage, sharing, and collaboration - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~186-~186: There might be a mistake here.
Context: ...Google Docs**: https://docs.google.com/ - Purpose: Document creation and collabo...
(QB_NEW_EN)
[grammar] ~187-~187: There might be a mistake here.
Context: ...ument creation and collaborative editing - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~190-~190: There might be a mistake here.
Context: ... Foundation email account ### LFX Tools - Individual Dashboard: [https://openpro...
(QB_NEW_EN)
[grammar] ~191-~191: There might be a mistake here.
Context: ...l Dashboard**: https://openprofile.dev/ - Purpose: Personal profile and contribu...
(QB_NEW_EN)
[grammar] ~192-~192: There might be a mistake here.
Context: ...n tracking for Linux Foundation projects - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~195-~195: There might be a mistake here.
Context: ...- Calamari: http://lfx.calamari.io/ - Purpose: Internal Linux Foundation too...
(QB_NEW_EN)
[grammar] ~196-~196: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~201-~201: There might be a mistake here.
Context: ...n email account --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~210-~210: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~219-~219: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
[grammar] ~221-~221: There might be a mistake here.
Context: ...his document should be updated whenever: - New tools are adopted by the team - URLs...
(QB_NEW_EN)
onboarding/lf-platforms-list.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...rk with directly. ## 🚀 Getting Started 1. Review each platform section to underst...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...ssues --- ## 🏗️ Development Platforms ### LFX-PCC (Project Control Center) - **Purp...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...ms ### LFX-PCC (Project Control Center) - Purpose: Platform for managing Linux F...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...ation projects, meetings, and committees - Key Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - Getting Started Guide: [https://github...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...ion/lfx-pcc/wiki) --- ## 🆘 Need Help? - Setup Issues: Check the getting started...
(QB_NEW_EN)
🪛 GitHub Check: markdown-lint
onboarding/frontend.md
[failure] 87-87: Lists should be surrounded by blank lines [Context: "- Purpose: Development env..."]
onboarding/frontend.md:87 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Purpose: Development env..."]
[failure] 86-86: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Development Environment"]
onboarding/frontend.md:86 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Development Environment"]
[failure] 78-78: Lists should be surrounded by blank lines [Context: "- Purpose: List of LFX-rel..."]
onboarding/frontend.md:78 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Purpose: List of LFX-rel..."]
[failure] 77-77: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### LFX-Engineering Onboarding Platforms List"]
onboarding/frontend.md:77 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### LFX-Engineering Onboarding Platforms List"]
[failure] 40-40: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "#### Cursor"]
onboarding/frontend.md:40 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "#### Cursor"]
[failure] 39-39: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Integrated Development Environments (IDEs)"]
onboarding/frontend.md:39 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Integrated Development Environments (IDEs)"]
[failure] 31-31: Lists should be surrounded by blank lines [Context: "- Main Organization: [http..."]
onboarding/frontend.md:31 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Main Organization: [http..."]
[failure] 30-30: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Version Control - GitHub"]
onboarding/frontend.md:30 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Version Control - GitHub"]
[failure] 17-17: Lists should be surrounded by blank lines [Context: "- Purpose: Password manage..."]
onboarding/frontend.md:17 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Purpose: Password manage..."]
[failure] 16-16: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1Password"]
onboarding/frontend.md:16 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1Password"]
🪛 GitHub Actions: Markdown Lint
onboarding/frontend.md
[error] 16-16: markdownlint: MD022 - Headings should be surrounded by blank lines. Context: '### 1Password'
🔇 Additional comments (3)
onboarding/frontend.md (3)
195-198: Prefer HTTPS for Calamari (and verify canonical URL)The Calamari link uses HTTP. If HTTPS is available (likely), switch to HTTPS to avoid mixed-content warnings and MITM risk. Please verify the canonical hostname.
-**Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +**Calamari**: [https://lfx.calamari.io/](https://lfx.calamari.io/)If HTTPS is not available on this host, note that exception in the doc and consider filing an infra ticket to enable TLS.
205-207: Unify support links and Jira hostnamesYou reference both linuxfoundation.atlassian.net (lines 119–121) and jira.linuxfoundation.org (line 206). Confirm which is canonical for helpdesk vs. project tracking and add a one-line clarifier here.
Proposed copy (adjust to match reality):
- “Use linuxfoundation.atlassian.net for project work (issues, sprints).”
- “Use jira.linuxfoundation.org → IT Help Center for access/tickets.”
1-11: Nice structure and scopeClear sectioning, actionable steps, and consistent patterns across tools. This will materially reduce onboarding time.
onboarding/frontend.md
Outdated
| ## Design & Planning | ||
|
|
||
| ### Whimsical | ||
| - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps | ||
| - **URL**: [https://whimsical.com/](https://whimsical.com/) | ||
| - **Key Workspaces**: | ||
| - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) | ||
| - **What it does**: | ||
| - Create mockups and wireframes | ||
| - Document processes and workflows | ||
| - Collaborate on designs and architecture | ||
| - Mind mapping and brainstorming | ||
| - **Account Setup**: Request invitation from your manager or tech lead | ||
|
|
||
| ### Lucidchart | ||
| - **Organization Structure**: [https://lucid.app/](https://lucid.app/) | ||
| - **Purpose**: Visual diagramming and organizational charts | ||
| - **Key Workspaces**: | ||
| - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) | ||
| - **What it does**: | ||
| - View company structure and team organization | ||
| - Create flowcharts and system diagrams | ||
| - Document processes and workflows | ||
| - Collaborative diagram creation | ||
| - **Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email account | ||
|
|
There was a problem hiding this comment.
Avoid leaking deep links to internal design docs
The Whimsical and Lucidchart deep links expose specific workspace/document IDs in a public repo. Even if access is gated, publishing direct IDs can aid enumeration and may violate internal link-sharing guidelines.
Replace deep links with the product homepages + instructions to request access, or link to an internal wiki that’s access-controlled:
### Whimsical
- **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps
- **URL**: [https://whimsical.com/](https://whimsical.com/)
-- **Key Workspaces**:
- - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X)
+- **Key Workspaces**: Ask your manager/tech lead to invite you to the appropriate Whimsical workspaces (see internal wiki for workspace names/links).
@@
### Lucidchart
-- **Organization Structure**: [https://lucid.app/](https://lucid.app/)
+- **URL**: [https://lucid.app/](https://lucid.app/)
- **Purpose**: Visual diagramming and organizational charts
-- **Key Workspaces**:
- - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#)
+- **Key Workspaces**: Ask your manager/tech lead to invite you to the “Linux P&E” Lucidchart org (see internal wiki for links).📝 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.
| ## Design & Planning | |
| ### Whimsical | |
| - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps | |
| - **URL**: [https://whimsical.com/](https://whimsical.com/) | |
| - **Key Workspaces**: | |
| - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) | |
| - **What it does**: | |
| - Create mockups and wireframes | |
| - Document processes and workflows | |
| - Collaborate on designs and architecture | |
| - Mind mapping and brainstorming | |
| - **Account Setup**: Request invitation from your manager or tech lead | |
| ### Lucidchart | |
| - **Organization Structure**: [https://lucid.app/](https://lucid.app/) | |
| - **Purpose**: Visual diagramming and organizational charts | |
| - **Key Workspaces**: | |
| - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) | |
| - **What it does**: | |
| - View company structure and team organization | |
| - Create flowcharts and system diagrams | |
| - Document processes and workflows | |
| - Collaborative diagram creation | |
| - **Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email account | |
| ## Design & Planning | |
| ### Whimsical | |
| - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps | |
| - **URL**: [https://whimsical.com/](https://whimsical.com/) | |
| - **Key Workspaces**: Ask your manager/tech lead to invite you to the appropriate Whimsical workspaces (see internal wiki for workspace names/links). | |
| - **What it does**: | |
| - Create mockups and wireframes | |
| - Document processes and workflows | |
| - Collaborate on designs and architecture | |
| - Mind mapping and brainstorming | |
| - **Account Setup**: Request invitation from your manager or tech lead | |
| ### Lucidchart | |
| - **URL**: [https://lucid.app/](https://lucid.app/) | |
| - **Purpose**: Visual diagramming and organizational charts | |
| - **Key Workspaces**: Ask your manager/tech lead to invite you to the “Linux P&E” Lucidchart org (see internal wiki for links). | |
| - **What it does**: | |
| - View company structure and team organization | |
| - Create flowcharts and system diagrams | |
| - Document processes and workflows | |
| - Collaborative diagram creation | |
| - **Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email account |
🧰 Tools
🪛 LanguageTool
[grammar] ~153-~153: There might be a mistake here.
Context: ...--- ## Design & Planning ### Whimsical - Purpose: Visual collaboration platform...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...or wireframes, flowcharts, and mind maps - URL: [https://whimsical.com/](https://...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ... maps - URL: https://whimsical.com/ - Key Workspaces: - LFX-Datalake: ...
(QB_NEW_EN)
[grammar] ~156-~156: There might be a mistake here.
Context: ...://whimsical.com/) - Key Workspaces: - LFX-Datalake: [https://whimsical.com/l...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ....com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and w...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and wireframes - Docume...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...oes**: - Create mockups and wireframes - Document processes and workflows - Col...
(QB_NEW_EN)
[grammar] ~160-~160: There might be a mistake here.
Context: ...mes - Document processes and workflows - Collaborate on designs and architecture ...
(QB_NEW_EN)
[grammar] ~161-~161: There might be a mistake here.
Context: ... Collaborate on designs and architecture - Mind mapping and brainstorming - **Accou...
(QB_NEW_EN)
[grammar] ~162-~162: There might be a mistake here.
Context: ...cture - Mind mapping and brainstorming - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~165-~165: There might be a mistake here.
Context: ...our manager or tech lead ### Lucidchart - Organization Structure: [https://lucid...
(QB_NEW_EN)
[grammar] ~166-~166: There might be a mistake here.
Context: ...ization Structure**: https://lucid.app/ - Purpose: Visual diagramming and organi...
(QB_NEW_EN)
[grammar] ~167-~167: There might be a mistake here.
Context: ...al diagramming and organizational charts - Key Workspaces: - **Linux P&E organi...
(QB_NEW_EN)
[grammar] ~168-~168: There might be a mistake here.
Context: ...anizational charts - Key Workspaces: - Linux P&E organization: [https://lucid...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ...93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - What it does: - View company structu...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...4f81/edit?page=0_0#) - What it does: - View company structure and team organiza...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...e diagram creation - Account Setup: Request invitation from your director or tech l...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In onboarding/frontend.md around lines 151 to 176, the Whimsical and Lucidchart
entries expose deep workspace/document links; remove or replace those deep links
with the product homepages (https://whimsical.com/ and https://lucid.app/) and a
short instruction to request access from the manager/tech lead or via the
internal access-controlled wiki; update the "Key Workspaces" lines to either
point to an internal wiki entry (access-controlled) or to a generic "request
access" note, and ensure no workspace/document IDs remain in the public file.
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
This is a good start. I would recommend that you focus on certain topics and dive further into flushing out information on how we can onboard folks for those tools and add it. Right now most of the information is quite generic, and what would add more value is by going into detail what the tool does and what the access protocol is.
onboarding/frontend.md
Outdated
|
|
||
| --- | ||
|
|
||
| ## 🏗️ Platform Environments |
There was a problem hiding this comment.
This is all related to PCC. If anything, it should either not be part of this documentation, or we need it for all platforms.
onboarding/frontend.md
Outdated
| - Centralized API endpoint management | ||
| - API documentation | ||
| - Authentication and authorization | ||
| - **Account Setup**: Request invitation from your manager or tech lead |
onboarding/frontend.md
Outdated
| ### Whimsical | ||
| - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps | ||
| - **URL**: [https://whimsical.com/](https://whimsical.com/) | ||
| - **Key Workspaces**: | ||
| - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) | ||
| - **What it does**: | ||
| - Create mockups and wireframes | ||
| - Document processes and workflows | ||
| - Collaborate on designs and architecture | ||
| - Mind mapping and brainstorming | ||
| - **Account Setup**: Request invitation from your manager or tech lead | ||
|
|
||
| ### Lucidchart | ||
| - **Organization Structure**: [https://lucid.app/](https://lucid.app/) | ||
| - **Purpose**: Visual diagramming and organizational charts | ||
| - **Key Workspaces**: | ||
| - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) | ||
| - **What it does**: | ||
| - View company structure and team organization | ||
| - Create flowcharts and system diagrams | ||
| - Document processes and workflows | ||
| - Collaborative diagram creation | ||
| - **Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email account |
There was a problem hiding this comment.
These are not official tools that are used by LF
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
onboarding/frontend.md (3)
77-81: Fix the self-referential directory link; point directly to the file.Current link targets a directory path; the artifact is a single file added in this PR.
### LFX-Engineering Onboarding Platforms List - **Purpose**: List of LFX-related platforms along with their `Getting Started` wiki -- **URL**: [https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list) +- **URL**: [https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lfx-platforms-list.md](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lfx-platforms-list.md) - **What to do**: Review the list and follow the guide of the platforms you need to work with
153-176: Remove deep links to internal design docs; replace with product homepages + access instructions.Avoid leaking specific workspace/document IDs in a public repo.
### Whimsical - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps - **URL**: [https://whimsical.com/](https://whimsical.com/) -- **Key Workspaces**: - - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) +- **Key Workspaces**: Ask your manager/tech lead to invite you to the appropriate Whimsical workspaces (see internal wiki for workspace names/links). - **What it does**: - Create mockups and wireframes - Document processes and workflows - Collaborate on designs and architecture - Mind mapping and brainstorming - **Account Setup**: Request invitation from your manager or tech lead @@ -### Lucidchart -- **Organization Structure**: [https://lucid.app/](https://lucid.app/) +### Lucidchart +- **URL**: [https://lucid.app/](https://lucid.app/) - **Purpose**: Visual diagramming and organizational charts -- **Key Workspaces**: - - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) +- **Key Workspaces**: Ask your manager/tech lead to invite you to the “Linux P&E” Lucidchart org (see internal wiki for links). - **What it does**: - View company structure and team organization - Create flowcharts and system diagrams - Document processes and workflows - Collaborative diagram creation - **Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email accountI can open a follow-up PR to scrub any other deep links if you’d like.
16-25: Resolve markdownlint MD022/MD032 across the document (blank lines around headings and lists).Multiple sections miss the required blank lines around headings and list blocks. Apply the following consolidated patch.
## 🔐 Security and Access Management -### 1Password +### 1Password + - **Purpose**: Password management and secure credential storage @@ ## 🔧 Development Tools -### Version Control - GitHub +### Version Control - GitHub + - **Main Organization**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) @@ -### Integrated Development Environments (IDEs) +### Integrated Development Environments (IDEs) + -#### Cursor +#### Cursor + - **Purpose**: AI-powered code editor with built-in AI assistance @@ -#### Zed +#### Zed + - **Purpose**: High-performance, collaborative code editor @@ -#### Neovim +#### Neovim + - **Purpose**: Modern, extensible terminal-based text editor @@ ## 📈 LFX Platforms -### LFX-Engineering Onboarding Platforms List +### LFX-Engineering Onboarding Platforms List + - **Purpose**: List of LFX-related platforms along with their `Getting Started` wiki @@ ## 🏗️ Platform Environments -### Development Environment +### Development Environment + - **Purpose**: Development environment for testing new features and changes @@ -### Staging Environment +### Staging Environment + - **Purpose**: Pre-production environment for final testing before deployment @@ -### Production Environment +### Production Environment + - **Purpose**: Live production environment serving end users @@ ## 🗃️ API Documentation -### API Gateway +### API Gateway + - **Purpose**: Central API gateway for routing and managing API requests @@ ## 📋 Project Management & Collaboration -### Jira +### Jira + - **Purpose**: Issue tracking, project management, and agile development workflows @@ ## 📊 Monitoring and Analytics -### DataDog +### DataDog + - **Purpose**: Application performance monitoring, logging, and infrastructure metrics @@ -### Snowflake +### Snowflake + - **Purpose**: Cloud data platform for data warehousing and analytics @@ ## Design & Planning -### Whimsical +### Whimsical + - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps @@ -### Lucidchart +### Lucidchart + - **Organization Structure**: [https://lucid.app/](https://lucid.app/) @@ ## 📁 Documents & Internal Tools -### Google Workspace +### Google Workspace + - **Google Drive**: [https://drive.google.com/](https://drive.google.com/) @@ -### LFX Tools +### LFX Tools + - **Individual Dashboard**: [https://openprofile.dev/](https://openprofile.dev/)Also applies to: 30-38, 39-41, 42-50, 51-52, 53-61, 62-63, 64-72, 75-81, 86-90, 91-95, 96-100, 105-113, 118-126, 131-139, 140-148, 151-164, 165-176, 181-189, 190-198
🧹 Nitpick comments (5)
onboarding/lfx-platforms-list.md (3)
16-20: Add a blank line after the H3 heading to satisfy markdownlint (MD022/MD032).Headings should be surrounded by blank lines; lists should be surrounded by blank lines.
### LFX-PCC (Project Control Center) +- - **Purpose**: Platform for managing Linux Foundation projects, meetings, and committees - **Key Repository**: [https://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - **Getting Started Guide**: [https://github.com/linuxfoundation/lfx-pcc/wiki](https://github.com/linuxfoundation/lfx-pcc/wiki)
23-27: Add IT Help Center link for consistency with the main guide’s “Getting Help” section.This gives a clear escalation path beyond manager/tech lead and aligns with onboarding/frontend.md.
## 🆘 Need Help? - **Setup Issues**: Check the getting started wiki first. If issues persist, contact your manager or fellow developers - **Access Problems**: Contact your manager or tech lead +- **IT Help Center**: For ticketed support, use the LF IT Help Desk at https://jira.linuxfoundation.org/plugins/servlet/desk
3-10: Cross-reference the primary onboarding guide to avoid divergence.A brief pointer helps readers understand how this focused list relates to the broader onboarding doc.
-This guide provides setup instructions and getting started resources for key Linux Foundation platforms that developers work with directly. +This guide provides setup instructions and getting started resources for key Linux Foundation platforms that developers work with directly. For the full onboarding overview (tools, environments, policies), see “Developer Tools & Platforms” (onboarding/frontend.md).onboarding/frontend.md (2)
195-197: Prefer HTTPS for Calamari if available.If the service supports TLS, update to https to avoid mixed-content and redirect issues.
-**Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +**Calamari**: [https://lfx.calamari.io/](https://lfx.calamari.io/)If HTTPS isn’t supported, consider filing a ticket to enable it or documenting why HTTP is required.
203-207: Unify Help Desk links/domains.Elsewhere we use atlassian.net; here we use jira.linuxfoundation.org. Confirm the canonical Help Center URL and standardize.
-2. **For urgent access issues**: Contact system administrators or use the [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk) +2. **For urgent access issues**: Contact system administrators or use the [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk) <!-- or the canonical atlassian.net desk if that is preferred -->Follow-up: choose one canonical URL and use it consistently in both onboarding docs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
onboarding/frontend.md(1 hunks)onboarding/lfx-platforms-list.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit Inference Engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/frontend.mdonboarding/lfx-platforms-list.md
🪛 LanguageTool
onboarding/frontend.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password managem...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...ity and Access Management ### 1Password - Purpose: Password management and secur...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...hentication backup - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...il account --- ## 🔧 Development Tools ### Version Control - GitHub - **Main Organiz...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...n**: https://github.com/linuxfoundation - Key Repositories: - **PCC Repository...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...linuxfoundation) - Key Repositories: - PCC Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - ITX Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...: https://github.com/linuxfoundation-it - **Engineering Artifact and Notes Repositor...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Purpose: Source code management and co...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...Source code management and collaboration - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...tegrated Development Environments (IDEs) #### Cursor - Purpose: AI-powered code e...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...ation with popular extensions and themes - Account Setup: Request team access fro...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~54-~54: There might be a mistake here.
Context: ...code editor - URL: https://zed.dev/ - What it does: - Lightning-fast perfo...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: .../](https://zed.dev/) - What it does: - Lightning-fast performance with native s...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...tning-fast performance with native speed - Real-time collaborative editing - Buil...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...peed - Real-time collaborative editing - Built-in terminal and Git integration ...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ... - Built-in terminal and Git integration - Minimalist design with powerful features...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ...Minimalist design with powerful features - Account Setup: Download and install fr...
(QB_NEW_EN)
[grammar] ~64-~64: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~65-~65: There might be a mistake here.
Context: ...xt editor - URL: https://neovim.io/ - What it does: - Highly customizable ...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...(https://neovim.io/) - What it does: - Highly customizable and extensible - P...
(QB_NEW_EN)
[grammar] ~67-~67: There might be a mistake here.
Context: ...: - Highly customizable and extensible - Powerful keyboard-driven editing - Ext...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...ble - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scrip...
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...n editing - Extensive plugin ecosystem - Lua scripting for configuration - **Acco...
(QB_NEW_EN)
[grammar] ~70-~70: There might be a mistake here.
Context: ...stem - Lua scripting for configuration - Account Setup: Install via package man...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ation is local --- ## 📈 LFX Platforms ### LFX-Engineering Onboarding Platforms List...
(QB_NEW_EN)
[grammar] ~77-~77: There might be a mistake here.
Context: ...FX-Engineering Onboarding Platforms List - Purpose: List of LFX-related platforms...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ... along with their Getting Started wiki - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~79-~79: There might be a mistake here.
Context: .../tree/main/onboarding/lfx-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list) - What to do: Review the list and follow...
(QB_NEW_EN)
[grammar] ~84-~84: There might be a mistake here.
Context: ... with --- ## 🏗️ Platform Environments ### Development Environment - Purpose: De...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...nvironments ### Development Environment - Purpose: Development environment for t...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...://pcc.dev.platform.linuxfoundation.org/](https://pcc.dev.platform.linuxfoundation.org/) - Access: All developers should have acc...
(QB_NEW_EN)
[grammar] ~91-~91: There might be a mistake here.
Context: ...uld have access ### Staging Environment - Purpose: Pre-production environment fo...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...ment for final testing before deployment - URL: [https://pcc.staging.platform.lin...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...cc.staging.platform.linuxfoundation.org/](https://pcc.staging.platform.linuxfoundation.org/) - Access: All developers should have acc...
(QB_NEW_EN)
[grammar] ~96-~96: There might be a mistake here.
Context: ... have access ### Production Environment - Purpose: Live production environment s...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ...production environment serving end users - URL: [https://projectadmin.lfx.linuxfo...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...://projectadmin.lfx.linuxfoundation.org/](https://projectadmin.lfx.linuxfoundation.org/) - Access: View-only for most developers,...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...estricted --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API ga...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...# 🗃️ API Documentation ### API Gateway - Purpose: Central API gateway for routi...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~107-~107: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~108-~108: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation - Authentication and...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...ndpoint management - API documentation - Authentication and authorization - **Acc...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ...ion - Authentication and authorization - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proje...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...ect Management & Collaboration ### Jira - Purpose: Issue tracking, project manag...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning - *...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ... - Project roadmap and release planning - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...d release planning - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...unt --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfor...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...📊 Monitoring and Analytics ### DataDog - Purpose: Application performance monit...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~133-~133: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application...
(QB_NEW_EN)
[grammar] ~134-~134: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~135-~135: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and traces for debugging - T...
(QB_NEW_EN)
[grammar] ~136-~136: There might be a mistake here.
Context: ...e - View logs and traces for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~137-~137: There might be a mistake here.
Context: ... Track infrastructure metrics and alerts - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~138-~138: There might be a mistake here.
Context: ...metrics and alerts - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ... Foundation email account ### Snowflake - Purpose: Cloud data platform for data ...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~142-~142: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~143-~143: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting - **Account Setu...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ...ence queries - Analytics and reporting - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...tics and reporting - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...--- ## Design & Planning ### Whimsical - Purpose: Visual collaboration platform...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...or wireframes, flowcharts, and mind maps - URL: [https://whimsical.com/](https://...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ... maps - URL: https://whimsical.com/ - Key Workspaces: - LFX-Datalake: ...
(QB_NEW_EN)
[grammar] ~156-~156: There might be a mistake here.
Context: ...://whimsical.com/) - Key Workspaces: - LFX-Datalake: [https://whimsical.com/l...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ....com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and w...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and wireframes - Docume...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...oes**: - Create mockups and wireframes - Document processes and workflows - Col...
(QB_NEW_EN)
[grammar] ~160-~160: There might be a mistake here.
Context: ...mes - Document processes and workflows - Collaborate on designs and architecture ...
(QB_NEW_EN)
[grammar] ~161-~161: There might be a mistake here.
Context: ... Collaborate on designs and architecture - Mind mapping and brainstorming - **Accou...
(QB_NEW_EN)
[grammar] ~162-~162: There might be a mistake here.
Context: ...cture - Mind mapping and brainstorming - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~165-~165: There might be a mistake here.
Context: ...our manager or tech lead ### Lucidchart - Organization Structure: [https://lucid...
(QB_NEW_EN)
[grammar] ~166-~166: There might be a mistake here.
Context: ...ization Structure**: https://lucid.app/ - Purpose: Visual diagramming and organi...
(QB_NEW_EN)
[grammar] ~167-~167: There might be a mistake here.
Context: ...al diagramming and organizational charts - Key Workspaces: - **Linux P&E organi...
(QB_NEW_EN)
[grammar] ~168-~168: There might be a mistake here.
Context: ...anizational charts - Key Workspaces: - Linux P&E organization: [https://lucid...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ...93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - What it does: - View company structu...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...4f81/edit?page=0_0#) - What it does: - View company structure and team organiza...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...e diagram creation - Account Setup: Request invitation from your director or tech l...
(QB_NEW_EN)
[grammar] ~179-~179: There might be a mistake here.
Context: ...t --- ## 📁 Documents & Internal Tools ### Google Workspace - Google Drive: [htt...
(QB_NEW_EN)
[grammar] ~181-~181: There might be a mistake here.
Context: ...s & Internal Tools ### Google Workspace - Google Drive: [https://drive.google.co...
(QB_NEW_EN)
[grammar] ~182-~182: There might be a mistake here.
Context: ...ogle Drive**: https://drive.google.com/ - Purpose: File storage, sharing, and co...
(QB_NEW_EN)
[grammar] ~183-~183: There might be a mistake here.
Context: ...File storage, sharing, and collaboration - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~186-~186: There might be a mistake here.
Context: ...Google Docs**: https://docs.google.com/ - Purpose: Document creation and collabo...
(QB_NEW_EN)
[grammar] ~187-~187: There might be a mistake here.
Context: ...ument creation and collaborative editing - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~190-~190: There might be a mistake here.
Context: ... Foundation email account ### LFX Tools - Individual Dashboard: [https://openpro...
(QB_NEW_EN)
[grammar] ~191-~191: There might be a mistake here.
Context: ...l Dashboard**: https://openprofile.dev/ - Purpose: Personal profile and contribu...
(QB_NEW_EN)
[grammar] ~192-~192: There might be a mistake here.
Context: ...n tracking for Linux Foundation projects - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~195-~195: There might be a mistake here.
Context: ...- Calamari: http://lfx.calamari.io/ - Purpose: Internal Linux Foundation too...
(QB_NEW_EN)
[grammar] ~196-~196: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~201-~201: There might be a mistake here.
Context: ...n email account --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~210-~210: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~219-~219: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
[grammar] ~221-~221: There might be a mistake here.
Context: ...his document should be updated whenever: - New tools are adopted by the team - URLs...
(QB_NEW_EN)
onboarding/lfx-platforms-list.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...rk with directly. ## 🚀 Getting Started 1. Review each platform section to underst...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...ssues --- ## 🏗️ Development Platforms ### LFX-PCC (Project Control Center) - **Purp...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...ms ### LFX-PCC (Project Control Center) - Purpose: Platform for managing Linux F...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...ation projects, meetings, and committees - Key Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - Getting Started Guide: [https://github...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...ion/lfx-pcc/wiki) --- ## 🆘 Need Help? - Setup Issues: Check the getting started...
(QB_NEW_EN)
🪛 GitHub Check: markdown-lint
onboarding/frontend.md
[failure] 87-87: Lists should be surrounded by blank lines [Context: "- Purpose: Development env..."]
onboarding/frontend.md:87 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Purpose: Development env..."]
[failure] 86-86: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Development Environment"]
onboarding/frontend.md:86 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Development Environment"]
[failure] 78-78: Lists should be surrounded by blank lines [Context: "- Purpose: List of LFX-rel..."]
onboarding/frontend.md:78 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Purpose: List of LFX-rel..."]
[failure] 77-77: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### LFX-Engineering Onboarding Platforms List"]
onboarding/frontend.md:77 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### LFX-Engineering Onboarding Platforms List"]
[failure] 40-40: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "#### Cursor"]
onboarding/frontend.md:40 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "#### Cursor"]
[failure] 39-39: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Integrated Development Environments (IDEs)"]
onboarding/frontend.md:39 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Integrated Development Environments (IDEs)"]
[failure] 31-31: Lists should be surrounded by blank lines [Context: "- Main Organization: [http..."]
onboarding/frontend.md:31 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Main Organization: [http..."]
[failure] 30-30: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Version Control - GitHub"]
onboarding/frontend.md:30 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Version Control - GitHub"]
[failure] 17-17: Lists should be surrounded by blank lines [Context: "- Purpose: Password manage..."]
onboarding/frontend.md:17 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Purpose: Password manage..."]
[failure] 16-16: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1Password"]
onboarding/frontend.md:16 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1Password"]
🪛 GitHub Actions: Markdown Lint
onboarding/frontend.md
[error] 16-16: MD022: Headings should be surrounded by blank lines. Expected: 1 blank line before heading; Actual: 0. Context: "### 1Password".
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 5
♻️ Duplicate comments (2)
onboarding/frontend.md (2)
83-83: Fix circular/directory link to the platforms listLink points to a directory, not the file created in this PR. Change to the file path.
-- **URL**: [https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list) +- **URL**: [https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lfx-platforms-list.md](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lfx-platforms-list.md)
168-176: Remove deep internal workspace links (Whimsical/Lucidchart)Publishing direct workspace/document IDs is unnecessary and may violate internal link-sharing guidelines. Link to product homepages and route access via manager/tech lead or an internal (access-controlled) wiki.
### Whimsical - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps - **URL**: [https://whimsical.com/](https://whimsical.com/) -- **Key Workspaces**: - - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) +- **Key Workspaces**: Ask your manager or tech lead to invite you to the appropriate Whimsical workspaces + (see the internal wiki for workspace names/links). @@ ### Lucidchart -- **Organization Structure**: [https://lucid.app/](https://lucid.app/) +- **URL**: [https://lucid.app/](https://lucid.app/) - **Purpose**: Visual diagramming and organizational charts -- **Key Workspaces**: - - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) +- **Key Workspaces**: Ask your manager or tech lead to invite you to the “Linux P&E” Lucidchart org + (see the internal wiki for links).Also applies to: 181-189
🧹 Nitpick comments (5)
onboarding/lfx-platforms-list.md (2)
7-11: Normalize role references for consistency (“manager or tech lead”)Step 4 says “team lead” while other sections use “manager or tech lead.” Align the phrasing.
-4. **Contact your team lead** if you encounter setup issues +4. **Contact your manager or tech lead** if you encounter setup issues
18-21: Optional: add “Access” note for the repo/wiki patternA brief “Access” hint helps new hires know whom to contact if the wiki/repo is private.
- **Getting Started Guide**: [https://github.com/linuxfoundation/lfx-pcc/wiki](https://github.com/linuxfoundation/lfx-pcc/wiki) + - **Getting Started Guide**: [https://github.com/linuxfoundation/lfx-pcc/wiki](https://github.com/linuxfoundation/lfx-pcc/wiki) + - **Access**: If you see a 404/permission error, request org/project access from your manager or tech leadonboarding/frontend.md (3)
140-140: Brand casing: “Datadog”Use the vendor’s official casing (“Datadog”) for polish.
-### DataDog +### Datadog
88-107: Scope note: PCC-specific environment URLsThis section only lists PCC environments. Either label it as “PCC Platform Environments” or add equivalents for other LFX platforms to avoid implying global coverage.
-## 🏗️ Platform Environments +## 🏗️ PCC Platform Environments
41-75: IDEs list is helpful as examples; consider a neutral framingIf these aren’t official LF tools (per prior feedback), preface the section as “commonly used editors” and avoid implying org endorsement.
-### Integrated Development Environments (IDEs) +### Integrated Development Environments (IDEs) +Note: The following editors are commonly used by engineers; choose what suits your workflow and team guidelines.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
onboarding/frontend.md(1 hunks)onboarding/lfx-platforms-list.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit Inference Engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/frontend.mdonboarding/lfx-platforms-list.md
🪛 LanguageTool
onboarding/frontend.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...hentication backup - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...il account --- ## 🔧 Development Tools ### Version Control - GitHub - **Main Organi...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...n**: https://github.com/linuxfoundation - Key Repositories: - **PCC Repository...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...linuxfoundation) - Key Repositories: - PCC Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - ITX Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...: https://github.com/linuxfoundation-it - **Engineering Artifact and Notes Repositor...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Purpose: Source code management and co...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...Source code management and collaboration - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...ation with popular extensions and themes - Account Setup: Request team access fro...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...code editor - URL: https://zed.dev/ - What it does: - Lightning-fast perfo...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: .../](https://zed.dev/) - What it does: - Lightning-fast performance with native s...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ...tning-fast performance with native speed - Real-time collaborative editing - Buil...
(QB_NEW_EN)
[grammar] ~60-~60: There might be a mistake here.
Context: ...peed - Real-time collaborative editing - Built-in terminal and Git integration ...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ... - Built-in terminal and Git integration - Minimalist design with powerful features...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ...Minimalist design with powerful features - Account Setup: Download and install fr...
(QB_NEW_EN)
[grammar] ~67-~67: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...xt editor - URL: https://neovim.io/ - What it does: - Highly customizable ...
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...(https://neovim.io/) - What it does: - Highly customizable and extensible - P...
(QB_NEW_EN)
[grammar] ~70-~70: There might be a mistake here.
Context: ...: - Highly customizable and extensible - Powerful keyboard-driven editing - Ext...
(QB_NEW_EN)
[grammar] ~71-~71: There might be a mistake here.
Context: ...ble - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scrip...
(QB_NEW_EN)
[grammar] ~72-~72: There might be a mistake here.
Context: ...n editing - Extensive plugin ecosystem - Lua scripting for configuration - **Acco...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...stem - Lua scripting for configuration - Account Setup: Install via package man...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ...ation is local --- ## 📈 LFX Platforms ### LFX-Engineering Onboarding Platforms List...
(QB_NEW_EN)
[grammar] ~82-~82: There might be a mistake here.
Context: ... along with their Getting Started wiki - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~83-~83: There might be a mistake here.
Context: .../tree/main/onboarding/lfx-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list) - What to do: Review the list and follow...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ... with --- ## 🏗️ Platform Environments ### Development Environment - Purpose: D...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...ent for testing new features and changes - URL: [https://pcc.dev.platform.linuxfo...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...://pcc.dev.platform.linuxfoundation.org/](https://pcc.dev.platform.linuxfoundation.org/) - Access: All developers should have acc...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...ment for final testing before deployment - URL: [https://pcc.staging.platform.lin...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...cc.staging.platform.linuxfoundation.org/](https://pcc.staging.platform.linuxfoundation.org/) - Access: All developers should have acc...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...production environment serving end users - URL: [https://projectadmin.lfx.linuxfo...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...://projectadmin.lfx.linuxfoundation.org/](https://projectadmin.lfx.linuxfoundation.org/) - Access: View-only for most developers,...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...estricted --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~114-~114: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~115-~115: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation - Authentication and...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...ndpoint management - API documentation - Authentication and authorization - **Acc...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ...ion - Authentication and authorization - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning - *...
(QB_NEW_EN)
[grammar] ~133-~133: There might be a mistake here.
Context: ... - Project roadmap and release planning - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~134-~134: There might be a mistake here.
Context: ...d release planning - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~138-~138: There might be a mistake here.
Context: ...unt --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~142-~142: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~143-~143: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and traces for debugging - T...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ...e - View logs and traces for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ... Track infrastructure metrics and alerts - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~148-~148: There might be a mistake here.
Context: ...metrics and alerts - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~156-~156: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting - **Account Setu...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ...ence queries - Analytics and reporting - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...tics and reporting - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~166-~166: There might be a mistake here.
Context: ...or wireframes, flowcharts, and mind maps - URL: [https://whimsical.com/](https://...
(QB_NEW_EN)
[grammar] ~167-~167: There might be a mistake here.
Context: ... maps - URL: https://whimsical.com/ - Key Workspaces: - LFX-Datalake: ...
(QB_NEW_EN)
[grammar] ~168-~168: There might be a mistake here.
Context: ...://whimsical.com/) - Key Workspaces: - LFX-Datalake: [https://whimsical.com/l...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ....com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and w...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and wireframes - Docume...
(QB_NEW_EN)
[grammar] ~171-~171: There might be a mistake here.
Context: ...oes**: - Create mockups and wireframes - Document processes and workflows - Col...
(QB_NEW_EN)
[grammar] ~172-~172: There might be a mistake here.
Context: ...mes - Document processes and workflows - Collaborate on designs and architecture ...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ... Collaborate on designs and architecture - Mind mapping and brainstorming - **Accou...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...cture - Mind mapping and brainstorming - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~179-~179: There might be a mistake here.
Context: ...ization Structure**: https://lucid.app/ - Purpose: Visual diagramming and organi...
(QB_NEW_EN)
[grammar] ~180-~180: There might be a mistake here.
Context: ...al diagramming and organizational charts - Key Workspaces: - **Linux P&E organi...
(QB_NEW_EN)
[grammar] ~181-~181: There might be a mistake here.
Context: ...anizational charts - Key Workspaces: - Linux P&E organization: [https://lucid...
(QB_NEW_EN)
[grammar] ~182-~182: There might be a mistake here.
Context: ...93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - What it does: - View company structu...
(QB_NEW_EN)
[grammar] ~183-~183: There might be a mistake here.
Context: ...4f81/edit?page=0_0#) - What it does: - View company structure and team organiza...
(QB_NEW_EN)
[grammar] ~188-~188: There might be a mistake here.
Context: ...e diagram creation - Account Setup: Request invitation from your director or tech l...
(QB_NEW_EN)
[grammar] ~192-~192: There might be a mistake here.
Context: ...t --- ## 📁 Documents & Internal Tools ### Google Workspace - Google Drive: [ht...
(QB_NEW_EN)
[grammar] ~196-~196: There might be a mistake here.
Context: ...ogle Drive**: https://drive.google.com/ - Purpose: File storage, sharing, and co...
(QB_NEW_EN)
[grammar] ~197-~197: There might be a mistake here.
Context: ...File storage, sharing, and collaboration - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~200-~200: There might be a mistake here.
Context: ...Google Docs**: https://docs.google.com/ - Purpose: Document creation and collabo...
(QB_NEW_EN)
[grammar] ~201-~201: There might be a mistake here.
Context: ...ument creation and collaborative editing - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~206-~206: There might be a mistake here.
Context: ...l Dashboard**: https://openprofile.dev/ - Purpose: Personal profile and contribu...
(QB_NEW_EN)
[grammar] ~207-~207: There might be a mistake here.
Context: ...n tracking for Linux Foundation projects - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~210-~210: There might be a mistake here.
Context: ...- Calamari: http://lfx.calamari.io/ - Purpose: Internal Linux Foundation too...
(QB_NEW_EN)
[grammar] ~211-~211: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~216-~216: There might be a mistake here.
Context: ...n email account --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~225-~225: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~234-~234: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
[grammar] ~236-~236: There might be a mistake here.
Context: ...his document should be updated whenever: - New tools are adopted by the team - URLs...
(QB_NEW_EN)
onboarding/lfx-platforms-list.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...rk with directly. ## 🚀 Getting Started 1. Review each platform section to underst...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...ssues --- ## 🏗️ Development Platforms ### LFX-PCC (Project Control Center) - **Pur...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...ation projects, meetings, and committees - Key Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - Getting Started Guide: [https://github...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...ion/lfx-pcc/wiki) --- ## 🆘 Need Help? - Setup Issues: Check the getting started...
(QB_NEW_EN)
🪛 GitHub Check: markdown-lint
onboarding/frontend.md
[failure] 243-243: Line length [Expected: 120; Actual: 131]
onboarding/frontend.md:243:121 MD013/line-length Line length [Expected: 120; Actual: 131]
[failure] 237-237: Lists should be surrounded by blank lines [Context: "- New tools are adopted by the..."]
onboarding/frontend.md:237 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- New tools are adopted by the..."]
[failure] 144-144: Trailing spaces [Expected: 0 or 2; Actual: 1]
onboarding/frontend.md:144:20 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
onboarding/lfx-platforms-list.md
[failure] 31-31: Line length [Expected: 120; Actual: 151]
onboarding/lfx-platforms-list.md:31:121 MD013/line-length Line length [Expected: 120; Actual: 151]
[failure] 3-3: Line length [Expected: 120; Actual: 139]
onboarding/lfx-platforms-list.md:3:121 MD013/line-length Line length [Expected: 120; Actual: 139]
🪛 GitHub Actions: Markdown Lint
onboarding/frontend.md
[error] 144-144: markdownlint: MD009 - Trailing spaces detected at onboarding/frontend.md:144:20.
🔇 Additional comments (1)
onboarding/frontend.md (1)
210-213: Prefer HTTPS for Calamari (if supported)If the service supports TLS, switch to https to avoid training newcomers on plaintext links. Please verify availability before changing.
-- **Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **Calamari**: [https://lfx.calamari.io/](https://lfx.calamari.io/)Would you like me to open a follow-up PR after confirming HTTPS support?
onboarding/lfx-platforms-list.md
Outdated
|
|
||
| --- | ||
|
|
||
| *This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code! |
There was a problem hiding this comment.
Fix MD013 line-length and remove stylistic backticks
The italic line exceeds 120 chars and uses code backticks around “Getting Started.” Wrap and drop backticks.
-*This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code!
+*This guide focuses on LFX platforms and their Getting Started wiki, where developers can build
+their local environment and actively contribute code!*📝 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.
| *This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code! | |
| *This guide focuses on LFX platforms and their Getting Started wiki, where developers can build | |
| their local environment and actively contribute code!* |
🧰 Tools
🪛 GitHub Check: markdown-lint
[failure] 31-31: Line length [Expected: 120; Actual: 151]
onboarding/lfx-platforms-list.md:31:121 MD013/line-length Line length [Expected: 120; Actual: 151]
🤖 Prompt for AI Agents
In onboarding/lfx-platforms-list.md around line 31, the italicized sentence is
over 120 characters and unnecessarily uses backticks around "Getting Started";
reflow the sentence to keep line length under 120 characters and remove the
code-style backticks (use plain text or italics instead), splitting into two
shorter sentences or adding a line break to comply with MD013 while preserving
the original meaning about developers building local environments and
contributing code.
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
onboarding/lfx-platforms-list.md (1)
32-34: Fix unclosed italics, remove stylistic backticks, and wrap (MD013/formatting).The line starts italics but never closes, and uses code backticks around “Getting Started”. Close the emphasis and reflow.
-*This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build -their local environment and actively contribute code! +*This guide focuses on LFX platforms and their Getting Started wiki, where developers can build +their local environment and actively contribute code!*onboarding/frontend.md (1)
220-225: Fix markdownlint MD012: remove extra blank line at EOF.The pipeline is failing due to multiple consecutive blank lines. Keep a single trailing newline only.
*For questions about this documentation or updates to this document, please submit a pull request or contact the development team.* -
♻️ Duplicate comments (4)
onboarding/lfx-platforms-list.md (1)
3-4: Wrap long intro and hyphenate “getting-started” (MD013).Reflow to stay under 120 chars and tighten wording.
-This guide provides setup instructions and getting started resources for key Linux Foundation -platforms that developers work with directly. +This guide provides setup instructions and getting-started resources for key Linux Foundation +platforms that developers use directly.onboarding/frontend.md (3)
83-85: Fix circular/incorrect link to this PR’s file and drop backticks.Linking to the directory path under /tree makes navigation awkward; point to the file under /blob and remove unnecessary backticks.
-- **Purpose**: List of LFX-related platforms along with their `Getting Started` wiki -- **URL**: [https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list) +- **Purpose**: List of LFX-related platforms along with their Getting Started wiki +- **URL**: [https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lfx-platforms-list.md](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lfx-platforms-list.md)
155-166: Remove deep link to Lucidchart document and normalize the heading key.Use the product homepage and an access note; avoid embedding org/document IDs in the public repo. Also standardize “URL” key.
-### Lucidchart - -- **Organization Structure**: [https://lucid.app/](https://lucid.app/) +### Lucidchart + +- **URL**: [https://lucid.app/](https://lucid.app/) - **Purpose**: Visual diagramming and organizational charts -- **Key Workspaces**: - - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) +- **Key Workspaces**: Ask your manager or tech lead to invite you to the Linux P&E Lucidchart + organization (see the internal, access-controlled wiki for links).
146-153: Remove deep links to internal Whimsical workspaces (avoid exposing resource IDs).Publicly exposing workspace/document IDs is unnecessary and can aid enumeration. Replace with a generic instruction to request access via internal channels.
-- **Key Workspaces**: - - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) +- **Key Workspaces**: Ask your manager or tech lead to invite you to the appropriate Whimsical + workspaces (see the internal, access-controlled wiki for workspace names and links).
🧹 Nitpick comments (5)
onboarding/lfx-platforms-list.md (1)
25-29: Consider adding a default contact channel.If a new hire doesn’t yet know their manager/lead, provide a fallback (e.g., Slack channel or IT desk link) to reduce dead-ends.
- **Access Problems**: Contact your manager or tech lead + - **Access Problems**: Contact your manager or tech lead. If unsure, open a ticket in the IT Help + Center or ask in the #onboarding Slack channel.onboarding/frontend.md (4)
188-191: Use HTTPS for Calamari if supported.If the service supports TLS, prefer https to avoid mixed-content or downgrade risks. If not, add a note that it’s internal-only and http is expected.
-- **Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **Calamari**: [https://lfx.calamari.io/](https://lfx.calamari.io/)If https is unavailable, please revert and add “(internal http endpoint)” to set expectations.
31-41: Account setup clarity for GitHub org access.Consider explicitly stating the expected GitHub handle format (if any) and that SSO must be enabled for the linuxfoundation org.
- **Account Setup**: Ensure your personal GitHub account is added to the organization + - **Account Setup**: Ensure your personal GitHub account is added to the organization and SSO is + enabled for the linuxfoundation org. If unsure, request an invite from your manager or tech lead.
81-86: Consistency: avoid backticks around “Getting Started.”Backticks suggest code; here it’s a doc label. Match style used elsewhere by using plain text or italics.
-- **Purpose**: List of LFX-related platforms along with their `Getting Started` wiki +- **Purpose**: List of LFX-related platforms along with their Getting Started wiki
194-200: Add fallback contacts for access issues.New hires may not know the right Slack channel or lead yet; include a default channel or IT desk link inline to reduce friction.
1. **For tool-specific questions**: Ask in the appropriate Slack channel or reach out to team leads -2. **For urgent access issues**: Contact system administrators or use the [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk) +2. **For urgent access issues**: Contact system administrators or use the + [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk). If you’re unsure where + to start, post in the #onboarding Slack channel.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
onboarding/frontend.md(1 hunks)onboarding/lfx-platforms-list.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/lfx-platforms-list.mdonboarding/frontend.md
🪛 LanguageTool
onboarding/lfx-platforms-list.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...arted resources for key Linux Foundation platforms that developers work with dire...
(QB_NEW_EN)
[grammar] ~6-~6: There might be a mistake here.
Context: ...rk with directly. ## 🚀 Getting Started 1. Review each platform section to underst...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ...ssues --- ## 🏗️ Development Platforms ### LFX-PCC (Project Control Center) - **Pur...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...ation projects, meetings, and committees - Key Repository: [https://github.com/li...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - Getting Started Guide: [https://github...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...ion/lfx-pcc/wiki) --- ## 🆘 Need Help? - Setup Issues: Check the getting started...
(QB_NEW_EN)
onboarding/frontend.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...hentication backup - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...il account --- ## 🔧 Development Tools ### Version Control - GitHub - **Main Organi...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...n**: https://github.com/linuxfoundation - Key Repositories: - **PCC (Project C...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...linuxfoundation) - Key Repositories: - PCC (Project Control Center): [https:/...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...tps://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - ITX: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...: https://github.com/linuxfoundation-it - LFX V2 PCC UI: [https://github.com/lin...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...github.com/linuxfoundation/lfx-v2-pcc-ui](https://github.com/linuxfoundation/lfx-v2-pcc-ui) - **Engineering Artifact and Notes Repositor...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Purpose: Source code management and co...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...Source code management and collaboration - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ation with popular extensions and themes - Account Setup: Request team access fro...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...code editor - URL: https://zed.dev/ - What it does: - Lightning-fast perfo...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: .../](https://zed.dev/) - What it does: - Lightning-fast performance with native s...
(QB_NEW_EN)
[grammar] ~60-~60: There might be a mistake here.
Context: ...tning-fast performance with native speed - Real-time collaborative editing - Buil...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...peed - Real-time collaborative editing - Built-in terminal and Git integration ...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ... - Built-in terminal and Git integration - Minimalist design with powerful features...
(QB_NEW_EN)
[grammar] ~63-~63: There might be a mistake here.
Context: ...Minimalist design with powerful features - Account Setup: Download and install fr...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...xt editor - URL: https://neovim.io/ - What it does: - Highly customizable ...
(QB_NEW_EN)
[grammar] ~70-~70: There might be a mistake here.
Context: ...(https://neovim.io/) - What it does: - Highly customizable and extensible - P...
(QB_NEW_EN)
[grammar] ~71-~71: There might be a mistake here.
Context: ...: - Highly customizable and extensible - Powerful keyboard-driven editing - Ext...
(QB_NEW_EN)
[grammar] ~72-~72: There might be a mistake here.
Context: ...ble - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scrip...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...n editing - Extensive plugin ecosystem - Lua scripting for configuration - **Acco...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...stem - Lua scripting for configuration - Account Setup: Install via package man...
(QB_NEW_EN)
[grammar] ~79-~79: There might be a mistake here.
Context: ...ation is local --- ## 📈 LFX Platforms ### LFX-Engineering Onboarding Platforms List...
(QB_NEW_EN)
[grammar] ~83-~83: There might be a mistake here.
Context: ... along with their Getting Started wiki - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~84-~84: There might be a mistake here.
Context: .../tree/main/onboarding/lfx-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lfx-platforms-list) - What to do: Review the list and follow...
(QB_NEW_EN)
[grammar] ~89-~89: There might be a mistake here.
Context: ...work with --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~94-~94: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~95-~95: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~96-~96: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation - Authentication and...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ...ndpoint management - API documentation - Authentication and authorization --- #...
(QB_NEW_EN)
[grammar] ~102-~102: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~107-~107: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~108-~108: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning - *...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ... - Project roadmap and release planning - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...d release planning - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...unt --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application ...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and traces for debugging - T...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...e - View logs and traces for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ... Track infrastructure metrics and alerts - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~126-~126: There might be a mistake here.
Context: ...metrics and alerts - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~133-~133: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~134-~134: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting - **Account Setu...
(QB_NEW_EN)
[grammar] ~135-~135: There might be a mistake here.
Context: ...ence queries - Analytics and reporting - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~136-~136: There might be a mistake here.
Context: ...tics and reporting - Account Setup: Request invitation from your manager or tech le...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ...or wireframes, flowcharts, and mind maps - URL: [https://whimsical.com/](https://...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ... maps - URL: https://whimsical.com/ - Key Workspaces: - LFX-Datalake: ...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ...://whimsical.com/) - Key Workspaces: - LFX-Datalake: [https://whimsical.com/l...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ....com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and w...
(QB_NEW_EN)
[grammar] ~148-~148: There might be a mistake here.
Context: ...1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and wireframes - Docume...
(QB_NEW_EN)
[grammar] ~149-~149: There might be a mistake here.
Context: ...oes**: - Create mockups and wireframes - Document processes and workflows - Col...
(QB_NEW_EN)
[grammar] ~150-~150: There might be a mistake here.
Context: ...mes - Document processes and workflows - Collaborate on designs and architecture ...
(QB_NEW_EN)
[grammar] ~151-~151: There might be a mistake here.
Context: ... Collaborate on designs and architecture - Mind mapping and brainstorming - **Accou...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...cture - Mind mapping and brainstorming - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ...ization Structure**: https://lucid.app/ - Purpose: Visual diagramming and organi...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...al diagramming and organizational charts - Key Workspaces: - **Linux P&E organi...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...anizational charts - Key Workspaces: - Linux P&E organization: [https://lucid...
(QB_NEW_EN)
[grammar] ~160-~160: There might be a mistake here.
Context: ...93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - What it does: - View company structu...
(QB_NEW_EN)
[grammar] ~161-~161: There might be a mistake here.
Context: ...4f81/edit?page=0_0#) - What it does: - View company structure and team organiza...
(QB_NEW_EN)
[grammar] ~166-~166: There might be a mistake here.
Context: ...e diagram creation - Account Setup: Request invitation from your director or tech l...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...t --- ## 📁 Documents & Internal Tools ### Google Workspace - Google Drive: [ht...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...ogle Drive**: https://drive.google.com/ - Purpose: File storage, sharing, and co...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...File storage, sharing, and collaboration - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~178-~178: There might be a mistake here.
Context: ...Google Docs**: https://docs.google.com/ - Purpose: Document creation and collabo...
(QB_NEW_EN)
[grammar] ~179-~179: There might be a mistake here.
Context: ...ument creation and collaborative editing - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~184-~184: There might be a mistake here.
Context: ...l Dashboard**: https://openprofile.dev/ - Purpose: Personal profile and contribu...
(QB_NEW_EN)
[grammar] ~185-~185: There might be a mistake here.
Context: ...n tracking for Linux Foundation projects - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~188-~188: There might be a mistake here.
Context: ...- Calamari: http://lfx.calamari.io/ - Purpose: Internal Linux Foundation too...
(QB_NEW_EN)
[grammar] ~189-~189: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - Account Setup: Request invitation from...
(QB_NEW_EN)
[grammar] ~194-~194: There might be a mistake here.
Context: ...n email account --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~203-~203: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~212-~212: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
[grammar] ~222-~222: There might be a mistake here.
Context: ...s document, please submit a pull request or contact the development team.*
(QB_NEW_EN)
🪛 GitHub Actions: Markdown Lint
onboarding/frontend.md
[error] 225-225: markdownlint: MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]
…orm repo Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
onboarding/developer-tools-and-platforms.md (1)
217-220: Fix markdownlint MD012 (extra blank lines) and clean up closing note.The pipeline is failing due to multiple consecutive blank lines at the end of the file. Also, the italicized closing sentence is split across two lines unnecessarily.
Apply this diff:
-*For questions about this documentation or updates to this document, please submit a pull request -or contact the development team.* - - +*For questions about this documentation or to request updates, please submit a pull request or contact the development team.*
🧹 Nitpick comments (7)
onboarding/developer-tools-and-platforms.md (7)
113-121: Use the correct product name casing: “Datadog,” not “DataDog.”Consistency with vendor branding improves searchability and polish.
Apply this diff:
-### DataDog +### Datadog
150-162: Normalize “Lucidchart” section to match the structure used elsewhere.Use a “URL” field (instead of “Organization Structure”) for consistency; keep “Key Workspaces” for specific org charts/diagrams.
Apply this diff:
### Lucidchart -**Organization Structure**: [https://lucid.app/](https://lucid.app/) +- **URL**: [https://lucid.app/](https://lucid.app/) - **Purpose**: Visual diagramming and organizational charts - **Key Workspaces**: - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - **What it does**: - View company structure and team organization - Create flowcharts and system diagrams - Document processes and workflows - Collaborative diagram creation - **Account Setup**: Access with your Linux Foundation email account
183-186: Prefer HTTPS for Calamari and minor copy tweak. Verify the endpoint supports TLS.If the service supports HTTPS, we should link to it. Also “time off” → “time-off” for consistency.
Apply this diff (and confirm the URL resolves under HTTPS):
-- **Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **Calamari**: [https://lfx.calamari.io/](https://lfx.calamari.io/) - **Purpose**: Internal Linux Foundation tool for time off tracking + - **Purpose**: Internal Linux Foundation tool for time-off trackingPlease verify HTTPS availability before merging; if HTTPS is not supported, keep HTTP and open a ticket to enable TLS.
33-36: Add explicit SSO and 2FA guidance for GitHub organization access.New hires benefit from a clear security expectation in the “Linux Foundation” GitHub entry.
Apply this diff:
- **Account Setup**: Ensure your personal GitHub account is added to the organization + - **Security**: Enable SSO and 2FA on your GitHub account per org policy
37-42: Pluralize section heading for clarity.Repository is “lfx-engineering”; the heading reads more naturally as “Artifacts.”
Apply this diff:
-### Engineering Artifact and Notes +### Engineering Artifacts and Notes
7-10: Cross-link access requests to the IT Help Center from “Getting Started.”This makes step 2 actionable without scrolling.
Apply this diff:
-2. **Request access** to all relevant platforms (see each section for account setup instructions) +2. **Request access** to all relevant platforms (see each section for account setup instructions). If anything is missing, file a ticket via the [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk).
1-6: Optional accessibility/style: reconsider emojis in headings.Some linters/screen readers struggle with emoji-prefixed headings. If accessibility is a priority, consider placing emojis after the heading text or removing them.
If you want, I can provide a quick pass diff that relocates emojis to the end of headings.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
onboarding/developer-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/developer-tools-and-platforms.md
🪛 LanguageTool
onboarding/developer-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...L**: https://github.com/linuxfoundation - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ganization --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~54-~54: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...ation with popular extensions and themes - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~63-~63: There might be a mistake here.
Context: ...code editor - URL: https://zed.dev/ - What it does: - Lightning-fast perfo...
(QB_NEW_EN)
[grammar] ~64-~64: There might be a mistake here.
Context: .../](https://zed.dev/) - What it does: - Lightning-fast performance with native s...
(QB_NEW_EN)
[grammar] ~65-~65: There might be a mistake here.
Context: ...tning-fast performance with native speed - Real-time collaborative editing - Buil...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...peed - Real-time collaborative editing - Built-in terminal and Git integration ...
(QB_NEW_EN)
[grammar] ~67-~67: There might be a mistake here.
Context: ... - Built-in terminal and Git integration - Minimalist design with powerful features...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...Minimalist design with powerful features - Account Setup: Download and install fr...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...xt editor - URL: https://neovim.io/ - What it does: - Highly customizable ...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...(https://neovim.io/) - What it does: - Highly customizable and extensible - P...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ...: - Highly customizable and extensible - Powerful keyboard-driven editing - Ext...
(QB_NEW_EN)
[grammar] ~77-~77: There might be a mistake here.
Context: ...ble - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scrip...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ...n editing - Extensive plugin ecosystem - Lua scripting for configuration - **Acco...
(QB_NEW_EN)
[grammar] ~79-~79: There might be a mistake here.
Context: ...stem - Lua scripting for configuration - Account Setup: Install via package man...
(QB_NEW_EN)
[grammar] ~84-~84: There might be a mistake here.
Context: ... is local --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~89-~89: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~90-~90: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~91-~91: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation - Authentication and...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...ndpoint management - API documentation - Authentication and authorization --- #...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~101-~101: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~102-~102: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning - *...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ... - Project roadmap and release planning - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ...unt --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~115-~115: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application ...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and traces for debugging - T...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ...e - View logs and traces for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ... Track infrastructure metrics and alerts - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~126-~126: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~127-~127: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting - **Account Setu...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...ence queries - Analytics and reporting - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~139-~139: There might be a mistake here.
Context: ...or wireframes, flowcharts, and mind maps - URL: [https://whimsical.com/](https://...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ... maps - URL: https://whimsical.com/ - Key Workspaces: - LFX-Datalake: ...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...://whimsical.com/) - Key Workspaces: - LFX-Datalake: [https://whimsical.com/l...
(QB_NEW_EN)
[grammar] ~142-~142: There might be a mistake here.
Context: ....com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and w...
(QB_NEW_EN)
[grammar] ~143-~143: There might be a mistake here.
Context: ...1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and wireframes - Docume...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ...oes**: - Create mockups and wireframes - Document processes and workflows - Col...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...mes - Document processes and workflows - Collaborate on designs and architecture ...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ... Collaborate on designs and architecture - Mind mapping and brainstorming - **Accou...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...cture - Mind mapping and brainstorming - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...ization Structure**: https://lucid.app/ - Purpose: Visual diagramming and organi...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...al diagramming and organizational charts - Key Workspaces: - **Linux P&E organi...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...anizational charts - Key Workspaces: - Linux P&E organization: [https://lucid...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ...93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - What it does: - View company structu...
(QB_NEW_EN)
[grammar] ~156-~156: There might be a mistake here.
Context: ...4f81/edit?page=0_0#) - What it does: - View company structure and team organiza...
(QB_NEW_EN)
[grammar] ~165-~165: There might be a mistake here.
Context: ...t --- ## 📁 Documents & Internal Tools ### Google Workspace - Google Drive: [ht...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ...ogle Drive**: https://drive.google.com/ - Purpose: File storage, sharing, and co...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...File storage, sharing, and collaboration - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...Google Docs**: https://docs.google.com/ - Purpose: Document creation and collabo...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...ument creation and collaborative editing - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~179-~179: There might be a mistake here.
Context: ...l Dashboard**: https://openprofile.dev/ - Purpose: Personal profile and contribu...
(QB_NEW_EN)
[grammar] ~180-~180: There might be a mistake here.
Context: ...n tracking for Linux Foundation projects - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~183-~183: There might be a mistake here.
Context: ...- Calamari: http://lfx.calamari.io/ - Purpose: Internal Linux Foundation too...
(QB_NEW_EN)
[grammar] ~184-~184: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - Account Setup: Access with your Linux ...
(QB_NEW_EN)
[grammar] ~189-~189: There might be a mistake here.
Context: ...n email account --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~198-~198: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~207-~207: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
[grammar] ~217-~217: There might be a mistake here.
Context: ...s document, please submit a pull request or contact the development team.*
(QB_NEW_EN)
🪛 GitHub Actions: Markdown Lint
onboarding/developer-tools-and-platforms.md
[error] 220-220: markdownlint MD012: Multiple consecutive blank lines (Expected: 1; Actual: 2) in onboarding/developer-tools-and-platforms.md.
🔇 Additional comments (2)
onboarding/developer-tools-and-platforms.md (2)
86-94: Clarify environment scope for the API Gateway URL and whether it’s internal.The URL appears to be a dev endpoint. If that’s intentional, call out environment scope and any prerequisites (SSO/VPN). If it’s meant as a canonical entry point, consider listing staging/prod as well or linking to an internal service catalog.
Would you like me to propose text that adds an “Environment” bullet (Dev/Staging/Prod) and an “Access” note (SSO/VPN required), once you confirm the correct endpoints?
137-149: Check visibility and sharing settings for the Whimsical workspace link.If this repository is public, ensure the Whimsical board isn’t inadvertently exposed, or replace it with instructions on where to find the board in the Whimsical workspace.
Confirm whether the linked board requires SSO; if not, we should either restrict it or move the specific link to an internal doc.
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (8)
onboarding/developer-tools-and-platforms.md (8)
151-151: Use product name “Google Sheets”Minor naming fix for consistency with Google’s nomenclature.
-#### Google Spreadsheets +#### Google Sheets
33-33: Refine “Purpose” to describe the GitHub org, not the non-profit missionKeeps the entry focused and useful for onboarding.
-- **Purpose**: Non-profit consortium dedicated to fostering the growth of Linux +- **Purpose**: Organization account hosting Linux Foundation projects, tooling, and documentation
178-181: Add Slack to Internal Tools (referenced later in “Getting Help”)Slack is referenced for help but not listed here. Add it for completeness.
## 🔦 Internal Tools +### Slack + +- **Purpose**: Team chat and cross‑org collaboration +- **Access**: Use your Linux Foundation email; ask your manager for a workspace invitation + ### Individual Dashboard
108-116: Tighten DataDog description and add a privacy note for session replaySmall wording tweak and a reminder about PII handling.
- **What it does**: - Monitor application performance and uptime - - View logs and screen recorded sessions for debugging + - View logs and session replay recordings for debugging - Track infrastructure metrics and alerts + - Be mindful of PII: follow redaction and retention policies when using session replay or logs
81-90: List staging and production API Gateway URLs (or note where to find them)Dev is listed; staging/prod endpoints and their API docs are commonly needed. If URLs are internal, at least note where they live.
Would you like me to add placeholders and a short table (env, base URL, docs URL, auth method) once you confirm the staging/prod endpoints?
37-37: Pluralize “Engineering Artifact and Notes”Minor grammar/consistency improvement.
-### Engineering Artifact and Notes +### Engineering Artifacts and Notes
1-12: Add a lightweight table of contents and “Last updated” stampImproves navigability and sets an expectation to keep the doc fresh.
# Developer Tools & Platforms + +Last updated: 2025-08-21 + +## Table of contents +- 🚀 Getting Started +- 🔐 Security and Access Management +- GitHub Repositories +- 🔧 Development Tools +- 🗃️ API Documentation +- 📋 Project Management & Collaboration +- 📊 Monitoring and Analytics +- Organization Diagram +- 📁 Documents +- 🔦 Internal Tools +- 🆘 Getting Help +- 📝 Notes for New Developers +- 🔄 Keeping This File UpdatedIf you prefer, I can generate an auto-updating ToC during CI with a markdown linter/formatter.
29-42: Normalize field labels across sectionsSome sections use “Account Setup” while others use “Account Access.” Recommend standardizing on “Access & Setup” with a consistent order: Purpose, URL, Access & Setup, What it does.
I can push a follow-up commit standardizing these labels if you agree on the wording.
Also applies to: 45-79, 81-175, 178-221
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
onboarding/developer-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/developer-tools-and-platforms.md
🪛 LanguageTool
onboarding/developer-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...L**: https://github.com/linuxfoundation - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Account Access: Ensure your personal G...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ganization --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~54-~54: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ...code editor - URL: https://zed.dev/ - What it does: - Lightning-fast perfo...
(QB_NEW_EN)
[grammar] ~63-~63: There might be a mistake here.
Context: .../](https://zed.dev/) - What it does: - Lightning-fast performance with native s...
(QB_NEW_EN)
[grammar] ~64-~64: There might be a mistake here.
Context: ...tning-fast performance with native speed - Real-time collaborative editing - Buil...
(QB_NEW_EN)
[grammar] ~65-~65: There might be a mistake here.
Context: ...peed - Real-time collaborative editing - Built-in terminal and Git integration ...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ... - Built-in terminal and Git integration - Minimalist design with powerful features...
(QB_NEW_EN)
[grammar] ~71-~71: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~72-~72: There might be a mistake here.
Context: ...xt editor - URL: https://neovim.io/ - What it does: - Highly customizable ...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...(https://neovim.io/) - What it does: - Highly customizable and extensible - P...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...: - Highly customizable and extensible - Powerful keyboard-driven editing - Ext...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ble - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scrip...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ...n editing - Extensive plugin ecosystem - Lua scripting for configuration --- ##...
(QB_NEW_EN)
[grammar] ~81-~81: There might be a mistake here.
Context: ...iguration --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~85-~85: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~87-~87: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation --- ## 📋 Project Ma...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~100-~100: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~101-~101: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning --...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...ing --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application ...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and screen recorded sessions f...
(QB_NEW_EN)
[grammar] ~114-~114: There might be a mistake here.
Context: ...d screen recorded sessions for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting --- ## Organiz...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://whimsical.com/lfx-datala...
(QB_NEW_EN)
[grammar] ~137-~137: There might be a mistake here.
Context: ...nsibilities, and reporting relationships - URL: [https://lucid.app/lucidchart/a39...
(QB_NEW_EN)
[grammar] ~142-~142: There might be a mistake here.
Context: ...81/edit?page=0_0#) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~148-~148: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~163-~163: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~168-~168: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~178-~178: There might be a mistake here.
Context: ....google.com/) --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~182-~182: There might be a mistake here.
Context: ...n tracking for Linux Foundation projects - URL: [https://openprofile.dev/](https:...
(QB_NEW_EN)
[grammar] ~187-~187: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - URL: [http://lfx.calamari.io/](http://...
(QB_NEW_EN)
[grammar] ~192-~192: There might be a mistake here.
Context: ...x.calamari.io/) --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~201-~201: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~210-~210: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
🪛 GitHub Check: markdown-lint
onboarding/developer-tools-and-platforms.md
[failure] 185-185: Multiple spaces after hash on atx style heading [Context: "### Calamari"]
onboarding/developer-tools-and-platforms.md:185:1 MD019/no-multiple-space-atx Multiple spaces after hash on atx style heading [Context: "### Calamari"]
🪛 GitHub Actions: Markdown Lint
onboarding/developer-tools-and-platforms.md
[error] 185-185: MD019/no-multiple-space-atx Multiple spaces after hash on atx style heading [Context: "### Calamari"]
🔇 Additional comments (1)
onboarding/developer-tools-and-platforms.md (1)
162-166: Rename “Google Vids” to “Google Drive” and correct the linkThe current entry mixes up the service name and URL: it’s referring to shared file storage (Google Drive), not a “Vids” product, and neither
/videosnor/videois the correct path. Please update as follows:• File onboarding/developer-tools-and-platforms.md, lines 162–166
- Change the heading and URL to the official Drive endpoint.
- (Optional) Add a fallback note about accessing Drive via the Workspace app launcher.
-#### Google Vids +#### Google Drive - **Purpose**: Linux Foundation storage of files shared with you - **URL**: [https://docs.google.com/videos](https://docs.google.com/video) + **Purpose**: Linux Foundation storage of files shared with you + **URL**: https://drive.google.com + *If you can’t resolve the direct link, open Drive from the Google Workspace app launcher (the “waffle”).*Likely an incorrect or invalid review comment.
| ### Linux Foundation | ||
|
|
||
| - **Purpose**: Non-profit consortium dedicated to fostering the growth of Linux | ||
| - **URL**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) | ||
| - **Account Setup**: Ensure your personal GitHub account is added to the organization | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add GitHub org SSO + 2FA requirements and team membership guidance
New engineers often get blocked here. Make SSO/2FA and team membership explicit for both GitHub sections.
### Linux Foundation
...
- **Account Setup**: Ensure your personal GitHub account is added to the organization
+ - Enable SSO for the linuxfoundation organization and ensure 2FA is enabled on your account
+ - Request membership in the appropriate GitHub teams for repository access
### Engineering Artifact and Notes
...
- **Account Access**: Ensure your personal GitHub account is added to the organization
+ - Enable SSO for the linuxfoundation organization and ensure 2FA is enabled on your account
+ - Join the relevant teams to receive repository permissionsAlso applies to: 37-42
🧰 Tools
🪛 LanguageTool
[grammar] ~33-~33: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...L**: https://github.com/linuxfoundation - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In onboarding/developer-tools-and-platforms.md around lines 31 to 36 (and also
apply the same changes to lines 37 to 42), the GitHub Linux Foundation section
lacks explicit instructions about org SSO, 2FA and required team membership;
update both GitHub sections to state that new hires must enable GitHub 2FA,
complete organization SSO/SSO enforcement for the org, and be added to the
relevant teams (list core/team names or placeholders), and include a short
action path: how to request team membership (who to contact or link to internal
access request form) and a link to GitHub's SSO/2FA docs or internal onboarding
page for step-by-step setup.
| - **Purpose**: Linux Foundation storage of files shared with you | ||
| - **URL**: [https://drive.google.com/](https://drive.google.com/) | ||
|
|
There was a problem hiding this comment.
Correct Google Docs URL
Linking Docs to Drive is confusing. Point to the Docs app.
-- **URL**: [https://drive.google.com/](https://drive.google.com/)
+- **URL**: [https://docs.google.com/document/](https://docs.google.com/document/)Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[grammar] ~148-~148: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In onboarding/developer-tools-and-platforms.md around lines 148 to 150, the
entry currently points to Google Drive but should reference Google Docs; update
the label to "Google Docs" (or clarify "Google Docs - cloud document editor")
and change the URL from https://drive.google.com/ to https://docs.google.com/ so
the link opens the Docs app. Ensure the Purpose line and the URL line are
consistent (e.g., "**Purpose**: Google Docs for collaborative documents" and
"**URL**: https://docs.google.com/").
| - **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) | ||
|
|
There was a problem hiding this comment.
Use HTTPS for Calamari link
Avoid plain HTTP links in documentation. Use HTTPS to prevent mixed-content and downgrade risks.
-- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/)
+- **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/)📝 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.
| - **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) | |
| - **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/) |
🤖 Prompt for AI Agents
in onboarding/developer-tools-and-platforms.md around lines 188 to 189, the
Calamari link uses http which can cause mixed-content and downgrade risks;
update the URL to use https (https://lfx.calamari.io/) in the markdown link,
verify the HTTPS endpoint is reachable, and commit the updated link text so
documentation consistently uses secure links.
There was a problem hiding this comment.
@audigregorie Thank you for addressing the security concern! Using HTTPS for the Calamari URL will help ensure secure connections and prevent potential mixed-content issues.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (5)
onboarding/developer-tools-and-platforms.md (5)
146-150: Point Google Docs to the Docs app (not Drive) and clarify purposeLinking Docs to Drive is confusing; send users directly to Docs and state its purpose.
-#### Google Docs - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://drive.google.com/](https://drive.google.com/) +#### Google Docs + +- **Purpose**: Collaborative documents (proposals, specs, runbooks) +- **URL**: [https://docs.google.com/document/](https://docs.google.com/document/)
33-36: Clarify GitHub org purpose and add SSO + 2FA + team-membership stepsReplace the purpose text and make SSO/2FA and team-membership explicit to prevent access blocks for new hires.
-**Purpose**: Non-profit consortium dedicated to fostering the growth of Linux +**Purpose**: Primary GitHub organization for Linux Foundation projects and teams - **URL**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) -- **Account Setup**: Ensure your personal GitHub account is added to the organization +- **Account Setup**: Ensure your personal GitHub account is added to the organization + - Enable SSO for the linuxfoundation organization and ensure GitHub 2FA is enabled on your account + - Request membership in the appropriate GitHub teams to receive repository access (file a request via the [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk))
39-42: Add SSO + 2FA + team-membership guidance for the engineering repoMirror the org-level access requirements here as well.
- **URL**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) -- **Account Access**: Ensure your personal GitHub account is added to the organization +- **Account Access**: Ensure your personal GitHub account is added to the organization + - Enable SSO for the linuxfoundation organization and ensure GitHub 2FA is enabled + - Join the relevant GitHub teams for this repository to receive permissions (request via the [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk))
185-185: Fix Markdown lint (MD019) — remove extra space in headerThis resolves the markdown-lint failure.
-### Calamari +### Calamari
188-189: Use HTTPS for CalamariAvoid plain HTTP to prevent downgrade/mixed-content issues.
-- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/)
🧹 Nitpick comments (5)
onboarding/developer-tools-and-platforms.md (5)
151-155: Adjust Sheets purpose to be accurateSmall clarity improvement.
-#### Google Spreadsheets - -- **Purpose**: Linux Foundation storage of files shared with you +#### Google Sheets + +- **Purpose**: Spreadsheets for planning, metrics, and analysis - **URL**: [https://docs.google.com/spreadsheets/](https://docs.google.com/spreadsheets/)
156-160: Adjust Slides purpose to be accurateAlign with app usage.
-#### Google Slides - -- **Purpose**: Linux Foundation storage of files shared with you +#### Google Slides + +- **Purpose**: Presentations and review decks - **URL**: [https://docs.google.com/presentation/](https://docs.google.com/presentation/)
171-175: Clarify Google Drive purposeDrive is storage/sharing; update purpose to reflect that.
#### Google Drive -- **Purpose**: Linux Foundation storage of files shared with you +- **Purpose**: Cloud file storage and sharing for folders, files, and permissions - **URL**: [https://drive.google.com/](https://drive.google.com/)
112-116: Add privacy/PII guidance for logs and sessions (DataDog)Document the no-secrets/no-PII rule to reduce compliance risk.
- Monitor application performance and uptime - View logs and screen recorded sessions for debugging - Track infrastructure metrics and alerts + - Do not log secrets or PII; follow LF logging and data retention policies
132-139: Add access note for org diagrams (viewer vs editor)Helps new hires request the right permissions up front.
### LFX-Datalake ... - **URL**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) +- **Access**: Request Viewer or Editor access from your manager or the diagram owner ### Linux Product & Engineering organization ... - **URL**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) +- **Access**: If you cannot view, request access in Lucid or via your manager
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
onboarding/developer-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/developer-tools-and-platforms.md
🪛 LanguageTool
onboarding/developer-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...L**: https://github.com/linuxfoundation - Account Setup: Ensure your personal Gi...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Account Access: Ensure your personal G...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ganization --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~54-~54: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ...code editor - URL: https://zed.dev/ - What it does: - Lightning-fast perfo...
(QB_NEW_EN)
[grammar] ~63-~63: There might be a mistake here.
Context: .../](https://zed.dev/) - What it does: - Lightning-fast performance with native s...
(QB_NEW_EN)
[grammar] ~64-~64: There might be a mistake here.
Context: ...tning-fast performance with native speed - Real-time collaborative editing - Buil...
(QB_NEW_EN)
[grammar] ~65-~65: There might be a mistake here.
Context: ...peed - Real-time collaborative editing - Built-in terminal and Git integration ...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ... - Built-in terminal and Git integration - Minimalist design with powerful features...
(QB_NEW_EN)
[grammar] ~71-~71: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~72-~72: There might be a mistake here.
Context: ...xt editor - URL: https://neovim.io/ - What it does: - Highly customizable ...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...(https://neovim.io/) - What it does: - Highly customizable and extensible - P...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...: - Highly customizable and extensible - Powerful keyboard-driven editing - Ext...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ble - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scrip...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ...n editing - Extensive plugin ecosystem - Lua scripting for configuration --- ##...
(QB_NEW_EN)
[grammar] ~81-~81: There might be a mistake here.
Context: ...iguration --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~85-~85: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~87-~87: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation --- ## 📋 Project Ma...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~100-~100: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~101-~101: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning --...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...ing --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application ...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and screen recorded sessions f...
(QB_NEW_EN)
[grammar] ~114-~114: There might be a mistake here.
Context: ...d screen recorded sessions for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting --- ## Organiz...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://whimsical.com/lfx-datala...
(QB_NEW_EN)
[grammar] ~137-~137: There might be a mistake here.
Context: ...nsibilities, and reporting relationships - URL: [https://lucid.app/lucidchart/a39...
(QB_NEW_EN)
[grammar] ~142-~142: There might be a mistake here.
Context: ...81/edit?page=0_0#) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~148-~148: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~163-~163: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~168-~168: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~178-~178: There might be a mistake here.
Context: ....google.com/) --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~182-~182: There might be a mistake here.
Context: ...n tracking for Linux Foundation projects - URL: [https://openprofile.dev/](https:...
(QB_NEW_EN)
[grammar] ~187-~187: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - URL: [http://lfx.calamari.io/](http://...
(QB_NEW_EN)
[grammar] ~192-~192: There might be a mistake here.
Context: ...x.calamari.io/) --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~201-~201: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~210-~210: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
🔇 Additional comments (1)
onboarding/developer-tools-and-platforms.md (1)
85-90: Confirm environment scope and add stage/prod endpoints if applicableThe URL points to a dev endpoint. If stage/prod exist, list them and note auth/VPN requirements.
Would you like me to add stage/prod URLs and an “Access” bullet (SSO/VPN/API key) once you confirm the endpoints?
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (5)
onboarding/developer-tools-and-platforms.md (5)
31-36: Add GitHub org SSO + 2FA + team membership steps (avoids common access blockers)Make these explicit so new engineers aren’t stuck after joining the org.
- **Account Access**: Ensure your personal GitHub account is added to the organization + - **Account Access**: Ensure your personal GitHub account is added to the organization + - Enable SSO for the linuxfoundation organization and ensure 2FA is enabled on your GitHub account + - Request membership in the appropriate GitHub teams for repository access (ask your manager or file an IT Help Center request)
37-42: Mirror SSO/2FA/team-membership guidance on the repo-specific sectionKeep both GitHub sections consistent to reduce confusion.
- **Account Access**: Ensure your personal GitHub account is added to the organization + - **Account Access**: Ensure your personal GitHub account is added to the organization + - Enable SSO for the linuxfoundation organization and ensure 2FA is enabled on your GitHub account + - Join the relevant GitHub teams to receive repository permissions (contact your manager or use the IT Help Center)
151-153: Point Google Docs to the Docs app, not DriveOpens the correct editor and aligns with the label.
- - **Purpose**: Linux Foundation storage of files shared with you - - **URL**: [https://drive.google.com/](https://drive.google.com/) + - **Purpose**: Create and collaborate on documents + - **URL**: [https://docs.google.com/document/](https://docs.google.com/document/)
164-168: Fix Google Vids name, purpose, and path; align text/targetCorrect app path is /video/. Clarify purpose.
-#### Google Vids - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://docs.google.com/videos](https://docs.google.com/video) +#### Google Vids (Workspace Vids) + +- **Purpose**: Create, edit, and collaborate on short internal videos +- **URL**: [https://docs.google.com/video/](https://docs.google.com/video/)
191-191: Use HTTPS for CalamariAvoids downgrade/mixed-content risks.
- - **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) + - **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/)
🧹 Nitpick comments (8)
onboarding/developer-tools-and-platforms.md (8)
69-69: Grammar/clarity: “No access required” for ZedTiny wording nit; reads better and matches Neovim recommendation.
- - **Account Access**: Requesting access not required. Download and install. + - **Account Access**: No access required. Download and install.
80-81: Fix Neovim access wordingNeovim generally requires no org access.
- - **Account Access**: Requesting access required. Download and install. + - **Account Access**: No access required. Download and install.
88-93: Consider listing all API Gateway environments and access pathNew hires often need staging/prod endpoints, auth method, and where the OpenAPI/UI lives. Suggest adding:
- Environments with URLs (Dev/Staging/Prod)
- Auth requirements (e.g., SSO, API key from 1Password, OAuth)
- Link to OpenAPI/Swagger UI if available
185-185: Tighten wording for Individual Dashboard purposeImproves readability.
- - **Purpose**: Personal profile, view your events and meetings and technical contribution and training enrollment tracking + - **Purpose**: Personal profile; view your events and meetings, technical contributions, and training enrollments
195-201: Expand “Getting Help” with explicit GitHub/org access and Slack pathsExplicit steps reduce back-and-forth for common requests.
1. **For tool-specific questions**: Ask in the appropriate Slack channel or reach out to team leads 2. **For urgent access issues**: Contact system administrators or use the [IT Help Center](https://jira.linuxfoundation.org/plugins/servlet/desk) +3. **For GitHub org/team access**: Enable SSO, ensure 2FA is on, then request team membership via the IT Help Center (include repo names) +4. **For onboarding questions**: Ask in your team’s Slack channel (e.g., #onboarding or #it-help)
33-35: Clarify “Purpose” of the GitHub org entryMake it specific to the GitHub organization to avoid ambiguity with the non-profit entity.
- - **Purpose**: Non-profit consortium dedicated to fostering the growth of Linux + - **Purpose**: GitHub organization for Linux Foundation projects and teams
109-119: PII/session-replay safeguards in DataDogYou mention “screen recorded sessions.” Ensure masking of PII, redaction of sensitive inputs, and appropriate retention. Consider linking to internal DataDog privacy settings or runbooks.
213-220: Add doc owner and review cadence to sustain accuracyRecommend listing an owning team/contact and a periodic review date. Example:
- Document owner: LFX Engineering
- Review cadence: Quarterly (Jan/Apr/Jul/Oct)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
onboarding/developer-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/developer-tools-and-platforms.md
🪛 LanguageTool
onboarding/developer-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...L**: https://github.com/linuxfoundation - Account Access: Ensure your personal G...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Account Access: Ensure your personal G...
(QB_NEW_EN)
[grammar] ~45-~45: There might be a mistake here.
Context: ...ganization --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~54-~54: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...ation with popular extensions and themes - Account Access: Request access to our ...
(QB_NEW_EN)
[grammar] ~84-~84: There might be a mistake here.
Context: ... install. --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~89-~89: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~90-~90: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~91-~91: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation --- ## 📋 Project Ma...
(QB_NEW_EN)
[grammar] ~96-~96: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~100-~100: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~101-~101: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~102-~102: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning --...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...ing --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~114-~114: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application ...
(QB_NEW_EN)
[grammar] ~115-~115: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...nitor application performance and uptime - View logs and screen recorded sessions f...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...d screen recorded sessions for debugging - Track infrastructure metrics and alerts ...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://www.snowflake.com/en/](h...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ... URL: https://www.snowflake.com/en/ - What it does: - Data storage and pro...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...w.snowflake.com/en/) - What it does: - Data storage and processing - Business...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ... does**: - Data storage and processing - Business intelligence queries - Analyt...
(QB_NEW_EN)
[grammar] ~126-~126: There might be a mistake here.
Context: ...essing - Business intelligence queries - Analytics and reporting --- ## Organiz...
(QB_NEW_EN)
[grammar] ~135-~135: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://whimsical.com/lfx-datala...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ...nsibilities, and reporting relationships - URL: [https://lucid.app/lucidchart/a39...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...81/edit?page=0_0#) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~151-~151: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~156-~156: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~161-~161: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~166-~166: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~171-~171: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~176-~176: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~181-~181: There might be a mistake here.
Context: ....google.com/) --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~190-~190: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - URL: [http://lfx.calamari.io/](http://...
(QB_NEW_EN)
[grammar] ~195-~195: There might be a mistake here.
Context: ...x.calamari.io/) --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~204-~204: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~213-~213: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
🔇 Additional comments (1)
onboarding/developer-tools-and-platforms.md (1)
1-12: Solid structure and scope — nice central hub for onboardingClear sections, consistent bullets, and actionable links make this easy to follow. Good job shipping a single authoritative doc that new hires can bookmark.
Signed-off-by: David Deal <ddeal@linuxfoundation.org>
…x-engineering into feat/engineering-wiki Added additional documentation/notes. Signed-off-by: David Deal <ddeal@linuxfoundation.org>
dealako
force-pushed
the
feat/engineering-wiki
branch
from
e3aa672 to
a092453
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (5)
onboarding/developer-tools-and-platforms.md (5)
31-38: Add explicit GitHub org SSO + 2FA + team membership steps (and clarify purpose)New hires often get stuck here. Make SSO/2FA and team membership explicit, and adjust the Purpose to describe the GitHub org rather than the foundation at large.
-### Linux Foundation - -- **Purpose**: Non-profit consortium dedicated to fostering the growth of Linux +### Linux Foundation + +- **Purpose**: Linux Foundation GitHub organization for open source projects - **URL**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) - **Account Access**: You must have your personal GitHub account added to the Linux Foundation organization. To request access, ask your manager to submit a - support ticket on your behalf. Access is managed through single sign-on (SSO). + support ticket on your behalf. Access is managed through single sign-on (SSO). + - Ensure 2FA is enabled on your GitHub account + - Enable SSO for the linuxfoundation organization (GitHub prompts you after joining) + - Request membership in the appropriate GitHub teams to receive repository permissions + - If unsure which teams to join, ask your manager or post in `#lfx-devops`
39-46: Mirror SSO + 2FA + team steps in “Engineering Artifact and Notes” sectionKeep the guidance consistent across both GitHub sections so new engineers don’t miss critical org/SSO setup.
-### Engineering Artifact and Notes +### Engineering Artifact and Notes @@ - **URL**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - **Account Access**: You must have your personal GitHub account added to the Linux Foundation organization. To request access, ask your manager to submit a - support ticket on your behalf. Access is managed through single sign-on (SSO). + support ticket on your behalf. Access is managed through single sign-on (SSO). + - Ensure GitHub 2FA is enabled + - Enable SSO for the linuxfoundation organization + - Ask for membership in the relevant GitHub teams for this repository
183-188: Point Google Docs to the Docs app (not Drive) and clarify purposeThis avoids confusion between the editor (Docs) and storage (Drive).
-#### Google Docs - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://drive.google.com/](https://drive.google.com/) +#### Google Docs + +- **Purpose**: Create and collaborate on documents +- **URL**: [https://docs.google.com/document/](https://docs.google.com/document/)
201-206: Fix Google Vids app path and align label/purposeUse /video/ path, update name and description.
-#### Google Videos - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://docs.google.com/videos](https://docs.google.com/video) +#### Google Vids (Workspace Vids) + +- **Purpose**: Create, edit, and collaborate on short internal videos +- **URL**: [https://docs.google.com/video/](https://docs.google.com/video/)
228-232: Use HTTPS for Calamari linkAvoid plain HTTP to prevent downgrade/mixed-content risks.
- **Purpose**: Internal Linux Foundation tool for contractor time off tracking -- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/)
🧹 Nitpick comments (6)
onboarding/developer-tools-and-platforms.md (6)
76-80: Fix GitHub Copilot branding and org wordingUse the correct product name and refer to the GitHub “organization” rather than “account.”
-- **Account Access**: Requesting access not required. Follow the online - documentation to download and install. Most users connect to The Linux - Foundation GitHub account to access the CoPilot AI models. +- **Account Access**: No access request required. Follow the online + documentation to download and install. Most users connect to the Linux + Foundation GitHub organization to use GitHub Copilot with organization settings.
91-94: Correct access phrasing and Copilot branding for NeovimInstallation doesn’t require org approval; Copilot wording/branding should be consistent.
-- **Account Access**: Requesting access required. Download and install. Most - users connect to The Linux Foundation GitHub account to access the CoPilot AI - models. +- **Account Access**: No org approval required to install. Most + users connect to the Linux Foundation GitHub organization to use GitHub Copilot.
124-127: Standardize product name: “Datadog”Brand spelling is “Datadog” (not “DataDog”).
-### DataDog +### Datadog @@ -- **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) +- **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/)
150-151: Typo: “wich” → “which” and tighten sentenceMinor polish in Snowflake Step 1.
- 3. Request an IT/Ops team member review the pull request in the #lfx-devops - Slack channel. They will review and merge the pull request changes wich - will trigger a deployment to the Snowflake production environment. + 3. Request an IT/Ops team member to review the pull request in the `#lfx-devops` + Slack channel. They will review and merge the changes, which + will trigger deployment to the Snowflake production environment.
189-194: Rename “Google Spreadsheets” to “Google Sheets”Use product name; purpose line can be more specific.
-#### Google Spreadsheets +#### Google Sheets @@ -- **Purpose**: Linux Foundation storage of files shared with you +- **Purpose**: Create and collaborate on spreadsheets
207-212: Clarify Google Forms purposeMake it action-oriented like other Workspace entries.
-#### Google Forms - -- **Purpose**: Linux Foundation storage of files shared with you +#### Google Forms + +- **Purpose**: Create forms, surveys, and internal questionnaires
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
onboarding/developer-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/developer-tools-and-platforms.md
🪛 LanguageTool
onboarding/developer-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...orage - URL: https://1password.com/ - What it does: - Store and share team...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...ps://1password.com/) - What it does: - Store and share team passwords, API keys...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...L**: https://github.com/linuxfoundation - Account Access: You must have your per...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...thub.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - Account Access: You must have your per...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...-on (SSO). --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...ssistance - URL: https://cursor.sh/ - What it does: - AI-powered code comp...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...(https://cursor.sh/) - What it does: - AI-powered code completion and generatio...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...I-powered code completion and generation - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ...telligent code refactoring and debugging - Natural language to code translation -...
(QB_NEW_EN)
[grammar] ~60-~60: There might be a mistake here.
Context: ... - Natural language to code translation - Integration with popular extensions and ...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...ation with popular extensions and themes - Account Access: Ask your manager to su...
(QB_NEW_EN)
[grammar] ~63-~63: There might be a mistake here.
Context: ... message in the #lfx-ai Slack channel. - Extensions: Consider installing the Ji...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ...account to access the CoPilot AI models. - Extensions: Consider installing the Ji...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ... models. --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~101-~101: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~102-~102: There might be a mistake here.
Context: ...api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - What it does: - Centralized API endp...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Centralized API endpoint management - ...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ... - Centralized API endpoint management - API documentation --- ## 📋 Project Ma...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~114-~114: There might be a mistake here.
Context: ...ps://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - What it does: - Track bugs, features...
(QB_NEW_EN)
[grammar] ~115-~115: There might be a mistake here.
Context: ...atlassian.net/jira/) - What it does: - Track bugs, features, and technical debt...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...Track bugs, features, and technical debt - Sprint planning and agile workflows - ...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ... - Sprint planning and agile workflows - Project roadmap and release planning --...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ...ing --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~126-~126: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~127-~127: There might be a mistake here.
Context: ...*: https://datadog.linuxfoundation.org/ - What it does: - Monitor application ...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...inuxfoundation.org/) - What it does: - Monitor application performance and upti...
(QB_NEW_EN)
[grammar] ~151-~151: There might be a mistake here.
Context: ...to the Snowflake production environment. - Step 2: Developer: User Account Setup ...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ...om/jnmhvwd/xpb85243/) Snowflake account. 3. Users should log in using their LF email...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ....org)) via the Google SSO option. 4. Once logged in, the user should be redir...
(QB_NEW_EN)
[grammar] ~160-~160: There might be a mistake here.
Context: ...ck to the Snowflake landing page. 5. Users should then notify the Datalake Te...
(QB_NEW_EN)
[grammar] ~163-~163: There might be a mistake here.
Context: ... the user has logged in the first time). 6. Once the Datalake Team has granted acces...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://github.com/linuxfounda...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...lows, and system dependencies - URL: [https://github.com/linuxfoundation/lfx-...
(QB_NEW_EN)
[grammar] ~179-~179: There might be a mistake here.
Context: ...rams/data-flow.md) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~185-~185: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~186-~186: There might be a mistake here.
Context: ...ou - URL: https://drive.google.com/ - Account Access: Google Workspace is ma...
(QB_NEW_EN)
[grammar] ~191-~191: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~192-~192: There might be a mistake here.
Context: ...: https://docs.google.com/spreadsheets/ - Account Access: Google Workspace is ma...
(QB_NEW_EN)
[grammar] ~197-~197: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~198-~198: There might be a mistake here.
Context: ...: https://docs.google.com/presentation/ - Account Access: Google Workspace is ma...
(QB_NEW_EN)
[grammar] ~203-~203: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~204-~204: There might be a mistake here.
Context: ...URL: https://docs.google.com/videos - Account Access: Google Workspace is ma...
(QB_NEW_EN)
[grammar] ~209-~209: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~210-~210: There might be a mistake here.
Context: ... URL: https://docs.google.com/forms - Account Access: Google Workspace is ma...
(QB_NEW_EN)
[grammar] ~215-~215: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~216-~216: There might be a mistake here.
Context: ...ou - URL: https://drive.google.com/ - Account Access: Google Workspace is ma...
(QB_NEW_EN)
[grammar] ~221-~221: There might be a mistake here.
Context: ...ign-on (SSO). --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~230-~230: There might be a mistake here.
Context: ...on tool for contractor time off tracking - URL: [http://lfx.calamari.io/](http://...
(QB_NEW_EN)
[grammar] ~235-~235: There might be a mistake here.
Context: ...x.calamari.io/) --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~244-~244: There might be a mistake here.
Context: ...sk) --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~253-~253: There might be a mistake here.
Context: ...on --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> - Replaced the existing onboarding guide with a comprehensive and updated document covering essential tools, platforms, and access procedures for new developers. - Expanded sections on security, development tools, project management, and collaboration resources. - Introduced detailed setup instructions for various code editors and their recommended extensions. - Enhanced clarity and organization to streamline the onboarding process for new team members. This update aims to provide a more effective resource for developers joining the Linux Foundation. Assisted by [Claude Code](https://anthropic.com/claude-code)
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Nitpick comments (11)
onboarding/code-editor-extensions-and-plugins/neovim.md (4)
130-131: Standardize link formatting for repositories.Earlier sections use Markdown links consistently; two repos are plain URLs. Align for consistency and readability.
Apply this diff:
-**Repository**: https://github.com/yetone/avante.nvim +**Repository**: [https://github.com/yetone/avante.nvim](https://github.com/yetone/avante.nvim) -**Repository**: https://github.com/supermaven-inc/supermaven-nvim +**Repository**: [https://github.com/supermaven-inc/supermaven-nvim](https://github.com/supermaven-inc/supermaven-nvim)Also applies to: 142-144
14-26: Add a quick-start snippet for lazy.nvim bootstrapping.The guide names a plugin manager but doesn’t show how to install it. A short code block unblocks newcomers.
Proposed insertion right after the “Plugin Manager” description:
### Plugin Manager #### lazy.nvim @@ - Performance optimization and configuration management + +Quick install (init.lua): + +```lua +local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" +if not (vim.uv or vim.loop).fs_stat(lazypath) then + vim.fn.system({ + "git", + "clone", + "--filter=blob:none", + "https://github.com/folke/lazy.nvim.git", + "--branch=stable", + lazypath, + }) +end +vim.opt.rtp:prepend(lazypath) +require("lazy").setup({ + -- add plugins here +}) +```
128-139: Note on secrets for AI plugins (avante.nvim, supermaven-nvim).Call out that API keys should be stored in 1Password and injected via env vars, not hardcoded in dotfiles.
Suggested addition at the end of each AI plugin section:
- Inline AI suggestions and code improvements + +Security tip: store any API keys in 1Password and load them via environment variables (e.g., using direnv). Never commit secrets to your dotfiles.Also applies to: 140-150
111-116: List indentation consistency.A few “What you’ll use … for” bullet lists use two-space indentation, unlike the rest of the file. Remove leading spaces to satisfy common Markdown linters and keep uniform style.
Example fix (apply pattern elsewhere as needed):
-**What you'll use lualine.nvim for**: - - Display Git branch, file status, and diagnostics information - - Show current mode, file type, and encoding details - - Customizable components for project-specific information - - Performance-optimized statusline with minimal startup impact +**What you'll use lualine.nvim for**: +- Display Git branch, file status, and diagnostics information +- Show current mode, file type, and encoding details +- Customizable components for project-specific information +- Performance-optimized statusline with minimal startup impactAlso applies to: 122-127
onboarding/code-editor-extensions-and-plugins/cursor.md (2)
63-66: Consistent backticks for Extension IDs.Some IDs aren’t wrapped in code formatting. Uniform formatting improves scan-ability.
Apply this diff:
-**Extension ID**: formulahendry.auto-close-tag +**Extension ID**: `formulahendry.auto-close-tag` -**Extension ID**: christian-kohler.path-intellisense +**Extension ID**: `christian-kohler.path-intellisense` -**Extension ID**: Vue.volar +**Extension ID**: `Vue.volar`Also applies to: 84-86, 231-233
208-216: Tautology: “YAML language support”.“L” in YAML already stands for “Language.” Shorten to “YAML support.”
-**Purpose**: YAML language support with validation and formatting +**Purpose**: YAML support with validation and formattingonboarding/development-tools-and-platforms.md (4)
147-156: Dev API gateway: add network-access note.Dev endpoints commonly require VPN/IP allowlisting. A short note preempts confusion.
- **URL**: [https://api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) + +Note: The dev environment may require VPN access or IP allowlisting. If the URL is unreachable, check your network and request access.
223-225: Grammar: “its” vs “it’s”.Use the possessive “its”.
-1. Select the account to sign into by it's identifier +1. Select the account to sign into by its identifier
363-364: Prefer HTTPS for Calamari.Use HTTPS unless there’s a strong reason not to.
-- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/)
28-37: Make “How to get access” actionable for 1Password.“Access is typically granted” is vague. Include who grants it and where to request.
Proposed replacement:
-**How to get access:** -1. Access is typically granted -2. If you cannot access, contact your team lead +**How to get access:** +1. Your manager requests access to the LF 1Password Business workspace (Group: “Engineering”). +2. You’ll receive an email invite from 1Password; accept within 7 days. +3. If you don’t receive an invite, open an IT ticket in Jira (Project: ITSD) or contact your team lead.Happy to tailor this with the exact group/project names you use.
onboarding/code-editor-extensions-and-plugins/zed.md (1)
21-27: List formatting consistency (spacing).Add a blank line before lists under “What you’ll use … for” and remove any unintended extra indentation to keep consistent with common Markdown linters.
Example tweak:
-**What you'll use Git Firefly for:** - - Advanced Git history visualization with interactive timelines +**What you'll use Git Firefly for:** + +- Advanced Git history visualization with interactive timelinesAlso applies to: 33-39, 46-52
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> - Improved formatting and organization of the onboarding guide for clarity. - Updated access instructions and setup steps for various tools, including 1Password, GitHub, Cursor, Zed, and Neovim. - Added detailed descriptions for recommended extensions and plugins across different code editors. - Ensured consistency in language and structure throughout the document. This update aims to streamline the onboarding process for new developers at the Linux Foundation.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
onboarding/development-tools-and-platforms.md (1)
70-72: Fix grammar and link targets; prior feedback still applies.
- “it’s” → “its”.
- GitHub links should point to the file (blob) not the directory (tree). This was previously flagged; updating here keeps links direct.
- 4. Set up Git configuration with your personal GitHub email: `git config --global user.email "your.email@gmail.com"` - 5. Clone your project's repository and follow it's `Getting Started` guide + 4. Set up Git configuration with your preferred GitHub email: `git config --global user.email "<your-email>"` + 5. Clone your project's repository and follow its `Getting Started` guide @@ - 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/cursor.md) + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/cursor.md) @@ - 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/zed.md) + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/zed.md) @@ - 2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/neovim.md) + 2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/neovim.md)Also applies to: 119-121, 144-145, 166-168
🧹 Nitpick comments (14)
onboarding/code-editor-extensions-and-plugins/neovim.md (4)
21-27: Normalize list formatting to satisfy markdownlint and keep consistency.Across “What you'll use … for” blocks, the top‑level bullets are indented by two spaces and are immediately adjacent to the intro sentence. Prefer bullets at column 1 and a blank line before the list (MD007, MD032), matching the style used elsewhere in the repo.
Example pattern (apply across all blocks in this file):
-**What you'll use telescope.nvim for:** - - Quick file navigation and opening - - Search through project files and content +**What you'll use telescope.nvim for:** + +- Quick file navigation and opening +- Search through project files and contentAlso applies to: 35-41, 47-53, 59-65, 71-77, 83-89, 95-101, 107-113, 119-125, 131-137, 143-149, 155-161
119-121: Make heading punctuation consistent.Here the colon sits outside the bolded phrase (“What you'll use lualine.nvim for”); elsewhere you don’t bold this line. Pick one style and apply throughout (either bold the whole label including the colon, or leave it unbolded everywhere).
-**What you'll use lualine.nvim for**: +**What you'll use lualine.nvim for:**
16-20: Add a minimal install snippet for lazy.nvim.A short, copy‑pasteable snippet reduces setup friction.
#### lazy.nvim - **Purpose**: Modern, fast plugin manager for Neovim - **Repository**: [https://github.com/folke/lazy.nvim](https://github.com/folke/lazy.nvim) + +Example setup (init.lua): + +```lua +-- bootstrap lazy.nvim +local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" +if not vim.loop.fs_stat(lazypath) then + vim.fn.system({ "git", "clone", "--filter=blob:none", + "https://github.com/folke/lazy.nvim.git", "--branch=stable", lazypath }) +end +vim.opt.rtp:prepend(lazypath) + +require("lazy").setup({ + { "nvim-treesitter/nvim-treesitter", build = ":TSUpdate" }, + { "nvim-telescope/telescope.nvim", dependencies = { "nvim-lua/plenary.nvim" } }, + "neovim/nvim-lspconfig", + "hrsh7th/nvim-cmp", +}) +```
138-149: Add a brief AI usage and privacy note.Since these plugins integrate with external AI services, include a one‑liner reminding engineers not to paste secrets/PII and to follow LF data handling policies.
#### avante.nvim ... **What you'll use avante.nvim for**: ... - Inline AI suggestions and code improvements + +> Note: Do not paste secrets, credentials, or proprietary data into AI prompts. Follow LF security and data handling policies.Also applies to: 150-161
onboarding/code-editor-extensions-and-plugins/cursor.md (2)
67-67: Wrap Extension IDs in backticks for consistency.A few “Extension ID” lines miss code formatting.
-- **Extension ID**: formulahendry.auto-close-tag +- **Extension ID**: `formulahendry.auto-close-tag` @@ -- **Extension ID**: christian-kohler.path-intellisense +- **Extension ID**: `christian-kohler.path-intellisense` @@ -- **Extension ID**: Vue.volar +- **Extension ID**: `Vue.volar`Also applies to: 90-91, 249-251
224-226: Minor wording tweak (“YAML language”).“Acronym tautology.” Prefer “YAML support” (L already means Language).
-- **Purpose**: YAML language support with validation and formatting +- **Purpose**: YAML support with validation and formattingonboarding/development-tools-and-platforms.md (5)
276-277: Quote style and closing character.Standardize straight quotes and close them.
- navigate to: Menu -> Projects -> Dashboards -> “Shared with me" + navigate to: Menu -> Projects -> Dashboards -> "Shared with me"
404-406: Prefer HTTPS for Calamari.If available, switch to HTTPS for security and consistency.
-- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/)
324-326: Clarify “Purpose” text for Google Workspace apps.Docs/Sheets/Slides/Vids are for creating/editing content; Drive is for storage/sharing. Adjusting purpose lines improves accuracy.
Suggested edits (apply per subsection):
-**Purpose**: Linux Foundation storage of files shared with you +**Purpose**: Create and collaborate on documents with your teamFor Drive:
-**Purpose**: Linux Foundation storage of files shared with you +**Purpose**: Store, organize, and share files across the organizationAlso applies to: 334-336, 345-347, 355-357, 365-367, 375-377
47-49: Reframe “Linux Foundation” purpose under GitHub Repositories.The “Purpose” here should describe the GitHub org usage (source control, collaboration), not the foundation’s mission. Consider:
-- **Purpose**: Non-profit consortium dedicated to fostering the growth of Linux +- **Purpose**: Organization GitHub hub for source control, PR reviews, issues, and documentation
309-316: Resolve TODO or track it outside the published doc.“Leaving for David Deal to update” is an internal note. Either complete this section now or open a tracking issue and remove the TODO from the doc.
Would you like me to open a GitHub issue with the missing details and assign it?
onboarding/code-editor-extensions-and-plugins/zed.md (3)
21-28: Adopt the same list formatting pattern as other editor guides.Unindent bullets to column 1 and insert a blank line before lists to align with markdownlint MD007/MD032 and the normalized style you’re applying in Cursor/Neovim docs.
Example:
-**What you'll use Git Firefly for:** - - Advanced Git history visualization with interactive timelines - - Enhanced branch management and merge conflict resolution +**What you'll use Git Firefly for:** + +- Advanced Git history visualization with interactive timelines +- Enhanced branch management and merge conflict resolutionAlso applies to: 34-41, 48-55, 60-67, 72-79, 84-91, 96-103, 108-115, 120-127, 132-139
45-47: Minor wording tweak (“HTML/SQL language”).Avoid “language” tautology:
-- **Purpose**: HTML language support with syntax highlighting and validation +- **Purpose**: HTML support with syntax highlighting and validation @@ -- **Purpose**: SQL language support for database development +- **Purpose**: SQL support for database developmentAlso applies to: 69-71
5-10: Add a one‑liner on how to install extensions in Zed.A quick pointer lowers friction for new users.
## 🚀 Getting Started ... 3. **Bookmark this page** for quick reference when setting up new development environments 😀 + +Tip: Open “Command Palette → Extensions: Browse” (or visit https://zed.dev/extensions) to install any extension listed below.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
onboarding/code-editor-extensions-and-plugins/cursor.md(1 hunks)onboarding/code-editor-extensions-and-plugins/neovim.md(1 hunks)onboarding/code-editor-extensions-and-plugins/zed.md(1 hunks)onboarding/development-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/code-editor-extensions-and-plugins/zed.mdonboarding/code-editor-extensions-and-plugins/cursor.mdonboarding/code-editor-extensions-and-plugins/neovim.mdonboarding/development-tools-and-platforms.md
🪛 LanguageTool
onboarding/code-editor-extensions-and-plugins/zed.md
[grammar] ~5-~5: There might be a mistake here.
Context: ... Zed code editor. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ...tting up new development environments 😀 --- ## 🎯 Zed Extensions ### General Extensions...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...vironments 😀 --- ## 🎯 Zed Extensions ### General Extensions #### Git Firefly - **...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...### General Extensions #### Git Firefly - Purpose: Enhanced Git workflow visuali...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...it workflow visualization and management - Extension ID: git-firefly **What yo...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...visualization with interactive timelines - Enhanced branch management and merge con...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...management and merge conflict resolution - Commit message templates and conventiona...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...emplates and conventional commit support - Git workflow automation and custom git c...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...ation and custom git command integration - Advanced diff viewing with side-by-side ...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...th side-by-side comparisons #### Emmet - Purpose: High-speed HTML and CSS codin...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...d CSS coding with abbreviation expansion - Extension ID: emmet (Built-in to Zed...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...cture creation using CSS selector syntax - CSS property abbreviation expansion for ...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...bbreviation expansion for faster styling - Lorem ipsum text generation and placehol...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ... text generation and placeholder content - Number increment/decrement operations fo...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...t/decrement operations for batch editing - Wrap with abbreviation for restructuring...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ... Workflow Specific Extensions #### HTML - Purpose: HTML language support with sy...
(QB_NEW_EN)
[style] ~45-~45: This phrase is redundant (‘L’ stands for ‘language’). Use simply “HTML”.
Context: ...ic Extensions #### HTML - Purpose: HTML language support with syntax highlighting and va...
(ACRONYM_TAUTOLOGY)
[grammar] ~45-~45: There might be a mistake here.
Context: ... with syntax highlighting and validation - Extension ID: html (Built-in to Zed)...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...ng and code completion for HTML elements - Auto-completion for HTML attributes and ...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...ompletion for HTML attributes and values - Tag matching and validation for proper H...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...and validation for proper HTML structure - Integration with CSS and JavaScript for ...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ... and JavaScript for full web development - Emmet-like abbreviation expansion for ra...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...sion for rapid HTML authoring #### TOML - Purpose: TOML configuration file suppo...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...on file support with syntax highlighting - Extension ID: toml **What you'll us...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ...ighlighting for TOML configuration files - Validation and error detection for TOML ...
(QB_NEW_EN)
[grammar] ~63-~63: There might be a mistake here.
Context: ...tion and error detection for TOML syntax - Auto-completion for common TOML structur...
(QB_NEW_EN)
[grammar] ~64-~64: There might be a mistake here.
Context: ...to-completion for common TOML structures - Support for Cargo.toml, pyproject.toml, ...
(QB_NEW_EN)
[grammar] ~65-~65: There might be a mistake here.
Context: ..., pyproject.toml, and other config files - Formatting and indentation for clean con...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ... for clean configuration files #### SQL - Purpose: SQL language support for data...
(QB_NEW_EN)
[style] ~69-~69: This phrase is redundant (‘L’ stands for ‘language’). Use simply “SQL”.
Context: ...guration files #### SQL - Purpose: SQL language support for database development - **Ex...
(ACRONYM_TAUTOLOGY)
[grammar] ~69-~69: There might be a mistake here.
Context: ...anguage support for database development - Extension ID: sql **What you'll use...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ueries across multiple database dialects - IntelliSense for SQL keywords, functions...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...eywords, functions, and database objects - Query formatting and beautification for ...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ...ing and beautification for readable code - Error detection and validation for SQL s...
(QB_NEW_EN)
[grammar] ~77-~77: There might be a mistake here.
Context: ... detection and validation for SQL syntax - Integration with database connections an...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...ons and query execution #### Dockerfile - Purpose: Docker container development ...
(QB_NEW_EN)
[grammar] ~81-~81: There might be a mistake here.
Context: ...er development and configuration support - Extension ID: dockerfile **What you...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...d validation for Dockerfile instructions - Auto-completion for Docker commands and ...
(QB_NEW_EN)
[grammar] ~87-~87: There might be a mistake here.
Context: ...n for Docker commands and best practices - Linting and security recommendations for...
(QB_NEW_EN)
[grammar] ~88-~88: There might be a mistake here.
Context: ...ity recommendations for container builds - Integration with Docker CLI for building...
(QB_NEW_EN)
[grammar] ~89-~89: There might be a mistake here.
Context: ... CLI for building and testing containers - Support for multi-stage builds and advan...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...d advanced Docker features #### Angular - Purpose: Angular framework development...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...k development with comprehensive tooling - Extension ID: angular **What you'll...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...g and IntelliSense for Angular templates - Component, service, and directive code c...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ..., service, and directive code completion - TypeScript integration with Angular-spec...
(QB_NEW_EN)
[grammar] ~100-~100: There might be a mistake here.
Context: ...gration with Angular-specific decorators - Template syntax validation and error det...
(QB_NEW_EN)
[grammar] ~101-~101: There might be a mistake here.
Context: ...te syntax validation and error detection - Integration with Angular CLI for project...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...project scaffolding and builds #### Vue - Purpose: Vue.js framework development ...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...pment with single-file component support - Extension ID: vue **What you'll use...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...ng for Vue single-file components (.vue) - Template, script, and style section Inte...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ..., script, and style section IntelliSense - Vue 3 Composition API and Options API su...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ... Composition API and Options API support - Component props and emit validation - ...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ... - Component props and emit validation - Integration with Vue CLI and Vite develo...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...nd Vite development workflows #### SCSS - Purpose: SCSS/Sass preprocessor suppor...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...sor support for advanced CSS development - Extension ID: scss **What you'll us...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ...SS/Sass variables, mixins, and functions - Auto-completion for SCSS-specific featur...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...specific features and built-in functions - Nesting validation and formatting for cl...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...ormatting for clean stylesheet structure - Color preview and picker integration for...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...icker integration for visual development - Compilation and error detection for SCSS...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...SS to CSS transformation #### Terraform - Purpose: Infrastructure as Code develo...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ... Code development with Terraform support - Extension ID: terraform **What you'...
(QB_NEW_EN)
[grammar] ~134-~134: There might be a mistake here.
Context: ... for Terraform configuration files (.tf) - IntelliSense for Terraform resources, pr...
(QB_NEW_EN)
[grammar] ~135-~135: There might be a mistake here.
Context: ...raform resources, providers, and modules - Validation and linting for Terraform bes...
(QB_NEW_EN)
[grammar] ~136-~136: There might be a mistake here.
Context: ...and linting for Terraform best practices - Integration with Terraform CLI for plan,...
(QB_NEW_EN)
[grammar] ~137-~137: There might be a mistake here.
Context: ... for plan, apply, and destroy operations - Support for Terraform workspaces and sta...
(QB_NEW_EN)
onboarding/code-editor-extensions-and-plugins/cursor.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...rsor code editor. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ...tting up new development environments 😀 --- ## 🎯 Cursor Extensions ### General Extensi...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...onments 😀 --- ## 🎯 Cursor Extensions ### General Extensions #### GitLens - **Pur...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...abilities and code history visualization - Extension ID: eamodio.gitlens **Wha...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...tic code formatting for consistent style - Extension ID: esbenp.prettier-vscode...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ... and TypeScript linting for code quality - Extension ID: dbaeumer.vscode-eslint...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...ode quality checking and error detection - Enforce team coding standards and best p...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...team coding standards and best practices - Automatic fixing of common issues and st...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...ng of common issues and style violations - Custom rule configuration for project-sp...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...utomatically rename paired HTML/XML tags - Extension ID: `formulahendry.auto-rena...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...ose**: Automatically close HTML/XML tags - Extension ID: formulahendry.auto-close...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ...ker container management and development - Extension ID: `ms-azuretools.vscode-do...
(QB_NEW_EN)
[grammar] ~90-~90: There might be a mistake here.
Context: ...ID**: christian-kohler.path-intellisense - Purpose: Autocomplete for file paths i...
(QB_NEW_EN)
[grammar] ~95-~95: There might be a mistake here.
Context: ...autocompletion for file and folder paths - Reduce typos in import statements and fi...
(QB_NEW_EN)
[grammar] ~102-~102: There might be a mistake here.
Context: ...Extension ID*: coderabbitai.coderabbit - Purpose: AI-powered code review and an...
(QB_NEW_EN)
[grammar] ~107-~107: There might be a mistake here.
Context: ...code review suggestions and improvements - Automated code quality analysis and reco...
(QB_NEW_EN)
[grammar] ~108-~108: There might be a mistake here.
Context: ...ode quality analysis and recommendations - Security vulnerability detection in your...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...ity vulnerability detection in your code - Performance optimization suggestions -...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ... - Performance optimization suggestions - Code style and best practice enforcement...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...xtensions #### Angular Language Service - Purpose: Enhanced Angular development ...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...opment with IntelliSense and diagnostics - Extension ID: Angular.ng-template *...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ... and autocompletion in Angular templates - Real-time error detection in component t...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...e error detection in component templates - Navigation between templates and compone...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...ion between templates and component code - Type checking for Angular expressions an...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...g for Angular expressions and directives - Quick fixes and refactoring support for ...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...ngular projects #### Angular Schematics - Purpose: Generate Angular code and pro...
(QB_NEW_EN)
[grammar] ~137-~137: There might be a mistake here.
Context: ...- Maintain consistent project structure across team - Integrate with Angular CLI wor...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ...workflows #### Pretty TypeScript Errors - Purpose: Improved TypeScript error mes...
(QB_NEW_EN)
[grammar] ~141-~141: There might be a mistake here.
Context: ...pt error messages with better formatting - Extension ID: `yoavbls.pretty-ts-error...
(QB_NEW_EN)
[grammar] ~151-~151: There might be a mistake here.
Context: ...messages #### Tailwind CSS IntelliSense - Purpose: Intelligent autocomplete and ...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...utocomplete and linting for Tailwind CSS - Extension ID: `bradlc.vscode-tailwindc...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ...utocomplete for Tailwind CSS class names - Hover previews showing the actual CSS pr...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...eviews showing the actual CSS properties - Linting and validation of Tailwind class...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...nting and validation of Tailwind classes - Color previews and syntax highlighting ...
(QB_NEW_EN)
[grammar] ~160-~160: There might be a mistake here.
Context: ...- Color previews and syntax highlighting - Support for custom Tailwind configuratio...
(QB_NEW_EN)
[grammar] ~163-~163: There might be a mistake here.
Context: ...figurations #### Claude Code for VSCode - Purpose: AI-powered coding assistance ...
(QB_NEW_EN)
[grammar] ~164-~164: There might be a mistake here.
Context: ...tance integrated directly in your editor - Extension ID: Anthropic.claude-dev ...
(QB_NEW_EN)
[grammar] ~169-~169: There might be a mistake here.
Context: ...-powered code completion and suggestions - Intelligent code refactoring and optimiz...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ligent code refactoring and optimization - Natural language code generation and exp...
(QB_NEW_EN)
[grammar] ~171-~171: There might be a mistake here.
Context: ...anguage code generation and explanations - Debugging assistance and error resolutio...
(QB_NEW_EN)
[grammar] ~172-~172: There might be a mistake here.
Context: ...ebugging assistance and error resolution - Code review and improvement recommendati...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...and improvement recommendations #### Go - Purpose: Official Go language support ...
(QB_NEW_EN)
[grammar] ~176-~176: There might be a mistake here.
Context: ...guage support with comprehensive tooling - Extension ID: golang.go **What you'...
(QB_NEW_EN)
[grammar] ~181-~181: There might be a mistake here.
Context: ... highlighting and code completion for Go - Integrated debugging with delve debugger...
(QB_NEW_EN)
[grammar] ~182-~182: There might be a mistake here.
Context: ...Integrated debugging with delve debugger - Automatic code formatting with gofmt on ...
(QB_NEW_EN)
[grammar] ~183-~183: There might be a mistake here.
Context: ...matic code formatting with gofmt on save - Test discovery and execution within the ...
(QB_NEW_EN)
[grammar] ~184-~184: There might be a mistake here.
Context: ...iscovery and execution within the editor - Import management and dependency resolut...
(QB_NEW_EN)
[grammar] ~185-~185: There might be a mistake here.
Context: ...ort management and dependency resolution - Integration with Go tools (go mod, go bu...
(QB_NEW_EN)
[grammar] ~188-~188: There might be a mistake here.
Context: ...od, go build, go test) #### REST Client - Purpose: Test REST APIs directly from ...
(QB_NEW_EN)
[grammar] ~192-~192: There might be a mistake here.
Context: ...ent` What you'll use REST Client for: - Send HTTP requests and view responses wi...
(QB_NEW_EN)
[grammar] ~199-~199: There might be a mistake here.
Context: ...syntax highlighting #### Thunder Client - Purpose: Lightweight REST API testing ...
(QB_NEW_EN)
[grammar] ~200-~200: There might be a mistake here.
Context: ...e**: Lightweight REST API testing client - Extension ID: `rangav.vscode-thunder-c...
(QB_NEW_EN)
[grammar] ~205-~205: There might be a mistake here.
Context: ...esting with collections and environments - Import/export Postman collections - Sc...
(QB_NEW_EN)
[grammar] ~206-~206: There might be a mistake here.
Context: ...ts - Import/export Postman collections - Scriptless testing with pre-request and ...
(QB_NEW_EN)
[grammar] ~207-~207: There might be a mistake here.
Context: ...esting with pre-request and test scripts - Response history and request organizatio...
(QB_NEW_EN)
[grammar] ~208-~208: There might be a mistake here.
Context: ...esponse history and request organization - Team collaboration with shared collectio...
(QB_NEW_EN)
[grammar] ~211-~211: There might be a mistake here.
Context: ...with shared collections #### PostgreSQL - Purpose: PostgreSQL syntax highlightin...
(QB_NEW_EN)
[grammar] ~212-~212: There might be a mistake here.
Context: ... syntax highlighting and query execution - Extension ID: `ms-ossdata.vscode-postg...
(QB_NEW_EN)
[grammar] ~217-~217: There might be a mistake here.
Context: ...highlighting for PostgreSQL-specific SQL - IntelliSense for PostgreSQL functions an...
(QB_NEW_EN)
[grammar] ~218-~218: There might be a mistake here.
Context: ...se for PostgreSQL functions and keywords - Query execution and result visualization...
(QB_NEW_EN)
[grammar] ~219-~219: There might be a mistake here.
Context: ...Query execution and result visualization - Connection management for PostgreSQL dat...
(QB_NEW_EN)
[grammar] ~220-~220: There might be a mistake here.
Context: ...tion management for PostgreSQL databases - Schema browsing and table structure view...
(QB_NEW_EN)
[grammar] ~223-~223: There might be a mistake here.
Context: ...g and table structure viewing #### YAML - Purpose: YAML language support with va...
(QB_NEW_EN)
[style] ~224-~224: This phrase is redundant (‘L’ stands for ‘language’). Use simply “YAML”.
Context: ...cture viewing #### YAML - Purpose: YAML language support with validation and formatting ...
(ACRONYM_TAUTOLOGY)
[grammar] ~224-~224: There might be a mistake here.
Context: ...e support with validation and formatting - Extension ID: redhat.vscode-yaml **...
(QB_NEW_EN)
[grammar] ~229-~229: There might be a mistake here.
Context: ...ghlighting and validation for YAML files - Schema validation for Kubernetes, Docker...
(QB_NEW_EN)
[grammar] ~230-~230: There might be a mistake here.
Context: ...ernetes, Docker Compose, and CI/CD files - Auto-completion based on YAML schemas ...
(QB_NEW_EN)
[grammar] ~231-~231: There might be a mistake here.
Context: ... - Auto-completion based on YAML schemas - Formatting and indentation correction ...
(QB_NEW_EN)
[grammar] ~232-~232: There might be a mistake here.
Context: ... - Formatting and indentation correction - Error detection and quick fixes #### Ku...
(QB_NEW_EN)
[grammar] ~235-~235: There might be a mistake here.
Context: ...tection and quick fixes #### Kubernetes - Purpose: Kubernetes cluster management...
(QB_NEW_EN)
[grammar] ~236-~236: There might be a mistake here.
Context: ...etes cluster management and YAML editing - Extension ID: `ms-kubernetes-tools.vsc...
(QB_NEW_EN)
[grammar] ~249-~249: There might be a mistake here.
Context: ... Features - Extension ID: Vue.volar - Purpose: Official Vue.js language serv...
(QB_NEW_EN)
[grammar] ~254-~254: There might be a mistake here.
Context: ...ced TypeScript support in Vue components - Better performance and accuracy than leg...
(QB_NEW_EN)
[grammar] ~255-~255: There might be a mistake here.
Context: ... and accuracy than legacy Vue extensions - Composition API and script setup syntax ...
(QB_NEW_EN)
[grammar] ~256-~256: There might be a mistake here.
Context: ...tion API and script setup syntax support - Template type checking and validation ...
(QB_NEW_EN)
[grammar] ~257-~257: There might be a mistake here.
Context: ... - Template type checking and validation - Integration with Vue 3 features and mode...
(QB_NEW_EN)
onboarding/code-editor-extensions-and-plugins/neovim.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...ovim code editor. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...tting up new development environments 😀 --- ## 🔧 Neovim Plugins ### Plugin Manager ##...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...vironments 😀 --- ## 🔧 Neovim Plugins ### Plugin Manager #### lazy.nvim - **Purpo...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...: Modern, fast plugin manager for Neovim - Repository: [https://github.com/folke/...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...loading plugins for faster startup times - Automatic plugin installation and update...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...utomatic plugin installation and updates - Dependency management between plugins ...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ... - Dependency management between plugins - Performance optimization and configurati...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...thub.com/nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Purpose: Advanced syntax highlighting ...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...or syntax highlighting for 40+ languages - Intelligent code folding and text object...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ntelligent code folding and text objects - Incremental parsing for large files - ...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ... - Incremental parsing for large files - Foundation for other advanced plugins #...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...github.com/nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Purpose: Fuzzy finder and picker for f...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...* - Quick file navigation and opening - Search through project files and content...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...tegration for branch and commit browsing - Command palette functionality #### nvim...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...https://github.com/neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) - Purpose: Easy Language Server Protocol...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...**: https://github.com/hrsh7th/nvim-cmp - Purpose: Autocompletion engine with mu...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...lligent code completion from LSP servers - Snippet expansion and management - Buf...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ers - Snippet expansion and management - Buffer and path completion - Integrati...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...anagement - Buffer and path completion - Integration with external completion sou...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...tps://github.com/lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) - Purpose: Git integration with signs, h...
(QB_NEW_EN)
[grammar] ~85-~85: There might be a mistake here.
Context: ...l Git diff indicators in the sign column - Stage and unstage hunks directly from th...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...d unstage hunks directly from the editor - Navigate through Git changes efficiently...
(QB_NEW_EN)
[grammar] ~87-~87: There might be a mistake here.
Context: ...Navigate through Git changes efficiently - Inline Git blame information #### fugit...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...: https://github.com/tpope/vim-fugitive - Purpose: Comprehensive Git wrapper for...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...m - Interactive staging and committing - Branch management and merging - Git hi...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...itting - Branch management and merging - Git history browsing and comparison ###...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...tps://github.com/nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua) - Purpose: File explorer tree for Neovim...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...or:** - Visual file system navigation - File and directory operations - Projec...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...gation - File and directory operations - Project structure overview - Integrati...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ...perations - Project structure overview - Integration with Git status indicators ...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...s://github.com/nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) - Purpose: Fast and customizable statusl...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...y**: https://github.com/mbbill/undotree - Purpose: Visual undo history tree for ...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ...*: https://github.com/yetone/avante.nvim - Purpose: AI-powered code editing and c...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...chat for code explanations and debugging - AI-assisted code refactoring and optimiz...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ...sisted code refactoring and optimization - Natural language code generation and mod...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...anguage code generation and modification - Inline AI suggestions and code improveme...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...ithub.com/supermaven-inc/supermaven-nvim - Purpose: Fast AI code completion with ...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ...powered code suggestions and completions - Context-aware code generation based on y...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...generation based on your entire codebase - Multi-language support with optimized pe...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...guage support with optimized performance - Seamless integration with existing compl...
(QB_NEW_EN)
onboarding/development-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ... 1. Install 1Password browser extension for seamless login experience 2. Accept t...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...-on (SSO). --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...on and generation for faster development - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...ode refactoring and debugging assistance - Natural language to code translation for...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...ge to code translation for complex logic - Integration with our team's extensions a...
(QB_NEW_EN)
[grammar] ~107-~107: There might be a mistake here.
Context: ...r team's extensions and coding standards - Collaborative debugging sessions with AI...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...ing-fast performance for large codebases - Real-time collaborative editing during p...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...editing during pair programming sessions - Built-in terminal integration for develo...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...al integration for development workflows - Git integration for seamless version con...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...integration for seamless version control - Minimalist interface that reduces cognit...
(QB_NEW_EN)
[grammar] ~148-~148: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...riven editing for experienced developers - Customizable development environment tai...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...nt environment tailored to your workflow - Powerful plugin ecosystem for language-s...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ...system for language-specific development - Terminal-based editing for remote develo...
(QB_NEW_EN)
[grammar] ~156-~156: There might be a mistake here.
Context: ...g for remote development and server work - Lua scripting for advanced configuration...
(QB_NEW_EN)
[grammar] ~171-~171: There might be a mistake here.
Context: ...eovim.md) --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~191-~191: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~195-~195: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~209-~209: There might be a mistake here.
Context: ...an via email 2. Accept invitation and complete account setup Setup Steps: 1. S...
(QB_NEW_EN)
[grammar] ~216-~216: There might be a mistake here.
Context: ...and understand the workflow stages 4. Install Jira mobile app for updates on the go ...
(QB_NEW_EN)
[grammar] ~220-~220: There might be a mistake here.
Context: ... go --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~224-~224: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~241-~241: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://app.snowflake.com/](http...
(QB_NEW_EN)
[grammar] ~250-~250: There might be a mistake here.
Context: ...rs and project planning - Collaborate with data team on complex analytical queries...
(QB_NEW_EN)
[grammar] ~262-~262: There might be a mistake here.
Context: ...to the Snowflake production environment. - Step 2: Developer: User Account Setup ...
(QB_NEW_EN)
[grammar] ~266-~266: There might be a mistake here.
Context: ...om/jnmhvwd/xpb85243/) Snowflake account. 3. Users should log in using their LF email...
(QB_NEW_EN)
[grammar] ~269-~269: There might be a mistake here.
Context: ....org)) via the Google SSO option. 4. Once logged in, the user should be redir...
(QB_NEW_EN)
[grammar] ~271-~271: There might be a mistake here.
Context: ...ck to the Snowflake landing page. 5. Users should then notify the Datalake Te...
(QB_NEW_EN)
[grammar] ~274-~274: There might be a mistake here.
Context: ... the user has logged in the first time). 6. Once the Datalake Team has granted acces...
(QB_NEW_EN)
[grammar] ~284-~284: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://whimsical.com/lfx-datala...
(QB_NEW_EN)
[grammar] ~287-~287: There might be a mistake here.
Context: ...-Qgy1wT6KC4RtrhCbfVQ37X) What you'll use LFX-Datalake diagram for: - Unders...
(QB_NEW_EN)
[grammar] ~297-~297: There might be a mistake here.
Context: ...cture, roles and reporting relationships - URL: [https://lucid.app/lucidchart/a39...
(QB_NEW_EN)
[grammar] ~313-~313: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~318-~318: There might be a mistake here.
Context: ...rams/data-flow.md) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~324-~324: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~330-~330: There might be a mistake here.
Context: ... documents, request sharing permissions from document owner #### Google Spreadsheet...
(QB_NEW_EN)
[grammar] ~334-~334: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~341-~341: There might be a mistake here.
Context: ... documents, request sharing permissions from spreadsheet owner #### Google Slides ...
(QB_NEW_EN)
[grammar] ~345-~345: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~351-~351: There might be a mistake here.
Context: ... documents, request sharing permissions from presentation owner #### Google Vids -...
(QB_NEW_EN)
[grammar] ~355-~355: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~361-~361: There might be a mistake here.
Context: ... documents, request sharing permissions from video owner #### Google Forms - **Pur...
(QB_NEW_EN)
[grammar] ~365-~365: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~371-~371: There might be a mistake here.
Context: ... documents, request sharing permissions from form owner #### Google Drive - **Purp...
(QB_NEW_EN)
[grammar] ~375-~375: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~384-~384: There might be a mistake here.
Context: ...sign-on (SSO) --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~404-~404: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - URL: [http://lfx.calamari.io/](http://...
(QB_NEW_EN)
[style] ~410-~410: ‘off balance’ might be wordy. Consider a shorter alternative.
Context: ..., and other time off - View your time off balance and accrual rates - Submit time off r...
(EN_WORDINESS_PREMIUM_OFF_BALANCE)
[grammar] ~418-~418: There might be a mistake here.
Context: ...ri via email 2. Accept invitation and complete account setup --- ## 🆘 Getting Help ...
(QB_NEW_EN)
[grammar] ~422-~422: There might be a mistake here.
Context: ...e account setup --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~431-~431: There might be a mistake here.
Context: ...nce --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~442-~442: There might be a mistake here.
Context: ...es --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
🪛 GitHub Check: markdown-lint
onboarding/code-editor-extensions-and-plugins/cursor.md
[failure] 49-49: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:49:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 48-48: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:48:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 39-39: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:39:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 38-38: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:38:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 37-37: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:37:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 28-28: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:28:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 27-27: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:27:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 26-26: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:26:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 25-25: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:25:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
[failure] 24-24: Unordered list indentation [Expected: 0; Actual: 2]
onboarding/code-editor-extensions-and-plugins/cursor.md:24:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
🪛 GitHub Actions: Markdown Lint
onboarding/code-editor-extensions-and-plugins/cursor.md
[error] 24-24: markdownlint: MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
🔇 Additional comments (1)
onboarding/development-tools-and-platforms.md (1)
136-139: Verify references to GitHub Copilot availability in Zed/Neovim sections.Statements about connecting to the LF GitHub account “to access the Copilot AI models” may not apply to Zed/Neovim as they have distinct AI integrations and licensing constraints. Please confirm accuracy or reword to avoid implying official Copilot support in those editors.
Also applies to: 161-163
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (3)
onboarding/development-tools-and-platforms.md (3)
69-70: Grammar: “it’s” → “its”; generalize the email example.Minor polish plus a privacy-friendly placeholder (consider GitHub “noreply”).
- 4. Set up Git configuration with your personal GitHub email: `git config --global user.email "your.email@gmail.com"` - 5. Clone your project's repository and follow it's `Getting Started` guide + 4. Set up Git configuration with your preferred GitHub email: `git config --global user.email "<your-email>"` (consider your GitHub “noreply” email) + 5. Clone your project's repository and follow its `Getting Started` guide
260-261: Typo: “wich” → “which”.Simple copy fix in the Snowflake access steps.
- Slack channel. They will review and merge the pull request changes wich + Slack channel. They will review and merge the pull request changes which
118-119: Fix GitHub links to point to files (blob) instead of directories (tree).“tree/…” renders a directory listing; use “blob/main/…” so links open the exact Markdown file.
-3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/cursor.md) +3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/cursor.md)-3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/zed.md) +3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/zed.md)-2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/neovim.md) +2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/neovim.md)Also applies to: 141-144, 165-167
🧹 Nitpick comments (6)
onboarding/code-editor-extensions-and-plugins/neovim.md (1)
16-27: Optional: Add a “quick install” example for lazy.nvim.A short, copy/paste snippet helps new joiners get going faster and keeps setups consistent.
#### lazy.nvim - **Purpose**: Modern, fast plugin manager for Neovim - **Repository**: [https://github.com/folke/lazy.nvim](https://github.com/folke/lazy.nvim) +**Quick install:** + +```sh +# Linux/macOS +git clone --filter=blob:none https://github.com/folke/lazy.nvim ~/.local/share/nvim/lazy/lazy.nvim +``` + +Add to your init.lua: + +```lua +require("lazy").setup({ + -- examples: + {"nvim-treesitter/nvim-treesitter", build = ":TSUpdate"}, + {"neovim/nvim-lspconfig"}, +}) +``` + **What you'll use lazy.nvim for:**If you’d like, I can tailor the example to your team’s baseline plugin set.
onboarding/code-editor-extensions-and-plugins/cursor.md (2)
66-66: Wrap extension IDs in backticks for consistency.Most entries use backticks for IDs; a few are missing them.
-- **Extension ID**: formulahendry.auto-close-tag +- **Extension ID**: `formulahendry.auto-close-tag`-- **Extension ID**: christian-kohler.path-intellisense +- **Extension ID**: `christian-kohler.path-intellisense`-- **Extension ID**: Vue.volar +- **Extension ID**: `Vue.volar`Also applies to: 90-90, 260-260
69-69: Standardize colon placement in “What you'll use … for” headings.Some have the colon outside the bold text; others inside. Prefer colon inside for uniformity across the doc.
-**What you'll use Auto Close Tag for**: +**What you'll use Auto Close Tag for:**-**What you'll use Path Intellisense for**: +**What you'll use Path Intellisense for:**-**What you'll use CodeRabbit for**: +**What you'll use CodeRabbit for:**-**What you'll use Vue Language Features for**: +**What you'll use Vue Language Features for:**Also applies to: 93-93, 105-105, 263-263
onboarding/development-tools-and-platforms.md (3)
111-113: Join the wrapped list item into one line for readability.The bullet splits across lines; merge to avoid formatting surprises in some renderers.
- 1. Ask your manager to submit a support ticket on your behalf or send a message - in the `#lfx-ai` Slack channel. + 1. Ask your manager to submit a support ticket on your behalf or send a message in the `#lfx-ai` Slack channel.
137-138: Branding: “Copilot” capitalization.Use “GitHub Copilot” (lowercase p) per GitHub’s styling.
- 2. Most users connect to The Linux Foundation GitHub account to access the CoPilot AI models. + 2. Most users connect to The Linux Foundation GitHub account to access the Copilot AI models.- 2. Most users connect to The Linux Foundation GitHub account to access the CoPilot AI models. + 2. Most users connect to The Linux Foundation GitHub account to access the Copilot AI models.Also applies to: 161-162
307-307: Replace “TODO” placeholder with an action or remove before merge.Public docs shouldn’t ship with TODOs. Either link the owner’s tracking issue or remove this line. I can open a follow-up issue if you’d like.
-TODO: Leaving for David Deal to update +For updates to this section, please coordinate with the Linux Product & Engineering leadership and link the canonical org chart once finalized.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
onboarding/code-editor-extensions-and-plugins/cursor.md(1 hunks)onboarding/code-editor-extensions-and-plugins/neovim.md(1 hunks)onboarding/code-editor-extensions-and-plugins/zed.md(1 hunks)onboarding/development-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/code-editor-extensions-and-plugins/cursor.mdonboarding/code-editor-extensions-and-plugins/neovim.mdonboarding/code-editor-extensions-and-plugins/zed.mdonboarding/development-tools-and-platforms.md
🪛 LanguageTool
onboarding/code-editor-extensions-and-plugins/cursor.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...rsor code editor. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ...tting up new development environments 😀 --- ## 🎯 Cursor Extensions ### General Extensi...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...onments 😀 --- ## 🎯 Cursor Extensions ### General Extensions #### GitLens - **Pur...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...abilities and code history visualization - Extension ID: eamodio.gitlens **Wha...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...tic code formatting for consistent style - Extension ID: esbenp.prettier-vscode...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ... and TypeScript linting for code quality - Extension ID: dbaeumer.vscode-eslint...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...ode quality checking and error detection - Enforce team coding standards and best p...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...team coding standards and best practices - Automatic fixing of common issues and st...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ...ng of common issues and style violations - Custom rule configuration for project-sp...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...utomatically rename paired HTML/XML tags - Extension ID: `formulahendry.auto-rena...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...ose**: Automatically close HTML/XML tags - Extension ID: formulahendry.auto-close...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ...ker container management and development - Extension ID: `ms-azuretools.vscode-do...
(QB_NEW_EN)
[grammar] ~90-~90: There might be a mistake here.
Context: ...ID**: christian-kohler.path-intellisense - Purpose: Autocomplete for file paths i...
(QB_NEW_EN)
[grammar] ~95-~95: There might be a mistake here.
Context: ...autocompletion for file and folder paths - Reduce typos in import statements and fi...
(QB_NEW_EN)
[grammar] ~102-~102: There might be a mistake here.
Context: ...Extension ID*: coderabbitai.coderabbit - Purpose: AI-powered code review and an...
(QB_NEW_EN)
[grammar] ~107-~107: There might be a mistake here.
Context: ...code review suggestions and improvements - Automated code quality analysis and reco...
(QB_NEW_EN)
[grammar] ~108-~108: There might be a mistake here.
Context: ...ode quality analysis and recommendations - Security vulnerability detection in your...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...ity vulnerability detection in your code - Performance optimization suggestions - C...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...e - Performance optimization suggestions - Code style and best practice enforcement...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...opment with IntelliSense and diagnostics - Extension ID: Angular.ng-template *...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ... and autocompletion in Angular templates - Real-time error detection in component t...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...e error detection in component templates - Navigation between templates and compone...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...ion between templates and component code - Type checking for Angular expressions an...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...g for Angular expressions and directives - Quick fixes and refactoring support for ...
(QB_NEW_EN)
[grammar] ~138-~138: There might be a mistake here.
Context: ...- Maintain consistent project structure across team - Integrate with Angular CLI workf...
(QB_NEW_EN)
[grammar] ~143-~143: There might be a mistake here.
Context: ...pt error messages with better formatting - Extension ID: `yoavbls.pretty-ts-error...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ...utocomplete and linting for Tailwind CSS - Extension ID: `bradlc.vscode-tailwindc...
(QB_NEW_EN)
[grammar] ~160-~160: There might be a mistake here.
Context: ...utocomplete for Tailwind CSS class names - Hover previews showing the actual CSS pr...
(QB_NEW_EN)
[grammar] ~161-~161: There might be a mistake here.
Context: ...eviews showing the actual CSS properties - Linting and validation of Tailwind class...
(QB_NEW_EN)
[grammar] ~162-~162: There might be a mistake here.
Context: ...nting and validation of Tailwind classes - Color previews and syntax highlighting -...
(QB_NEW_EN)
[grammar] ~163-~163: There might be a mistake here.
Context: ...- Color previews and syntax highlighting - Support for custom Tailwind configuratio...
(QB_NEW_EN)
[grammar] ~168-~168: There might be a mistake here.
Context: ...tance integrated directly in your editor - Extension ID: Anthropic.claude-dev ...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...-powered code completion and suggestions - Intelligent code refactoring and optimiz...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...ligent code refactoring and optimization - Natural language code generation and exp...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...anguage code generation and explanations - Debugging assistance and error resolutio...
(QB_NEW_EN)
[grammar] ~176-~176: There might be a mistake here.
Context: ...ebugging assistance and error resolution - Code review and improvement recommendati...
(QB_NEW_EN)
[grammar] ~181-~181: There might be a mistake here.
Context: ...guage support with comprehensive tooling - Extension ID: golang.go **What you'...
(QB_NEW_EN)
[grammar] ~186-~186: There might be a mistake here.
Context: ... highlighting and code completion for Go - Integrated debugging with delve debugger...
(QB_NEW_EN)
[grammar] ~187-~187: There might be a mistake here.
Context: ...Integrated debugging with delve debugger - Automatic code formatting with gofmt on ...
(QB_NEW_EN)
[grammar] ~188-~188: There might be a mistake here.
Context: ...matic code formatting with gofmt on save - Test discovery and execution within the ...
(QB_NEW_EN)
[grammar] ~189-~189: There might be a mistake here.
Context: ...iscovery and execution within the editor - Import management and dependency resolut...
(QB_NEW_EN)
[grammar] ~190-~190: There might be a mistake here.
Context: ...ort management and dependency resolution - Integration with Go tools (go mod, go bu...
(QB_NEW_EN)
[grammar] ~195-~195: There might be a mistake here.
Context: ...EST APIs directly from within the editor - Extension ID: humao.rest-client **W...
(QB_NEW_EN)
[grammar] ~208-~208: There might be a mistake here.
Context: ...e**: Lightweight REST API testing client - Extension ID: `rangav.vscode-thunder-c...
(QB_NEW_EN)
[grammar] ~213-~213: There might be a mistake here.
Context: ...esting with collections and environments - Import/export Postman collections - Scri...
(QB_NEW_EN)
[grammar] ~214-~214: There might be a mistake here.
Context: ...ents - Import/export Postman collections - Scriptless testing with pre-request and ...
(QB_NEW_EN)
[grammar] ~215-~215: There might be a mistake here.
Context: ...esting with pre-request and test scripts - Response history and request organizatio...
(QB_NEW_EN)
[grammar] ~216-~216: There might be a mistake here.
Context: ...esponse history and request organization - Team collaboration with shared collectio...
(QB_NEW_EN)
[grammar] ~221-~221: There might be a mistake here.
Context: ... syntax highlighting and query execution - Extension ID: `ms-ossdata.vscode-postg...
(QB_NEW_EN)
[grammar] ~226-~226: There might be a mistake here.
Context: ...highlighting for PostgreSQL-specific SQL - IntelliSense for PostgreSQL functions an...
(QB_NEW_EN)
[grammar] ~227-~227: There might be a mistake here.
Context: ...se for PostgreSQL functions and keywords - Query execution and result visualization...
(QB_NEW_EN)
[grammar] ~228-~228: There might be a mistake here.
Context: ...Query execution and result visualization - Connection management for PostgreSQL dat...
(QB_NEW_EN)
[grammar] ~229-~229: There might be a mistake here.
Context: ...tion management for PostgreSQL databases - Schema browsing and table structure view...
(QB_NEW_EN)
[style] ~234-~234: This phrase is redundant (‘L’ stands for ‘language’). Use simply “YAML”.
Context: ...ture viewing #### YAML - Purpose: YAML language support with validation and formatting ...
(ACRONYM_TAUTOLOGY)
[grammar] ~234-~234: There might be a mistake here.
Context: ...e support with validation and formatting - Extension ID: redhat.vscode-yaml **...
(QB_NEW_EN)
[grammar] ~239-~239: There might be a mistake here.
Context: ...ghlighting and validation for YAML files - Schema validation for Kubernetes, Docker...
(QB_NEW_EN)
[grammar] ~240-~240: There might be a mistake here.
Context: ...ernetes, Docker Compose, and CI/CD files - Auto-completion based on YAML schemas - ...
(QB_NEW_EN)
[grammar] ~241-~241: There might be a mistake here.
Context: ... - Auto-completion based on YAML schemas - Formatting and indentation correction - ...
(QB_NEW_EN)
[grammar] ~242-~242: There might be a mistake here.
Context: ... - Formatting and indentation correction - Error detection and quick fixes #### Ku...
(QB_NEW_EN)
[grammar] ~247-~247: There might be a mistake here.
Context: ...etes cluster management and YAML editing - Extension ID: `ms-kubernetes-tools.vsc...
(QB_NEW_EN)
[grammar] ~260-~260: There might be a mistake here.
Context: ... Features - Extension ID: Vue.volar - Purpose: Official Vue.js language serv...
(QB_NEW_EN)
[grammar] ~265-~265: There might be a mistake here.
Context: ...ced TypeScript support in Vue components - Better performance and accuracy than leg...
(QB_NEW_EN)
[grammar] ~266-~266: There might be a mistake here.
Context: ... and accuracy than legacy Vue extensions - Composition API and script setup syntax ...
(QB_NEW_EN)
[grammar] ~267-~267: There might be a mistake here.
Context: ...tion API and script setup syntax support - Template type checking and validation - ...
(QB_NEW_EN)
[grammar] ~268-~268: There might be a mistake here.
Context: ... - Template type checking and validation - Integration with Vue 3 features and mode...
(QB_NEW_EN)
onboarding/code-editor-extensions-and-plugins/neovim.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...ovim code editor. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...tting up new development environments 😀 --- ## 🔧 Neovim Plugins ### Plugin Manager ##...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...vironments 😀 --- ## 🔧 Neovim Plugins ### Plugin Manager #### lazy.nvim - **Purpo...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...: Modern, fast plugin manager for Neovim - Repository: [https://github.com/folke/...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...loading plugins for faster startup times - Automatic plugin installation and update...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...utomatic plugin installation and updates - Dependency management between plugins - ...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ... - Dependency management between plugins - Performance optimization and configurati...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...thub.com/nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Purpose: Advanced syntax highlighting ...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...or syntax highlighting for 40+ languages - Intelligent code folding and text object...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ntelligent code folding and text objects - Incremental parsing for large files - Fo...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...ts - Incremental parsing for large files - Foundation for other advanced plugins #...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...github.com/nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Purpose: Fuzzy finder and picker for f...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...:** - Quick file navigation and opening - Search through project files and content...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...tegration for branch and commit browsing - Command palette functionality #### nvim...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...https://github.com/neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) - Purpose: Easy Language Server Protocol...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...**: https://github.com/hrsh7th/nvim-cmp - Purpose: Autocompletion engine with mu...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...lligent code completion from LSP servers - Snippet expansion and management - Buffe...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...rvers - Snippet expansion and management - Buffer and path completion - Integration...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ... management - Buffer and path completion - Integration with external completion sou...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...tps://github.com/lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) - Purpose: Git integration with signs, h...
(QB_NEW_EN)
[grammar] ~85-~85: There might be a mistake here.
Context: ...l Git diff indicators in the sign column - Stage and unstage hunks directly from th...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...d unstage hunks directly from the editor - Navigate through Git changes efficiently...
(QB_NEW_EN)
[grammar] ~87-~87: There might be a mistake here.
Context: ...Navigate through Git changes efficiently - Inline Git blame information #### fugit...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...: https://github.com/tpope/vim-fugitive - Purpose: Comprehensive Git wrapper for...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...vim - Interactive staging and committing - Branch management and merging - Git hist...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...mmitting - Branch management and merging - Git history browsing and comparison ###...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...tps://github.com/nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua) - Purpose: File explorer tree for Neovim...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ... for:** - Visual file system navigation - File and directory operations - Project ...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...vigation - File and directory operations - Project structure overview - Integration...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ... operations - Project structure overview - Integration with Git status indicators ...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...s://github.com/nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) - Purpose: Fast and customizable statusl...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...y**: https://github.com/mbbill/undotree - Purpose: Visual undo history tree for ...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ...: https://github.com/yetone/avante.nvim - Purpose: AI-powered code editing and c...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...chat for code explanations and debugging - AI-assisted code refactoring and optimiz...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ...sisted code refactoring and optimization - Natural language code generation and mod...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...anguage code generation and modification - Inline AI suggestions and code improveme...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...ithub.com/supermaven-inc/supermaven-nvim> - Purpose: Fast AI code completion with ...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ...powered code suggestions and completions - Context-aware code generation based on y...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...generation based on your entire codebase - Multi-language support with optimized pe...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...guage support with optimized performance - Seamless integration with existing compl...
(QB_NEW_EN)
onboarding/code-editor-extensions-and-plugins/zed.md
[grammar] ~5-~5: There might be a mistake here.
Context: ... Zed code editor. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ...tting up new development environments 😀 --- ## 🎯 Zed Extensions ### General Extensions...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...vironments 😀 --- ## 🎯 Zed Extensions ### General Extensions #### Git Firefly - *...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...it workflow visualization and management - Extension ID: git-firefly **What yo...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...visualization with interactive timelines - Enhanced branch management and merge con...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...management and merge conflict resolution - Commit message templates and conventiona...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...emplates and conventional commit support - Git workflow automation and custom git c...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...ation and custom git command integration - Advanced diff viewing with side-by-side ...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...d CSS coding with abbreviation expansion - Extension ID: emmet (Built-in to Zed...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...cture creation using CSS selector syntax - CSS property abbreviation expansion for ...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...bbreviation expansion for faster styling - Lorem ipsum text generation and placehol...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ... text generation and placeholder content - Number increment/decrement operations fo...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...t/decrement operations for batch editing - Wrap with abbreviation for restructuring...
(QB_NEW_EN)
[style] ~47-~47: This phrase is redundant (‘L’ stands for ‘language’). Use simply “HTML”.
Context: ...c Extensions #### HTML - Purpose: HTML language support with syntax highlighting and va...
(ACRONYM_TAUTOLOGY)
[grammar] ~47-~47: There might be a mistake here.
Context: ... with syntax highlighting and validation - Extension ID: html (Built-in to Zed)...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...ng and code completion for HTML elements - Auto-completion for HTML attributes and ...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...ompletion for HTML attributes and values - Tag matching and validation for proper H...
(QB_NEW_EN)
[grammar] ~54-~54: There might be a mistake here.
Context: ...and validation for proper HTML structure - Integration with CSS and JavaScript for ...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ... and JavaScript for full web development - Emmet-like abbreviation expansion for ra...
(QB_NEW_EN)
[grammar] ~60-~60: There might be a mistake here.
Context: ...on file support with syntax highlighting - Extension ID: toml **What you'll us...
(QB_NEW_EN)
[grammar] ~65-~65: There might be a mistake here.
Context: ...ighlighting for TOML configuration files - Validation and error detection for TOML ...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...tion and error detection for TOML syntax - Auto-completion for common TOML structur...
(QB_NEW_EN)
[grammar] ~67-~67: There might be a mistake here.
Context: ...to-completion for common TOML structures - Support for Cargo.toml, pyproject.toml, ...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ..., pyproject.toml, and other config files - Formatting and indentation for clean con...
(QB_NEW_EN)
[style] ~73-~73: This phrase is redundant (‘L’ stands for ‘language’). Use simply “SQL”.
Context: ...uration files #### SQL - Purpose: SQL language support for database development - **Ex...
(ACRONYM_TAUTOLOGY)
[grammar] ~73-~73: There might be a mistake here.
Context: ...anguage support for database development - Extension ID: sql **What you'll use...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ...ueries across multiple database dialects - IntelliSense for SQL keywords, functions...
(QB_NEW_EN)
[grammar] ~79-~79: There might be a mistake here.
Context: ...eywords, functions, and database objects - Query formatting and beautification for ...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...ing and beautification for readable code - Error detection and validation for SQL s...
(QB_NEW_EN)
[grammar] ~81-~81: There might be a mistake here.
Context: ... detection and validation for SQL syntax - Integration with database connections an...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...er development and configuration support - Extension ID: dockerfile **What you...
(QB_NEW_EN)
[grammar] ~91-~91: There might be a mistake here.
Context: ...d validation for Dockerfile instructions - Auto-completion for Docker commands and ...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...n for Docker commands and best practices - Linting and security recommendations for...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...ity recommendations for container builds - Integration with Docker CLI for building...
(QB_NEW_EN)
[grammar] ~94-~94: There might be a mistake here.
Context: ... CLI for building and testing containers - Support for multi-stage builds and advan...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...k development with comprehensive tooling - Extension ID: angular **What you'll...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...g and IntelliSense for Angular templates - Component, service, and directive code c...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ..., service, and directive code completion - TypeScript integration with Angular-spec...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...gration with Angular-specific decorators - Template syntax validation and error det...
(QB_NEW_EN)
[grammar] ~107-~107: There might be a mistake here.
Context: ...te syntax validation and error detection - Integration with Angular CLI for project...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...pment with single-file component support - Extension ID: vue **What you'll use...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...ng for Vue single-file components (.vue) - Template, script, and style section Inte...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ..., script, and style section IntelliSense - Vue 3 Composition API and Options API su...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ... Composition API and Options API support - Component props and emit validation - In...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ...rt - Component props and emit validation - Integration with Vue CLI and Vite develo...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...sor support for advanced CSS development - Extension ID: scss **What you'll us...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...SS/Sass variables, mixins, and functions - Auto-completion for SCSS-specific featur...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...specific features and built-in functions - Nesting validation and formatting for cl...
(QB_NEW_EN)
[grammar] ~132-~132: There might be a mistake here.
Context: ...ormatting for clean stylesheet structure - Color preview and picker integration for...
(QB_NEW_EN)
[grammar] ~133-~133: There might be a mistake here.
Context: ...icker integration for visual development - Compilation and error detection for SCSS...
(QB_NEW_EN)
[grammar] ~138-~138: There might be a mistake here.
Context: ... Code development with Terraform support - Extension ID: terraform **What you'...
(QB_NEW_EN)
[grammar] ~143-~143: There might be a mistake here.
Context: ... for Terraform configuration files (.tf) - IntelliSense for Terraform resources, pr...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ...raform resources, providers, and modules - Validation and linting for Terraform bes...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...and linting for Terraform best practices - Integration with Terraform CLI for plan,...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ... for plan, apply, and destroy operations - Support for Terraform workspaces and sta...
(QB_NEW_EN)
onboarding/development-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ... 1. Install 1Password browser extension for seamless login experience 2. Accept t...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...-on (SSO). --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...on and generation for faster development - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...ode refactoring and debugging assistance - Natural language to code translation for...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...ge to code translation for complex logic - Integration with our team's extensions a...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...r team's extensions and coding standards - Collaborative debugging sessions with AI...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...ing-fast performance for large codebases - Real-time collaborative editing during p...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...editing during pair programming sessions - Built-in terminal integration for develo...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...al integration for development workflows - Git integration for seamless version con...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...integration for seamless version control - Minimalist interface that reduces cognit...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...riven editing for experienced developers - Customizable development environment tai...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...nt environment tailored to your workflow - Powerful plugin ecosystem for language-s...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...system for language-specific development - Terminal-based editing for remote develo...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ...g for remote development and server work - Lua scripting for advanced configuration...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...eovim.md) --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~190-~190: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~194-~194: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~208-~208: There might be a mistake here.
Context: ...an via email 2. Accept invitation and complete account setup Setup Steps: 1. S...
(QB_NEW_EN)
[grammar] ~215-~215: There might be a mistake here.
Context: ...and understand the workflow stages 4. Install Jira mobile app for updates on the go ...
(QB_NEW_EN)
[grammar] ~219-~219: There might be a mistake here.
Context: ... go --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~223-~223: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~240-~240: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://app.snowflake.com/](http...
(QB_NEW_EN)
[grammar] ~249-~249: There might be a mistake here.
Context: ...ders and project planning - Collaborate with data team on complex analytical queries...
(QB_NEW_EN)
[grammar] ~261-~261: There might be a mistake here.
Context: ...to the Snowflake production environment. - Step 2: Developer: User Account Setup ...
(QB_NEW_EN)
[grammar] ~265-~265: There might be a mistake here.
Context: ...om/jnmhvwd/xpb85243/) Snowflake account. 3. Users should log in using their LF email...
(QB_NEW_EN)
[grammar] ~268-~268: There might be a mistake here.
Context: ....org)) via the Google SSO option. 4. Once logged in, the user should be redir...
(QB_NEW_EN)
[grammar] ~270-~270: There might be a mistake here.
Context: ...ck to the Snowflake landing page. 5. Users should then notify the Datalake Te...
(QB_NEW_EN)
[grammar] ~273-~273: There might be a mistake here.
Context: ... the user has logged in the first time). 6. Once the Datalake Team has granted acces...
(QB_NEW_EN)
[grammar] ~283-~283: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://whimsical.com/lfx-datala...
(QB_NEW_EN)
[grammar] ~286-~286: There might be a mistake here.
Context: ...-Qgy1wT6KC4RtrhCbfVQ37X) What you'll use LFX-Datalake diagram for: - Understa...
(QB_NEW_EN)
[grammar] ~296-~296: There might be a mistake here.
Context: ...cture, roles and reporting relationships - URL: [https://lucid.app/lucidchart/a39...
(QB_NEW_EN)
[grammar] ~311-~311: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~316-~316: There might be a mistake here.
Context: ...rams/data-flow.md) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~322-~322: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~328-~328: There might be a mistake here.
Context: ... documents, request sharing permissions from document owner #### Google Spreadsheet...
(QB_NEW_EN)
[grammar] ~332-~332: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~338-~338: There might be a mistake here.
Context: ... documents, request sharing permissions from spreadsheet owner #### Google Slides ...
(QB_NEW_EN)
[grammar] ~342-~342: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~348-~348: There might be a mistake here.
Context: ... documents, request sharing permissions from presentation owner #### Google Vids -...
(QB_NEW_EN)
[grammar] ~352-~352: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~358-~358: There might be a mistake here.
Context: ... documents, request sharing permissions from video owner #### Google Forms - **Pur...
(QB_NEW_EN)
[grammar] ~362-~362: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~368-~368: There might be a mistake here.
Context: ... documents, request sharing permissions from form owner #### Google Drive - **Purp...
(QB_NEW_EN)
[grammar] ~372-~372: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~381-~381: There might be a mistake here.
Context: ...sign-on (SSO) --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~401-~401: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - URL: [http://lfx.calamari.io/](http://...
(QB_NEW_EN)
[style] ~407-~407: ‘off balance’ might be wordy. Consider a shorter alternative.
Context: ...ve, and other time off - View your time off balance and accrual rates - Submit time off req...
(EN_WORDINESS_PREMIUM_OFF_BALANCE)
[grammar] ~415-~415: There might be a mistake here.
Context: ...ri via email 2. Accept invitation and complete account setup --- ## 🆘 Getting Help ...
(QB_NEW_EN)
[grammar] ~419-~419: There might be a mistake here.
Context: ...e account setup --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~428-~428: There might be a mistake here.
Context: ...nce --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~439-~439: There might be a mistake here.
Context: ...es --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
🪛 GitHub Check: markdown-lint
onboarding/code-editor-extensions-and-plugins/neovim.md
[failure] 164-164: Heading style [Expected: atx; Actual: setext]
onboarding/code-editor-extensions-and-plugins/neovim.md:164 MD003/heading-style/header-style Heading style [Expected: atx; Actual: setext]
onboarding/development-tools-and-platforms.md
[failure] 309-309: Multiple headings with the same content [Context: "### LFX-Datalake"]
onboarding/development-tools-and-platforms.md:309 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### LFX-Datalake"]
🪛 GitHub Actions: Markdown Lint
onboarding/code-editor-extensions-and-plugins/neovim.md
[error] 164-164: markdownlint-cli2-action@v9: MD003/heading-style/header-style Heading style [Expected: atx; Actual: setext]
🔇 Additional comments (3)
onboarding/code-editor-extensions-and-plugins/cursor.md (1)
1-271: Well-structured, clear, and immediately useful.Layout, sectioning, and usage bullets are consistent and easy to scan. This will help new devs get productive quickly.
onboarding/development-tools-and-platforms.md (1)
402-402: Verify Calamari URL scheme (http vs https).If HTTPS is available, prefer it. If the endpoint is intentionally HTTP (internal-only), consider noting that.
Would you like me to run a quick link-checking pass across onboarding/*.md to validate status codes and redirect chains?
onboarding/code-editor-extensions-and-plugins/zed.md (1)
1-149: Readable, consistent, and aligned with the other editor guides.Good balance of purpose, IDs, and usage bullets. This mirrors the Cursor/Neovim docs nicely.
| You can find a list of more plugins at [https://github.com/rockerBOO/awesome-neovim](https://github.com/rockerBOO/awesome-neovim) | ||
| --- |
There was a problem hiding this comment.
Fix MD003 by separating the horizontal rule from the preceding paragraph.
Without a blank line, the --- is parsed as a setext heading underline. Insert a blank line before the rule to make it a proper horizontal rule and unblock markdownlint.
-You can find a list of more plugins at [https://github.com/rockerBOO/awesome-neovim](https://github.com/rockerBOO/awesome-neovim)
----
+You can find a list of more plugins at [https://github.com/rockerBOO/awesome-neovim](https://github.com/rockerBOO/awesome-neovim)
+
+---Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 GitHub Check: markdown-lint
[failure] 164-164: Heading style [Expected: atx; Actual: setext]
onboarding/code-editor-extensions-and-plugins/neovim.md:164 MD003/heading-style/header-style Heading style [Expected: atx; Actual: setext]
🪛 GitHub Actions: Markdown Lint
[error] 164-164: markdownlint-cli2-action@v9: MD003/heading-style/header-style Heading style [Expected: atx; Actual: setext]
🤖 Prompt for AI Agents
In onboarding/code-editor-extensions-and-plugins/neovim.md around lines 164 to
165, the horizontal rule marker '---' is directly adjacent to the preceding
paragraph so markdownlint treats it as a setext heading underline; fix by
inserting a single blank line between the paragraph ending with the link and the
'---' line so the '---' is recognized as a proper horizontal rule.
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
onboarding/development-tools-and-platforms.md (2)
118-119: Fix GitHub URLs: use “blob” to link to files (not “tree”).Links currently open directories. Switching to “blob” navigates directly to the markdown files.
- 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/cursor.md) + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/cursor.md) @@ - 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/zed.md) + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/zed.md) @@ - 2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/neovim.md) + 2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/neovim.md)Also applies to: 143-143, 166-166
309-313: Rename “LFX-Datalake2” to a descriptive, unique heading.Resolves the duplicate/ambiguous heading noted earlier and clarifies intent.
-### LFX-Datalake2 +### LFX Architecture: Data Flow
🧹 Nitpick comments (11)
onboarding/code-editor-extensions-and-plugins/neovim.md (5)
7-12: Insert a blank line before the horizontal rule to satisfy markdownlint.Without a blank line, some linters parse
---as a setext underline. Add a blank line above it.-2. **Bookmark this page** for quick reference when setting up new development environments 😀 ---- +2. **Bookmark this page** for quick reference when setting up new development environments 😀 + +---
16-27: Add prerequisites and a minimal lazy.nvim bootstrap snippet.This makes the guide actionable for first‑time Neovim users and reduces setup friction.
#### lazy.nvim - **Purpose**: Modern, fast plugin manager for Neovim - **Repository**: [https://github.com/folke/lazy.nvim](https://github.com/folke/lazy.nvim) **What you'll use lazy.nvim for:** @@ - Dependency management between plugins - Performance optimization and configuration management + +Prerequisites: + +- Neovim 0.9+ (0.10 recommended) +- git + +Quick start (bootstrap): + +```lua +-- ~/.config/nvim/init.lua (minimal) +local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" +if not vim.loop.fs_stat(lazypath) then + vim.fn.system({ "git", "clone", "--filter=blob:none", + "https://github.com/folke/lazy.nvim.git", "--branch=stable", lazypath }) +end +vim.opt.rtp:prepend(lazypath) +require("lazy").setup({ + { "nvim-treesitter/nvim-treesitter", build = ":TSUpdate" }, + "neovim/nvim-lspconfig", + "hrsh7th/nvim-cmp", +}) +``` + +After installation, run `:TSUpdate` to fetch language parsers.
119-121: Standardize bold punctuation style.Elsewhere the colon is inside the bold marks; align this heading for consistency.
-**What you'll use lualine.nvim for**: +**What you'll use lualine.nvim for:**
140-156: Normalize link style to match the rest of the document.Most links use the
[text](url)form; switch from autolinks to keep styling consistent.-- **Repository**: <https://github.com/yetone/avante.nvim> +- **Repository**: [https://github.com/yetone/avante.nvim](https://github.com/yetone/avante.nvim) @@ -- **Repository**: <https://github.com/supermaven-inc/supermaven-nvim> +- **Repository**: [https://github.com/supermaven-inc/supermaven-nvim](https://github.com/supermaven-inc/supermaven-nvim)
155-163: Add a brief compliance note for AI plugins.Helps prevent accidental policy or secret‑handling issues during onboarding.
- Multi-language support with optimized performance - Seamless integration with existing completion workflows +> Note: AI plugins (e.g., avante.nvim, supermaven-nvim) may require API keys or paid accounts. Store secrets only in approved vaults (e.g., 1Password) and verify licensing/usage complies with Linux Foundation policy before enabling third‑party services.onboarding/development-tools-and-platforms.md (6)
69-71: Grammar fix (“its”), and suggest privacy‑friendly Git config example.Small polish and a better default for email privacy.
- 4. Set up Git configuration with your personal GitHub email: `git config --global user.email "your.email@gmail.com"` - 5. Clone your project's repository and follow it's `Getting Started` guide + 4. Set up Git configuration with your preferred GitHub email: `git config --global user.email "<your-email>"` (consider using your GitHub “noreply” email for privacy) + 5. Clone your project's repository and follow its `Getting Started` guide
111-112: Keep list item on one line to avoid awkward paragraph breaks.Improves readability in rendered Markdown.
- 1. Ask your manager to submit a support ticket on your behalf or send a message - in the `#lfx-ai` Slack channel. + 1. Ask your manager to submit a support ticket on your behalf or send a message in the `#lfx-ai` Slack channel.
137-138: Clarify Copilot usage and licensing.Avoids implying universal access and aligns with policy/licensing expectations.
- 2. Most users connect to The Linux Foundation GitHub account to access the CoPilot AI models. + 2. If using GitHub Copilot, connect your Linux Foundation GitHub account (license required) and ensure usage complies with LF policy. @@ - 2. Most users connect to The Linux Foundation GitHub account to access the CoPilot AI models. + 2. If using GitHub Copilot, connect your Linux Foundation GitHub account (license required) and ensure usage complies with LF policy.Also applies to: 160-162
221-227: Standardize product name: “Datadog” capitalization.Brand consistency nit.
-### DataDog +### Datadog @@ -**What you'll use DataDog for:** +**What you'll use Datadog for:**
330-334: Use the official product name “Google Sheets.”Minor terminology polish.
-#### Google Spreadsheets +#### Google Sheets
79-82: Capitalize MCP acronym.Acronyms should be uppercase for clarity.
-- Learn AI integrations and mcp clients +- Learn AI integrations and MCP clients
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
onboarding/code-editor-extensions-and-plugins/neovim.md(1 hunks)onboarding/development-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/code-editor-extensions-and-plugins/neovim.mdonboarding/development-tools-and-platforms.md
🪛 LanguageTool
onboarding/code-editor-extensions-and-plugins/neovim.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...ovim code editor. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...tting up new development environments 😀 --- ## 🔧 Neovim Plugins ### Plugin Manager ##...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...vironments 😀 --- ## 🔧 Neovim Plugins ### Plugin Manager #### lazy.nvim - **Purpo...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...: Modern, fast plugin manager for Neovim - Repository: [https://github.com/folke/...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...loading plugins for faster startup times - Automatic plugin installation and update...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...utomatic plugin installation and updates - Dependency management between plugins - ...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ... - Dependency management between plugins - Performance optimization and configurati...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...thub.com/nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Purpose: Advanced syntax highlighting ...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...or syntax highlighting for 40+ languages - Intelligent code folding and text object...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ntelligent code folding and text objects - Incremental parsing for large files - Fo...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...ts - Incremental parsing for large files - Foundation for other advanced plugins #...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ...github.com/nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Purpose: Fuzzy finder and picker for f...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...:** - Quick file navigation and opening - Search through project files and content...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...tegration for branch and commit browsing - Command palette functionality #### nvim...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...https://github.com/neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) - Purpose: Easy Language Server Protocol...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...**: https://github.com/hrsh7th/nvim-cmp - Purpose: Autocompletion engine with mu...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...lligent code completion from LSP servers - Snippet expansion and management - Buffe...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...rvers - Snippet expansion and management - Buffer and path completion - Integration...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ... management - Buffer and path completion - Integration with external completion sou...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...tps://github.com/lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) - Purpose: Git integration with signs, h...
(QB_NEW_EN)
[grammar] ~85-~85: There might be a mistake here.
Context: ...l Git diff indicators in the sign column - Stage and unstage hunks directly from th...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...d unstage hunks directly from the editor - Navigate through Git changes efficiently...
(QB_NEW_EN)
[grammar] ~87-~87: There might be a mistake here.
Context: ...Navigate through Git changes efficiently - Inline Git blame information #### fugit...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...: https://github.com/tpope/vim-fugitive - Purpose: Comprehensive Git wrapper for...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...vim - Interactive staging and committing - Branch management and merging - Git hist...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...mmitting - Branch management and merging - Git history browsing and comparison ###...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...tps://github.com/nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua) - Purpose: File explorer tree for Neovim...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ... for:** - Visual file system navigation - File and directory operations - Project ...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...vigation - File and directory operations - Project structure overview - Integration...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ... operations - Project structure overview - Integration with Git status indicators ...
(QB_NEW_EN)
[grammar] ~116-~116: There might be a mistake here.
Context: ...s://github.com/nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) - Purpose: Fast and customizable statusl...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...y**: https://github.com/mbbill/undotree - Purpose: Visual undo history tree for ...
(QB_NEW_EN)
[grammar] ~140-~140: There might be a mistake here.
Context: ...: https://github.com/yetone/avante.nvim - Purpose: AI-powered code editing and c...
(QB_NEW_EN)
[grammar] ~145-~145: There might be a mistake here.
Context: ...chat for code explanations and debugging - AI-assisted code refactoring and optimiz...
(QB_NEW_EN)
[grammar] ~146-~146: There might be a mistake here.
Context: ...sisted code refactoring and optimization - Natural language code generation and mod...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...anguage code generation and modification - Inline AI suggestions and code improveme...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...ithub.com/supermaven-inc/supermaven-nvim> - Purpose: Fast AI code completion with ...
(QB_NEW_EN)
[grammar] ~157-~157: There might be a mistake here.
Context: ...powered code suggestions and completions - Context-aware code generation based on y...
(QB_NEW_EN)
[grammar] ~158-~158: There might be a mistake here.
Context: ...generation based on your entire codebase - Multi-language support with optimized pe...
(QB_NEW_EN)
[grammar] ~159-~159: There might be a mistake here.
Context: ...guage support with optimized performance - Seamless integration with existing compl...
(QB_NEW_EN)
onboarding/development-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ... 1. Install 1Password browser extension for seamless login experience 2. Accept t...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...-on (SSO). --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...on and generation for faster development - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...ode refactoring and debugging assistance - Natural language to code translation for...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...ge to code translation for complex logic - Integration with our team's extensions a...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...r team's extensions and coding standards - Collaborative debugging sessions with AI...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...ing-fast performance for large codebases - Real-time collaborative editing during p...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...editing during pair programming sessions - Built-in terminal integration for develo...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...al integration for development workflows - Git integration for seamless version con...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...integration for seamless version control - Minimalist interface that reduces cognit...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...riven editing for experienced developers - Customizable development environment tai...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...nt environment tailored to your workflow - Powerful plugin ecosystem for language-s...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...system for language-specific development - Terminal-based editing for remote develo...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ...g for remote development and server work - Lua scripting for advanced configuration...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...eovim.md) --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~190-~190: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~194-~194: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~208-~208: There might be a mistake here.
Context: ...an via email 2. Accept invitation and complete account setup Setup Steps: 1. S...
(QB_NEW_EN)
[grammar] ~215-~215: There might be a mistake here.
Context: ...and understand the workflow stages 4. Install Jira mobile app for updates on the go ...
(QB_NEW_EN)
[grammar] ~219-~219: There might be a mistake here.
Context: ... go --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~223-~223: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~240-~240: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://app.snowflake.com/](http...
(QB_NEW_EN)
[grammar] ~249-~249: There might be a mistake here.
Context: ...ders and project planning - Collaborate with data team on complex analytical queries...
(QB_NEW_EN)
[grammar] ~261-~261: There might be a mistake here.
Context: ...to the Snowflake production environment. - Step 2: Developer: User Account Setup ...
(QB_NEW_EN)
[grammar] ~265-~265: There might be a mistake here.
Context: ...om/jnmhvwd/xpb85243/) Snowflake account. 3. Users should log in using their LF email...
(QB_NEW_EN)
[grammar] ~268-~268: There might be a mistake here.
Context: ....org)) via the Google SSO option. 4. Once logged in, the user should be redir...
(QB_NEW_EN)
[grammar] ~270-~270: There might be a mistake here.
Context: ...ck to the Snowflake landing page. 5. Users should then notify the Datalake Te...
(QB_NEW_EN)
[grammar] ~273-~273: There might be a mistake here.
Context: ... the user has logged in the first time). 6. Once the Datalake Team has granted acces...
(QB_NEW_EN)
[grammar] ~283-~283: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://whimsical.com/lfx-datala...
(QB_NEW_EN)
[grammar] ~286-~286: There might be a mistake here.
Context: ...-Qgy1wT6KC4RtrhCbfVQ37X) What you'll use LFX-Datalake diagram for: - Understa...
(QB_NEW_EN)
[grammar] ~296-~296: There might be a mistake here.
Context: ...cture, roles and reporting relationships - URL: [https://lucid.app/lucidchart/a39...
(QB_NEW_EN)
[grammar] ~311-~311: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~316-~316: There might be a mistake here.
Context: ...rams/data-flow.md) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~322-~322: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~328-~328: There might be a mistake here.
Context: ... documents, request sharing permissions from document owner #### Google Spreadsheet...
(QB_NEW_EN)
[grammar] ~332-~332: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~338-~338: There might be a mistake here.
Context: ... documents, request sharing permissions from spreadsheet owner #### Google Slides ...
(QB_NEW_EN)
[grammar] ~342-~342: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~348-~348: There might be a mistake here.
Context: ... documents, request sharing permissions from presentation owner #### Google Vids -...
(QB_NEW_EN)
[grammar] ~352-~352: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~358-~358: There might be a mistake here.
Context: ... documents, request sharing permissions from video owner #### Google Forms - **Pur...
(QB_NEW_EN)
[grammar] ~362-~362: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~368-~368: There might be a mistake here.
Context: ... documents, request sharing permissions from form owner #### Google Drive - **Purp...
(QB_NEW_EN)
[grammar] ~372-~372: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~381-~381: There might be a mistake here.
Context: ...sign-on (SSO) --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~401-~401: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - URL: [https://lfx.calamari.io/](http:/...
(QB_NEW_EN)
[style] ~407-~407: ‘off balance’ might be wordy. Consider a shorter alternative.
Context: ...ve, and other time off - View your time off balance and accrual rates - Submit time off req...
(EN_WORDINESS_PREMIUM_OFF_BALANCE)
[grammar] ~415-~415: There might be a mistake here.
Context: ...ri via email 2. Accept invitation and complete account setup --- ## 🆘 Getting Help ...
(QB_NEW_EN)
[grammar] ~419-~419: There might be a mistake here.
Context: ...e account setup --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~428-~428: There might be a mistake here.
Context: ...nce --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~439-~439: There might be a mistake here.
Context: ...es --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
🔇 Additional comments (1)
onboarding/development-tools-and-platforms.md (1)
1-12: Nice structure and scannability.Clear sections, consistent subsections, and handy “Setup Steps.” Good foundation for onboarding.
Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
onboarding/development-tools-and-platforms.md (2)
118-119: Fix GitHub links to point to files (blob) rather than directories (tree).Using "tree" renders the directory view instead of the target markdown file.
Apply:
- 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/cursor.md) + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/cursor.md)- 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/zed.md) + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/zed.md)- 2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/neovim.md) + 2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/code-editor-extensions-and-plugins/neovim.md)Also applies to: 143-144, 166-167
66-71: Tighten GitHub setup language; fix “it’s” → “its” and email guidance.Clarifies SSO auth step, fixes grammar, and avoids suggesting personal Gmail for work repos.
1. Enable two-factor authentication (required for all organization members) 2. Configure SSH keys following our security guidelines - 3. Authorize the organization under SSH and GPG keys -> Configure SSO - 4. Set up Git configuration with your personal GitHub email: `git config --global user.email "your.email@gmail.com"` - 5. Clone your project's repository and follow it's `Getting Started` guide + 3. Authorize your SSH and (optionally) GPG keys for SSO access to the Linux Foundation organization + 4. Set your Git author email: `git config --global user.email "<your-github-email>"` (consider your GitHub “noreply” for privacy) + 5. Clone your project's repository and follow its `Getting Started` guide
🧹 Nitpick comments (11)
onboarding/development-tools-and-platforms.md (11)
320-324: Correct Google Docs URL (currently points to Drive).Linking Docs to Drive is confusing; use the canonical Docs URL.
-#### Google Docs - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://drive.google.com/](https://drive.google.com/) +#### Google Docs + +- **Purpose**: Create and edit text documents (word processing) +**URL**: [https://docs.google.com/document/](https://docs.google.com/document/)
221-225: Standardize brand casing: “Datadog”, not “DataDog”.Keep naming consistent across headings and body.
-### DataDog +### Datadog
137-138: Fix capitalization: “Copilot” (not “CoPilot”). Also clarify access expectations.Minor branding nit. Additionally, if LF uses organization-licensed seats, users likely must sign in with LF GitHub accounts and be assigned a seat; consider clarifying to avoid access confusion.
- 2. Most users connect to The Linux Foundation GitHub account to access the CoPilot AI models. + 2. Most users connect to the Linux Foundation GitHub account to access GitHub Copilot models.Follow-up: Confirm whether Copilot access requires an org-assigned seat and LF email sign-in for Zed/Neovim plugins; if so, add a one-line note and request path for a seat.
Also applies to: 160-162
265-268: Use mailto: for the example email link.Clickable mail link improves UX and avoids a broken link.
- 3. Users should log in using their LF email (e.g., - [your_lf_email@linuxfoundation.org](your_lf_email@linuxfoundation.org)) via + 3. Users should log in using their LF email (e.g., + [your_lf_email@linuxfoundation.org](mailto:your_lf_email@linuxfoundation.org)) via
68-68: Clarify the GitHub SSO authorization step.“Authorize the organization under SSH and GPG keys -> Configure SSO” is ambiguous. The diff in a separate comment rewrites it, but if you prefer keeping this line, explicitly mention authorizing SSH/GPG keys for the Linux Foundation org under GitHub SSO settings.
307-307: Replace bare TODO with an owner and tracking link.Convert “TODO: Leaving for David Deal to update” into an actionable item (owner + issue/PR).
Example:
-TODO: Leaving for David Deal to update +TODO: Update with latest org diagram (Owner: @dealako). Track at: https://github.com/linuxfoundation/lfx-engineering/issues/<id>I can open a tracking issue if you’d like.
311-313: Rename “LFX-Datalake2” to a descriptive title.“LFX-Datalake2” reads like a placeholder. Use a meaningful heading to avoid MD024 collisions and improve scannability.
-### LFX-Datalake2 +### LFX Architecture: Data FlowAlso applies to: 309-309
253-261: Snowflake Step 1: add direct file path(s) and approval flow detail.You reference “the user configuration file” without a path; and reviewers/approvers aren’t specified. Add the exact path (e.g., users.tfvars or similar) and note who approves (CODEOWNERS, Datalake team).
If you share the repo structure, I can propose a precise path update.
185-187: Clarify API Gateway access model.“Access is typically granted” is vague. Specify whether docs are public, behind SSO/VPN, or require role-based grants.
77-83: Polish repository section: capitalize “MCP” and fix heading phrasing.Minor clarity/brand nits.
-**What you'll use lfx-engineering for:** +**What you'll use the LFX Engineering repository for:** @@ -- Learn AI integrations and mcp clients +- Learn AI integrations and MCP clients
383-399: Tighten “Individual Dashboard” purpose sentence.Current line is long and reads like a list. Consider a concise sentence.
-- **Purpose**: Personal profile, view your events and meetings and technical contribution and training enrollment tracking +- **Purpose**: Manage your profile; view events/meetings; track technical contributions and training enrollments
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
onboarding/development-tools-and-platforms.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.md: Documentation files use Markdown format
Use Markdown for all documentation
Files:
onboarding/development-tools-and-platforms.md
🪛 LanguageTool
onboarding/development-tools-and-platforms.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...platforms we use. ## 🚀 Getting Started 1. Review this entire document to understa...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...kmark this page** for quick reference 😀 --- ## 🔐 Security and Access Management ### 1P...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-- ## 🔐 Security and Access Management ### 1Password - Purpose: Password manage...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...management and secure credential storage - URL: [https://1password.com/](https://...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ... 1. Install 1Password browser extension for seamless login experience 2. Accept t...
(QB_NEW_EN)
[grammar] ~46-~46: There might be a mistake here.
Context: ...dicated to fostering the growth of Linux - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ion of artifacts and notes for engineers - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...-on (SSO). --- ## 🔧 Development Tools ### Integrated Development Environments (IDEs...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ... code editor with built-in AI assistance - URL: [https://cursor.sh/](https://curs...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...on and generation for faster development - Intelligent code refactoring and debuggi...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...ode refactoring and debugging assistance - Natural language to code translation for...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...ge to code translation for complex logic - Integration with our team's extensions a...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...r team's extensions and coding standards - Collaborative debugging sessions with AI...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...h-performance, collaborative code editor - URL: [https://zed.dev/](https://zed.de...
(QB_NEW_EN)
[grammar] ~128-~128: There might be a mistake here.
Context: ...ing-fast performance for large codebases - Real-time collaborative editing during p...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...editing during pair programming sessions - Built-in terminal integration for develo...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...al integration for development workflows - Git integration for seamless version con...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ...integration for seamless version control - Minimalist interface that reduces cognit...
(QB_NEW_EN)
[grammar] ~147-~147: There might be a mistake here.
Context: ...n, extensible terminal-based text editor - URL: [https://neovim.io/](https://neov...
(QB_NEW_EN)
[grammar] ~152-~152: There might be a mistake here.
Context: ...riven editing for experienced developers - Customizable development environment tai...
(QB_NEW_EN)
[grammar] ~153-~153: There might be a mistake here.
Context: ...nt environment tailored to your workflow - Powerful plugin ecosystem for language-s...
(QB_NEW_EN)
[grammar] ~154-~154: There might be a mistake here.
Context: ...system for language-specific development - Terminal-based editing for remote develo...
(QB_NEW_EN)
[grammar] ~155-~155: There might be a mistake here.
Context: ...g for remote development and server work - Lua scripting for advanced configuration...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...eovim.md) --- ## 🗃️ API Documentation ### API Gateway - Purpose: Central API g...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...ay for routing and managing API requests - URL: [https://api-gw.dev.platform.linu...
(QB_NEW_EN)
[grammar] ~190-~190: There might be a mistake here.
Context: ...## 📋 Project Management & Collaboration ### Jira - Purpose: Issue tracking, proj...
(QB_NEW_EN)
[grammar] ~194-~194: There might be a mistake here.
Context: ...agement, and agile development workflows - URL: [https://linuxfoundation.atlassia...
(QB_NEW_EN)
[grammar] ~208-~208: There might be a mistake here.
Context: ...an via email 2. Accept invitation and complete account setup Setup Steps: 1. S...
(QB_NEW_EN)
[grammar] ~215-~215: There might be a mistake here.
Context: ...and understand the workflow stages 4. Install Jira mobile app for updates on the go ...
(QB_NEW_EN)
[grammar] ~219-~219: There might be a mistake here.
Context: ... go --- ## 📊 Monitoring and Analytics ### DataDog - Purpose: Application perfo...
(QB_NEW_EN)
[grammar] ~223-~223: There might be a mistake here.
Context: ...ing, logging, and infrastructure metrics - URL: [https://datadog.linuxfoundation....
(QB_NEW_EN)
[grammar] ~240-~240: There might be a mistake here.
Context: ...tform for data warehousing and analytics - URL: [https://app.snowflake.com/](http...
(QB_NEW_EN)
[grammar] ~249-~249: There might be a mistake here.
Context: ...ders and project planning - Collaborate with data team on complex analytical queries...
(QB_NEW_EN)
[grammar] ~261-~261: There might be a mistake here.
Context: ...to the Snowflake production environment. - Step 2: Developer: User Account Setup ...
(QB_NEW_EN)
[grammar] ~265-~265: There might be a mistake here.
Context: ...om/jnmhvwd/xpb85243/) Snowflake account. 3. Users should log in using their LF email...
(QB_NEW_EN)
[grammar] ~268-~268: There might be a mistake here.
Context: ....org)) via the Google SSO option. 4. Once logged in, the user should be redir...
(QB_NEW_EN)
[grammar] ~270-~270: There might be a mistake here.
Context: ...ck to the Snowflake landing page. 5. Users should then notify the Datalake Te...
(QB_NEW_EN)
[grammar] ~273-~273: There might be a mistake here.
Context: ... the user has logged in the first time). 6. Once the Datalake Team has granted acces...
(QB_NEW_EN)
[grammar] ~283-~283: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://whimsical.com/lfx-datala...
(QB_NEW_EN)
[grammar] ~286-~286: There might be a mistake here.
Context: ...-Qgy1wT6KC4RtrhCbfVQ37X) What you'll use LFX-Datalake diagram for: - Understa...
(QB_NEW_EN)
[grammar] ~296-~296: There might be a mistake here.
Context: ...cture, roles and reporting relationships - URL: [https://lucid.app/lucidchart/a39...
(QB_NEW_EN)
[grammar] ~311-~311: There might be a mistake here.
Context: ...ces, data flows, and system dependencies - URL: [https://github.com/linuxfoundati...
(QB_NEW_EN)
[grammar] ~316-~316: There might be a mistake here.
Context: ...rams/data-flow.md) --- ## 📁 Documents ### Google Workspace #### Google Docs - **P...
(QB_NEW_EN)
[grammar] ~322-~322: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~328-~328: There might be a mistake here.
Context: ... documents, request sharing permissions from document owner #### Google Spreadsheet...
(QB_NEW_EN)
[grammar] ~332-~332: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/spreadsh...
(QB_NEW_EN)
[grammar] ~338-~338: There might be a mistake here.
Context: ... documents, request sharing permissions from spreadsheet owner #### Google Slides ...
(QB_NEW_EN)
[grammar] ~342-~342: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/presenta...
(QB_NEW_EN)
[grammar] ~348-~348: There might be a mistake here.
Context: ... documents, request sharing permissions from presentation owner #### Google Vids -...
(QB_NEW_EN)
[grammar] ~352-~352: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/videos](...
(QB_NEW_EN)
[grammar] ~358-~358: There might be a mistake here.
Context: ... documents, request sharing permissions from video owner #### Google Forms - **Pur...
(QB_NEW_EN)
[grammar] ~362-~362: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://docs.google.com/forms](h...
(QB_NEW_EN)
[grammar] ~368-~368: There might be a mistake here.
Context: ... documents, request sharing permissions from form owner #### Google Drive - **Purp...
(QB_NEW_EN)
[grammar] ~372-~372: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
[grammar] ~381-~381: There might be a mistake here.
Context: ...sign-on (SSO) --- ## 🔦 Internal Tools ### Individual Dashboard - Purpose: Pers...
(QB_NEW_EN)
[grammar] ~401-~401: There might be a mistake here.
Context: ...ux Foundation tool for time off tracking - URL: [https://lfx.calamari.io/](https:...
(QB_NEW_EN)
[style] ~407-~407: ‘off balance’ might be wordy. Consider a shorter alternative.
Context: ...ve, and other time off - View your time off balance and accrual rates - Submit time off req...
(EN_WORDINESS_PREMIUM_OFF_BALANCE)
[grammar] ~415-~415: There might be a mistake here.
Context: ...ri via email 2. Accept invitation and complete account setup --- ## 🆘 Getting Help ...
(QB_NEW_EN)
[grammar] ~419-~419: There might be a mistake here.
Context: ...e account setup --- ## 🆘 Getting Help If you need access to any of these tools ...
(QB_NEW_EN)
[grammar] ~428-~428: There might be a mistake here.
Context: ...nce --- ## 📝 Notes for New Developers - Bookmark this page for quick reference ...
(QB_NEW_EN)
[grammar] ~439-~439: There might be a mistake here.
Context: ...es --- ## 🔄 Keeping This File Updated This document should be updated whenever:...
(QB_NEW_EN)
Overview
This pull request adds comprehensive onboarding documentation for developers at the Linux Foundation, introducing two new markdown files: one providing an overview of developer tools, platforms, and procedures, and another offering setup instructions for key LFX platforms. These documents are designed to streamline onboarding, clarify access procedures, and centralize essential resources for new team members.
Developer onboarding and tooling documentation:
onboarding/frontend.md, a detailed guide covering security tools, development environments (including IDEs), platform environments, API documentation, project management, monitoring, design tools, document management, and internal tools. The guide also includes instructions for getting help, maintaining the document, and onboarding best practices.Platform-specific setup instructions:
onboarding/lf-platforms-list.md, which provides a focused setup guide for key Linux Foundation platforms, including LFX-PCC, with links to repositories and getting started wikis, as well as troubleshooting steps for setup and access issues.