From 3486f19c12225b20b5369ceec622a63bd3279ac3 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Wed, 20 Aug 2025 20:40:01 -0500 Subject: [PATCH 01/14] chore: add engineering onboarding documentation 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) --- onboarding/frontend.md | 229 ++++++++++++++++++++++++++++++++ onboarding/lf-platforms-list.md | 30 +++++ 2 files changed, 259 insertions(+) create mode 100644 onboarding/frontend.md create mode 100644 onboarding/lf-platforms-list.md diff --git a/onboarding/frontend.md b/onboarding/frontend.md new file mode 100644 index 0000000..4164da8 --- /dev/null +++ b/onboarding/frontend.md @@ -0,0 +1,229 @@ +# Developer Tools & Platforms + +Welcome to the Linux Foundation development team! This guide provides an overview of the tools and platforms we use. + +## πŸš€ Getting Started + +1. **Review this entire document** to understand our tech stack +2. **Request access** to all relevant platforms (see each section for account setup instructions) +3. **Contact your manager or IT team** if you need help with access to any platform +4. **Bookmark this page** for quick reference πŸ˜€ + +--- + +## πŸ” Security and Access Management + +### 1Password +- **Purpose**: Password management and secure credential storage +- **URL**: [https://1password.com/](https://1password.com/) +- **What it does**: + - Store and share team passwords, API keys, and sensitive information securely + - Generate strong passwords + - Secure notes and documents + - Two-factor authentication backup +- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account + +--- + +## πŸ”§ Development Tools + +### Version Control - GitHub +- **Main Organization**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) +- **Key Repositories**: + - **PCC Repository**: [https://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) + - **ITX Repository**: [https://github.com/linuxfoundation-it](https://github.com/linuxfoundation-it) + - **Engineering Artifact and Notes Repository**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) +- **Purpose**: Source code management and collaboration +- **Account Setup**: Ensure your personal GitHub account is added to the organization + +### Integrated Development Environments (IDEs) +#### Cursor + +- **Purpose**: AI-powered code editor with built-in AI assistance +- **URL**: [https://cursor.sh/](https://cursor.sh/) +- **What it does**: + - AI-powered code completion and generation + - Intelligent code refactoring and debugging + - Natural language to code translation + - Integration with popular extensions and themes +- **Account Setup**: Request team access from your director or tech lead and access with your Linux Foundation email account + +#### Zed + +- **Purpose**: High-performance, collaborative code editor +- **URL**: [https://zed.dev/](https://zed.dev/) +- **What it does**: + - Lightning-fast performance with native speed + - Real-time collaborative editing + - Built-in terminal and Git integration + - Minimalist design with powerful features +- **Account Setup**: Download and install from website, account required for collaboration features + +#### Neovim + +- **Purpose**: Modern, extensible terminal-based text editor +- **URL**: [https://neovim.io/](https://neovim.io/) +- **What it does**: + - Highly customizable and extensible + - Powerful keyboard-driven editing + - Extensive plugin ecosystem + - Lua scripting for configuration +- **Account Setup**: Install via package manager or from website, configuration is local + +--- + +## πŸ“ˆ LFX Platforms + +### 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) +- **What to do**: Review the list and follow the guide of the platforms you need to work with + +--- + +## πŸ—οΈ Platform Environments + +### Development Environment +- **Purpose**: Development environment for testing new features and changes +- **URL**: [https://pcc.dev.platform.linuxfoundation.org/](https://pcc.dev.platform.linuxfoundation.org/) +- **Access**: All developers should have access + +### Staging Environment +- **Purpose**: Pre-production environment for final testing before deployment +- **URL**: [https://pcc.staging.platform.linuxfoundation.org/](https://pcc.staging.platform.linuxfoundation.org/) +- **Access**: All developers should have access + +### Production Environment +- **Purpose**: Live production environment serving end users +- **URL**: [https://projectadmin.lfx.linuxfoundation.org/](https://projectadmin.lfx.linuxfoundation.org/) +- **Access**: View-only for most developers, deployment access restricted + +--- + +## πŸ—ƒοΈ API Documentation + +### API Gateway +- **Purpose**: Central API gateway for routing and managing API requests +- **URL**: [https://api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) +- **What it does**: + - Centralized API endpoint management + - API documentation + - Authentication and authorization +- **Account Setup**: Request invitation from your manager or tech lead + +--- + +## πŸ“‹ Project Management & Collaboration + +### Jira +- **Purpose**: Issue tracking, project management, and agile development workflows +- **URL**: [https://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) +- **What it does**: + - Track bugs, features, and technical debt + - Sprint planning and agile workflows + - Project roadmap and release planning +- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account + +--- + +## πŸ“Š Monitoring and Analytics + +### DataDog +- **Purpose**: Application performance monitoring, logging, and infrastructure metrics +- **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) +- **What it does**: + - Monitor application performance and uptime + - View logs and traces for debugging + - Track infrastructure metrics and alerts +- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account + +### Snowflake +- **Purpose**: Cloud data platform for data warehousing and analytics +- **URL**: [https://www.snowflake.com/en/](https://www.snowflake.com/en/) +- **What it does**: + - Data storage and processing + - Business intelligence queries + - Analytics and reporting +- **Account Setup**: Request invitation from your manager 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**: + - **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 + +--- + +## πŸ“ Documents & Internal Tools + +### Google Workspace +- **Google Drive**: [https://drive.google.com/](https://drive.google.com/) + - **Purpose**: File storage, sharing, and collaboration +- **Account Setup**: Access with your Linux Foundation email account + +- **Google Docs**: [https://docs.google.com/](https://docs.google.com/) + - **Purpose**: Document creation and collaborative editing +- **Account Setup**: Access with your Linux Foundation email account + +### LFX Tools +- **Individual Dashboard**: [https://openprofile.dev/](https://openprofile.dev/) + - **Purpose**: Personal profile and contribution tracking for Linux Foundation projects +- **Account Setup**: Access with your Linux Foundation email account + +- **Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) + - **Purpose**: Internal Linux Foundation tool for time off tracking +- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account + +--- + +## πŸ†˜ Getting Help + +If you need access to any of these tools or have questions about their usage: + +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) + +--- + +## πŸ“ Notes for New Developers + +- **Bookmark this page** for quick reference +- **Ask questions** - the team is here to help you get up to speed +- **Keep credentials secure** - always use 1Password for storing sensitive information +- **Follow environment protocols** - always test in dev/staging before production + +--- + +## πŸ”„ Keeping This File Updated + +This document should be updated whenever: +- New tools are adopted by the team +- URLs or access procedures change +- Tools are deprecated or replaced + +--- + +*For questions about this documentation or updates to this document, please submit a pull request or contact the development team.* + diff --git a/onboarding/lf-platforms-list.md b/onboarding/lf-platforms-list.md new file mode 100644 index 0000000..7d8c1d5 --- /dev/null +++ b/onboarding/lf-platforms-list.md @@ -0,0 +1,30 @@ +# Linux Foundation Platforms - Developer Setup Guide + +This guide provides setup instructions and getting started resources for key Linux Foundation platforms that developers work with directly. + +## πŸš€ 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 + +--- + +## πŸ—οΈ Development Platforms + +### 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) + +--- + +## πŸ†˜ 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 + +--- + +*This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code! From 4270140a6c558defe82de6014b15fe49c8a45c82 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Wed, 20 Aug 2025 21:00:02 -0500 Subject: [PATCH 02/14] fix: update lf-platforms-list to lfx-platforms-list Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/frontend.md | 2 +- onboarding/{lf-platforms-list.md => lfx-platforms-list.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename onboarding/{lf-platforms-list.md => lfx-platforms-list.md} (100%) diff --git a/onboarding/frontend.md b/onboarding/frontend.md index 4164da8..2f56d08 100644 --- a/onboarding/frontend.md +++ b/onboarding/frontend.md @@ -76,7 +76,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ### 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) +- **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) - **What to do**: Review the list and follow the guide of the platforms you need to work with --- diff --git a/onboarding/lf-platforms-list.md b/onboarding/lfx-platforms-list.md similarity index 100% rename from onboarding/lf-platforms-list.md rename to onboarding/lfx-platforms-list.md From 5a515a915966cd61457fd946d054d14ff3fbf776 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Wed, 20 Aug 2025 23:03:17 -0400 Subject: [PATCH 03/14] fix: update lint header spacing Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/frontend.md | 15 +++++++++++++++ onboarding/lfx-platforms-list.md | 1 + 2 files changed, 16 insertions(+) diff --git a/onboarding/frontend.md b/onboarding/frontend.md index 2f56d08..dea4ed5 100644 --- a/onboarding/frontend.md +++ b/onboarding/frontend.md @@ -14,6 +14,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ” Security and Access Management ### 1Password + - **Purpose**: Password management and secure credential storage - **URL**: [https://1password.com/](https://1password.com/) - **What it does**: @@ -28,6 +29,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ”§ Development Tools ### Version Control - GitHub + - **Main Organization**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) - **Key Repositories**: - **PCC Repository**: [https://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) @@ -37,6 +39,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Account Setup**: Ensure your personal GitHub account is added to the organization ### Integrated Development Environments (IDEs) + #### Cursor - **Purpose**: AI-powered code editor with built-in AI assistance @@ -75,6 +78,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ“ˆ LFX Platforms ### 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) - **What to do**: Review the list and follow the guide of the platforms you need to work with @@ -84,16 +88,19 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ—οΈ Platform Environments ### Development Environment + - **Purpose**: Development environment for testing new features and changes - **URL**: [https://pcc.dev.platform.linuxfoundation.org/](https://pcc.dev.platform.linuxfoundation.org/) - **Access**: All developers should have access ### Staging Environment + - **Purpose**: Pre-production environment for final testing before deployment - **URL**: [https://pcc.staging.platform.linuxfoundation.org/](https://pcc.staging.platform.linuxfoundation.org/) - **Access**: All developers should have access ### Production Environment + - **Purpose**: Live production environment serving end users - **URL**: [https://projectadmin.lfx.linuxfoundation.org/](https://projectadmin.lfx.linuxfoundation.org/) - **Access**: View-only for most developers, deployment access restricted @@ -103,6 +110,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ—ƒοΈ API Documentation ### API Gateway + - **Purpose**: Central API gateway for routing and managing API requests - **URL**: [https://api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) - **What it does**: @@ -116,6 +124,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ“‹ Project Management & Collaboration ### Jira + - **Purpose**: Issue tracking, project management, and agile development workflows - **URL**: [https://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) - **What it does**: @@ -129,6 +138,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ“Š Monitoring and Analytics ### DataDog + - **Purpose**: Application performance monitoring, logging, and infrastructure metrics - **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) - **What it does**: @@ -138,6 +148,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account ### Snowflake + - **Purpose**: Cloud data platform for data warehousing and analytics - **URL**: [https://www.snowflake.com/en/](https://www.snowflake.com/en/) - **What it does**: @@ -151,6 +162,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## Design & Planning ### Whimsical + - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps - **URL**: [https://whimsical.com/](https://whimsical.com/) - **Key Workspaces**: @@ -163,6 +175,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **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**: @@ -179,6 +192,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸ“ Documents & Internal Tools ### Google Workspace + - **Google Drive**: [https://drive.google.com/](https://drive.google.com/) - **Purpose**: File storage, sharing, and collaboration - **Account Setup**: Access with your Linux Foundation email account @@ -188,6 +202,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Account Setup**: Access with your Linux Foundation email account ### LFX Tools + - **Individual Dashboard**: [https://openprofile.dev/](https://openprofile.dev/) - **Purpose**: Personal profile and contribution tracking for Linux Foundation projects - **Account Setup**: Access with your Linux Foundation email account diff --git a/onboarding/lfx-platforms-list.md b/onboarding/lfx-platforms-list.md index 7d8c1d5..89ab491 100644 --- a/onboarding/lfx-platforms-list.md +++ b/onboarding/lfx-platforms-list.md @@ -14,6 +14,7 @@ This guide provides setup instructions and getting started resources for key Lin ## πŸ—οΈ Development Platforms ### 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) From 3d95850437617c5aa980f9e283f3a54ef05a389b Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Thu, 21 Aug 2025 19:11:26 +0200 Subject: [PATCH 04/14] fix: update linting issues Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/frontend.md | 34 +++++++------------------------- onboarding/lfx-platforms-list.md | 6 ++++-- 2 files changed, 11 insertions(+), 29 deletions(-) diff --git a/onboarding/frontend.md b/onboarding/frontend.md index dea4ed5..1944abc 100644 --- a/onboarding/frontend.md +++ b/onboarding/frontend.md @@ -32,8 +32,9 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Main Organization**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) - **Key Repositories**: - - **PCC Repository**: [https://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - - **ITX Repository**: [https://github.com/linuxfoundation-it](https://github.com/linuxfoundation-it) + - **PCC (Project Control Center)**: [https://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) + - **ITX**: [https://github.com/linuxfoundation-it](https://github.com/linuxfoundation-it) + - **LFX V2 PCC UI**: [https://github.com/linuxfoundation/lfx-v2-pcc-ui](https://github.com/linuxfoundation/lfx-v2-pcc-ui) - **Engineering Artifact and Notes Repository**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - **Purpose**: Source code management and collaboration - **Account Setup**: Ensure your personal GitHub account is added to the organization @@ -85,28 +86,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie --- -## πŸ—οΈ Platform Environments - -### Development Environment - -- **Purpose**: Development environment for testing new features and changes -- **URL**: [https://pcc.dev.platform.linuxfoundation.org/](https://pcc.dev.platform.linuxfoundation.org/) -- **Access**: All developers should have access - -### Staging Environment - -- **Purpose**: Pre-production environment for final testing before deployment -- **URL**: [https://pcc.staging.platform.linuxfoundation.org/](https://pcc.staging.platform.linuxfoundation.org/) -- **Access**: All developers should have access - -### Production Environment - -- **Purpose**: Live production environment serving end users -- **URL**: [https://projectadmin.lfx.linuxfoundation.org/](https://projectadmin.lfx.linuxfoundation.org/) -- **Access**: View-only for most developers, deployment access restricted - ---- - ## πŸ—ƒοΈ API Documentation ### API Gateway @@ -117,7 +96,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Centralized API endpoint management - API documentation - Authentication and authorization -- **Account Setup**: Request invitation from your manager or tech lead --- @@ -141,7 +119,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Purpose**: Application performance monitoring, logging, and infrastructure metrics - **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) -- **What it does**: +- **What it does**: - Monitor application performance and uptime - View logs and traces for debugging - Track infrastructure metrics and alerts @@ -234,11 +212,13 @@ If you need access to any of these tools or have questions about their usage: ## πŸ”„ Keeping This File Updated This document should be updated whenever: + - New tools are adopted by the team - URLs or access procedures change - Tools are deprecated or replaced --- -*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 updates to this document, please submit a pull request +or contact the development team.* diff --git a/onboarding/lfx-platforms-list.md b/onboarding/lfx-platforms-list.md index 89ab491..c8f7d6a 100644 --- a/onboarding/lfx-platforms-list.md +++ b/onboarding/lfx-platforms-list.md @@ -1,6 +1,7 @@ # Linux Foundation Platforms - Developer Setup Guide -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. ## πŸš€ Getting Started @@ -28,4 +29,5 @@ This guide provides setup instructions and getting started resources for key Lin --- -*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! From 2a07d7670abc25ef06113215ced2ee950c14faf7 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Thu, 21 Aug 2025 19:48:39 +0200 Subject: [PATCH 05/14] fix: remove Documentation of PCC, update to a general tools and platform repo Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- ...nd.md => developer-tools-and-platforms.md} | 49 +++++++++---------- onboarding/lfx-platforms-list.md | 33 ------------- 2 files changed, 22 insertions(+), 60 deletions(-) rename onboarding/{frontend.md => developer-tools-and-platforms.md} (75%) delete mode 100644 onboarding/lfx-platforms-list.md diff --git a/onboarding/frontend.md b/onboarding/developer-tools-and-platforms.md similarity index 75% rename from onboarding/frontend.md rename to onboarding/developer-tools-and-platforms.md index 1944abc..6d2a7c9 100644 --- a/onboarding/frontend.md +++ b/onboarding/developer-tools-and-platforms.md @@ -22,23 +22,28 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Generate strong passwords - Secure notes and documents - Two-factor authentication backup -- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account +- **Account Setup**: Access with your Linux Foundation email account --- -## πŸ”§ Development Tools +## GitHub Repositories + +### Linux Foundation -### Version Control - GitHub +- **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 + +### Engineering Artifact and Notes -- **Main Organization**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) -- **Key Repositories**: - - **PCC (Project Control Center)**: [https://github.com/linuxfoundation/lfx-pcc](https://github.com/linuxfoundation/lfx-pcc) - - **ITX**: [https://github.com/linuxfoundation-it](https://github.com/linuxfoundation-it) - - **LFX V2 PCC UI**: [https://github.com/linuxfoundation/lfx-v2-pcc-ui](https://github.com/linuxfoundation/lfx-v2-pcc-ui) - - **Engineering Artifact and Notes Repository**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) -- **Purpose**: Source code management and collaboration +- **Purpose**: Collection of artifacts and notes for engineers +- **URL**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) - **Account Setup**: Ensure your personal GitHub account is added to the organization +--- + +## πŸ”§ Development Tools + ### Integrated Development Environments (IDEs) #### Cursor @@ -50,7 +55,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Intelligent code refactoring and debugging - Natural language to code translation - Integration with popular extensions and themes -- **Account Setup**: Request team access from your director or tech lead and access with your Linux Foundation email account +- **Account Setup**: Access with your Linux Foundation email account #### Zed @@ -76,16 +81,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie --- -## πŸ“ˆ LFX Platforms - -### 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) -- **What to do**: Review the list and follow the guide of the platforms you need to work with - ---- - ## πŸ—ƒοΈ API Documentation ### API Gateway @@ -109,7 +104,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Track bugs, features, and technical debt - Sprint planning and agile workflows - Project roadmap and release planning -- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account +- **Account Setup**: Access with your Linux Foundation email account --- @@ -123,7 +118,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Monitor application performance and uptime - View logs and traces for debugging - Track infrastructure metrics and alerts -- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account +- **Account Setup**: Access with your Linux Foundation email account ### Snowflake @@ -133,7 +128,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Data storage and processing - Business intelligence queries - Analytics and reporting -- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account +- **Account Setup**: Access with your Linux Foundation email account --- @@ -150,7 +145,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Document processes and workflows - Collaborate on designs and architecture - Mind mapping and brainstorming -- **Account Setup**: Request invitation from your manager or tech lead +- **Account Setup**: Access with your Linux Foundation email account ### Lucidchart @@ -163,7 +158,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - 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 +- **Account Setup**: Access with your Linux Foundation email account --- @@ -187,7 +182,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) - **Purpose**: Internal Linux Foundation tool for time off tracking -- **Account Setup**: Request invitation from your manager or tech lead and access with your Linux Foundation email account +- **Account Setup**: Access with your Linux Foundation email account --- diff --git a/onboarding/lfx-platforms-list.md b/onboarding/lfx-platforms-list.md deleted file mode 100644 index c8f7d6a..0000000 --- a/onboarding/lfx-platforms-list.md +++ /dev/null @@ -1,33 +0,0 @@ -# Linux Foundation Platforms - Developer Setup Guide - -This guide provides setup instructions and getting started resources for key Linux Foundation -platforms that developers work with directly. - -## πŸš€ 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 - ---- - -## πŸ—οΈ Development Platforms - -### 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) - ---- - -## πŸ†˜ 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 - ---- - -*This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build -their local environment and actively contribute code! From 4af33dd643af4e0cde7751c128e53ca95cc4b5d6 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Thu, 21 Aug 2025 23:26:52 +0200 Subject: [PATCH 06/14] fix: remove repeatative wording Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/developer-tools-and-platforms.md | 108 ++++++++++---------- 1 file changed, 55 insertions(+), 53 deletions(-) diff --git a/onboarding/developer-tools-and-platforms.md b/onboarding/developer-tools-and-platforms.md index 6d2a7c9..9580709 100644 --- a/onboarding/developer-tools-and-platforms.md +++ b/onboarding/developer-tools-and-platforms.md @@ -4,10 +4,11 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ## πŸš€ Getting Started -1. **Review this entire document** to understand our tech stack +1. **Review this entire document** to understand our tech tools and platforms 2. **Request access** to all relevant platforms (see each section for account setup instructions) -3. **Contact your manager or IT team** if you need help with access to any platform -4. **Bookmark this page** for quick reference πŸ˜€ +3. **Access platforms** with your Linux Foundation email account, unless otherwise noted +4. **Contact your manager or IT team** if you need help with access to any platform +5. **Bookmark this page** for quick reference πŸ˜€ --- @@ -22,7 +23,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Generate strong passwords - Secure notes and documents - Two-factor authentication backup -- **Account Setup**: Access with your Linux Foundation email account --- @@ -38,7 +38,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Purpose**: Collection of artifacts and notes for engineers - **URL**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) -- **Account Setup**: Ensure your personal GitHub account is added to the organization +- **Account Access**: Ensure your personal GitHub account is added to the organization --- @@ -55,7 +55,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Intelligent code refactoring and debugging - Natural language to code translation - Integration with popular extensions and themes -- **Account Setup**: Access with your Linux Foundation email account #### Zed @@ -66,7 +65,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Real-time collaborative editing - Built-in terminal and Git integration - Minimalist design with powerful features -- **Account Setup**: Download and install from website, account required for collaboration features #### Neovim @@ -77,7 +75,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scripting for configuration -- **Account Setup**: Install via package manager or from website, configuration is local --- @@ -90,7 +87,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **What it does**: - Centralized API endpoint management - API documentation - - Authentication and authorization --- @@ -104,7 +100,6 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Track bugs, features, and technical debt - Sprint planning and agile workflows - Project roadmap and release planning -- **Account Setup**: Access with your Linux Foundation email account --- @@ -116,9 +111,8 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) - **What it does**: - Monitor application performance and uptime - - View logs and traces for debugging + - View logs and screen recorded sessions for debugging - Track infrastructure metrics and alerts -- **Account Setup**: Access with your Linux Foundation email account ### Snowflake @@ -128,61 +122,70 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Data storage and processing - Business intelligence queries - Analytics and reporting -- **Account Setup**: Access with your Linux Foundation email account --- -## Design & Planning +## Organization Diagram -### Whimsical +### LFX-Datalake -- **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**: Access with your Linux Foundation email account - -### 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**: Access with your Linux Foundation email account +- **Purpose**: Architecture diagram showing LFX services, data flows, and system dependencies +- **URL**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) + +### Linux Product & Engineering organization + +- **Purpose**: Organizational chart with team structure, roles, responsibilities, and reporting relationships +- **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#) --- -## πŸ“ Documents & Internal Tools +## πŸ“ Documents ### Google Workspace -- **Google Drive**: [https://drive.google.com/](https://drive.google.com/) - - **Purpose**: File storage, sharing, and collaboration -- **Account Setup**: Access with your Linux Foundation email account +#### Google Docs + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://drive.google.com/](https://drive.google.com/) + +#### Google Spreadsheets + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/spreadsheets/](https://docs.google.com/spreadsheets/) + +#### Google Slides + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/presentation/](https://docs.google.com/presentation/) -- **Google Docs**: [https://docs.google.com/](https://docs.google.com/) - - **Purpose**: Document creation and collaborative editing -- **Account Setup**: Access with your Linux Foundation email account +#### Google Vids -### LFX Tools +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/videos](https://docs.google.com/video) -- **Individual Dashboard**: [https://openprofile.dev/](https://openprofile.dev/) - - **Purpose**: Personal profile and contribution tracking for Linux Foundation projects -- **Account Setup**: Access with your Linux Foundation email account +#### Google Forms -- **Calamari**: [http://lfx.calamari.io/](http://lfx.calamari.io/) - - **Purpose**: Internal Linux Foundation tool for time off tracking -- **Account Setup**: Access with your Linux Foundation email account +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/forms](https://docs.google.com/forms) + +#### Google Drive + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://drive.google.com/](https://drive.google.com/) + +--- + +## πŸ”¦ Internal Tools + +### Individual Dashboard + +- **Purpose**: Personal profile and contribution tracking for Linux Foundation projects +- **URL**: [https://openprofile.dev/](https://openprofile.dev/) + +### Calamari + +- **Purpose**: Internal Linux Foundation tool for time off tracking +- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) --- @@ -216,4 +219,3 @@ This document should be updated whenever: *For questions about this documentation or updates to this document, please submit a pull request or contact the development team.* - From 8f5453dd8a9a236806c7d8517e1e1fd7a082a854 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Thu, 21 Aug 2025 23:31:12 +0200 Subject: [PATCH 07/14] fix: remove repeatative wording Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/developer-tools-and-platforms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/onboarding/developer-tools-and-platforms.md b/onboarding/developer-tools-and-platforms.md index 9580709..664f8d7 100644 --- a/onboarding/developer-tools-and-platforms.md +++ b/onboarding/developer-tools-and-platforms.md @@ -182,7 +182,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **Purpose**: Personal profile and contribution tracking for Linux Foundation projects - **URL**: [https://openprofile.dev/](https://openprofile.dev/) -### Calamari +### Calamari - **Purpose**: Internal Linux Foundation tool for time off tracking - **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) From 43df9759d6c6344748bf6746936dfac3f3e486a2 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Thu, 21 Aug 2025 23:50:39 +0200 Subject: [PATCH 08/14] fix: update account access details Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/developer-tools-and-platforms.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/onboarding/developer-tools-and-platforms.md b/onboarding/developer-tools-and-platforms.md index 664f8d7..b8e153e 100644 --- a/onboarding/developer-tools-and-platforms.md +++ b/onboarding/developer-tools-and-platforms.md @@ -32,7 +32,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **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 +- **Account Access**: Ensure your personal GitHub account is added to the organization ### Engineering Artifact and Notes @@ -55,6 +55,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Intelligent code refactoring and debugging - Natural language to code translation - Integration with popular extensions and themes +- **Account Access**: Request access to our team plan. #### Zed @@ -65,6 +66,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Real-time collaborative editing - Built-in terminal and Git integration - Minimalist design with powerful features +- **Account Access**: Requesting access not required. Download and install. #### Neovim @@ -75,6 +77,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - Powerful keyboard-driven editing - Extensive plugin ecosystem - Lua scripting for configuration +- **Account Access**: Requesting access required. Download and install. --- @@ -179,7 +182,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie ### Individual Dashboard -- **Purpose**: Personal profile and contribution tracking for Linux Foundation projects +- **Purpose**: Personal profile, view your events and meetings and technical contribution and training enrollment tracking - **URL**: [https://openprofile.dev/](https://openprofile.dev/) ### Calamari From b6d2c0309d71dfad046a2d55cdecaba6bc13f651 Mon Sep 17 00:00:00 2001 From: David Deal Date: Thu, 21 Aug 2025 22:19:23 -0700 Subject: [PATCH 09/14] Resolved Markdown Lint Issue Signed-off-by: David Deal --- onboarding/developer-tools-and-platforms.md | 1 - 1 file changed, 1 deletion(-) diff --git a/onboarding/developer-tools-and-platforms.md b/onboarding/developer-tools-and-platforms.md index 6d2a7c9..3024f10 100644 --- a/onboarding/developer-tools-and-platforms.md +++ b/onboarding/developer-tools-and-platforms.md @@ -216,4 +216,3 @@ This document should be updated whenever: *For questions about this documentation or updates to this document, please submit a pull request or contact the development team.* - From dc9e279066e907e3ea711a010c379001d72b2faf Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Fri, 22 Aug 2025 17:19:51 +0200 Subject: [PATCH 10/14] chore: update developer tools and platforms documentation 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) --- .../cursor.md | 241 ++++++++++ .../neovim.md | 154 +++++++ .../code-editor-extensions-and-plugins/zed.md | 130 ++++++ onboarding/developer-tools-and-platforms.md | 264 ----------- onboarding/development-tools-and-platforms.md | 413 ++++++++++++++++++ 5 files changed, 938 insertions(+), 264 deletions(-) create mode 100644 onboarding/code-editor-extensions-and-plugins/cursor.md create mode 100644 onboarding/code-editor-extensions-and-plugins/neovim.md create mode 100644 onboarding/code-editor-extensions-and-plugins/zed.md delete mode 100644 onboarding/developer-tools-and-platforms.md create mode 100644 onboarding/development-tools-and-platforms.md diff --git a/onboarding/code-editor-extensions-and-plugins/cursor.md b/onboarding/code-editor-extensions-and-plugins/cursor.md new file mode 100644 index 0000000..f60f0a8 --- /dev/null +++ b/onboarding/code-editor-extensions-and-plugins/cursor.md @@ -0,0 +1,241 @@ +# Cursor Extensions + +Welcome to the Linux Foundation development team! This guide provides recommended extensions for the Cursor code editor. + +## πŸš€ Getting Started + +1. **Review this entire document** to understand our recommended extensions and plugins +2. **Install the extensions relevant** to your development workflow +2. **Bookmark this page** for quick reference when setting up new development environments πŸ˜€ + +--- + +## 🎯 Cursor Extensions + +### General Extensions + +#### GitLens + +- **Purpose**: Enhanced Git capabilities and code history visualization +- **Extension ID**: `eamodio.gitlens` + +**What you'll use GitLens for:** + - View detailed Git blame information inline with code + - Explore file and line history with rich visualizations + - Navigate through repository and branch history + - Compare changes across commits and branches + - Understand code evolution and contributor insights + +#### Prettier - Code formatter + +- **Purpose**: Automatic code formatting for consistent style +- **Extension ID**: `esbenp.prettier-vscode` + +**What you'll use Prettier for:** + - Automatically format code on save according to team standards + - Ensure consistent code style across all team members + - Integration with our ESLint configuration for comprehensive code quality + +#### ESLint + +- **Purpose**: JavaScript and TypeScript linting for code quality +- **Extension ID**: `dbaeumer.vscode-eslint` + +**What you'll use ESLint for:** + - Real-time code quality checking and error detection + - Enforce team coding standards and best practices + - Automatic fixing of common issues and style violations + - Custom rule configuration for project-specific requirements + +#### Auto Rename Tag + +- **Purpose**: Automatically rename paired HTML/XML tags +- **Extension ID**: `formulahendry.auto-rename-tag` + +**What you'll use Auto Rename Tag for:** + - Simultaneously rename opening and closing HTML/XML tags + - Prevent mismatched tags when refactoring markup + - Maintain tag consistency in React components + +#### Auto Close Tag + +- **Purpose**: Automatically close HTML/XML tags +- **Extension ID**: formulahendry.auto-close-tag + +**What you'll use Auto Close Tag for**: + - Automatically add closing tags when typing opening tags + - Support for custom HTML elements and React components + - Reduce typing and prevent unclosed tag errors + - Speed up markup development workflows + +#### Docker + +- **Purpose**: Docker container management and development +- **Extension ID**: `ms-azuretools.vscode-docker` + +**What you'll use Docker for:** + - Build, manage, and deploy Docker containers + - IntelliSense for Dockerfile and docker-compose files + - Container and image management from within the editor + - Integration with remote development containers + +#### Path Intellisense + +- **Extension ID**: christian-kohler.path-intellisense +- **Purpose**: Autocomplete for file paths in import statements + +**What you'll use Path Intellisense for**: + - Intelligent autocompletion for file and folder paths + - Reduce typos in import statements and file references + - Navigate project structure more efficiently + - Support for relative and absolute path completion + +#### CodeRabbit + +- **Extension ID**: coderabbitai.coderabbit +- **Purpose**: AI-powered code review and analysis + +**What you'll use CodeRabbit for**: + - Real-time code review suggestions and improvements + - Automated code quality analysis and recommendations + - Security vulnerability detection in your code + - Performance optimization suggestions + - Code style and best practice enforcement + + +### Workflow Specific Extensions + +#### Angular Language Service +- **Purpose**: Enhanced Angular development with IntelliSense and diagnostics +- **Extension ID**: `Angular.ng-template` + +**What you'll use Angular Language Service for:** + - IntelliSense and autocompletion in Angular templates + - Real-time error detection in component templates + - Navigation between templates and component code + - Type checking for Angular expressions and directives + - Quick fixes and refactoring support for Angular projects + +#### Angular Schematics +- **Purpose**: Generate Angular code and project structures using schematics +- **Extension ID**: `cyrilletuzi.angular-schematics` + +**What you'll use Angular Schematics for:** + - Generate components, services, modules, and other Angular artifacts + - Scaffold new Angular applications and libraries + - Apply code transformations and migrations + - Maintain consistent project structure across team + - Integrate with Angular CLI workflows + +#### Pretty TypeScript Errors +- **Purpose**: Improved TypeScript error messages with better formatting +- **Extension ID**: `yoavbls.pretty-ts-errors` + +**What you'll use Pretty TypeScript Errors for:** + - Display TypeScript errors with improved readability and formatting + - Better understanding of complex type errors and suggestions + - Reduced cognitive load when debugging TypeScript issues + - Enhanced developer experience with clearer error messages + +#### Tailwind CSS IntelliSense +- **Purpose**: Intelligent autocomplete and linting for Tailwind CSS +- **Extension ID**: `bradlc.vscode-tailwindcss` + +**What you'll use Tailwind CSS IntelliSense for:** + - Autocomplete for Tailwind CSS class names + - Hover previews showing the actual CSS properties + - Linting and validation of Tailwind classes + - Color previews and syntax highlighting + - Support for custom Tailwind configurations + +#### Claude Code for VSCode +- **Purpose**: AI-powered coding assistance integrated directly in your editor +- **Extension ID**: `Anthropic.claude-dev` + +**What you'll use Claude Code for VSCode for:** + - AI-powered code completion and suggestions + - Intelligent code refactoring and optimization + - Natural language code generation and explanations + - Debugging assistance and error resolution + - Code review and improvement recommendations + +#### Go +- **Purpose**: Official Go language support with comprehensive tooling +- **Extension ID**: `golang.go` + +**What you'll use Go for:** + - Syntax highlighting and code completion for Go + - Integrated debugging with delve debugger + - Automatic code formatting with gofmt on save + - Test discovery and execution within the editor + - Import management and dependency resolution + - Integration with Go tools (go mod, go build, go test) + +#### REST Client +- **Purpose**: Test REST APIs directly from within the editor +- **Extension ID**: `humao.rest-client` + +**What you'll use REST Client for:** + - Send HTTP requests and view responses without leaving the editor + - Save and organize API requests in .http files + - Environment variable support for different deployment stages + - Authentication support (Bearer tokens, Basic auth) + - Response formatting and syntax highlighting + +#### Thunder Client +- **Purpose**: Lightweight REST API testing client +- **Extension ID**: `rangav.vscode-thunder-client` + +**What you'll use Thunder Client for:** + - GUI-based API testing with collections and environments + - Import/export Postman collections + - Scriptless testing with pre-request and test scripts + - Response history and request organization + - Team collaboration with shared collections + +#### PostgreSQL +- **Purpose**: PostgreSQL syntax highlighting and query execution +- **Extension ID**: `ms-ossdata.vscode-postgresql` + +**What you'll use PostgreSQL for:** + - Syntax highlighting for PostgreSQL-specific SQL + - IntelliSense for PostgreSQL functions and keywords + - Query execution and result visualization + - Connection management for PostgreSQL databases + - Schema browsing and table structure viewing + +#### YAML +- **Purpose**: YAML language support with validation and formatting +- **Extension ID**: `redhat.vscode-yaml` + +**What you'll use YAML for:** + - Syntax highlighting and validation for YAML files + - Schema validation for Kubernetes, Docker Compose, and CI/CD files + - Auto-completion based on YAML schemas + - Formatting and indentation correction + - Error detection and quick fixes + +#### Kubernetes +- **Purpose**: Kubernetes cluster management and YAML editing +- **Extension ID**: `ms-kubernetes-tools.vscode-kubernetes-tools` + +**What you'll use Kubernetes for:** + - Deploy and manage Kubernetes applications + - Browse cluster resources and view logs + - IntelliSense for Kubernetes YAML manifests + - Port forwarding and terminal access to pods + - Helm chart development and deployment + +#### Vue Language Features + +- **Extension ID**: Vue.volar +- **Purpose**: Official Vue.js language server with TypeScript support + +**What you'll use Vue Language Features for**: +- Advanced TypeScript support in Vue components +- Better performance and accuracy than legacy Vue extensions +- Composition API and script setup syntax support +- Template type checking and validation +- Integration with Vue 3 features and modern Vue development + +--- diff --git a/onboarding/code-editor-extensions-and-plugins/neovim.md b/onboarding/code-editor-extensions-and-plugins/neovim.md new file mode 100644 index 0000000..e9f49c3 --- /dev/null +++ b/onboarding/code-editor-extensions-and-plugins/neovim.md @@ -0,0 +1,154 @@ +# Neovim Plugins + +Welcome to the Linux Foundation development team! This guide provides recommended plugins for the Neovim code editor. + +## πŸš€ Getting Started + +1. **Review this entire document** to understand our recommended extensions and plugins +2. **Bookmark this page** for quick reference when setting up new development environments πŸ˜€ + +--- + +## πŸ”§ Neovim Plugins + +### Plugin Manager + +#### 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:** +- Lazy-loading plugins for faster startup times +- Automatic plugin installation and updates +- Dependency management between plugins +- Performance optimization and configuration management + +### Essential Plugins + +#### nvim-treesitter + +- **Repository**: [https://github.com/nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) +- **Purpose**: Advanced syntax highlighting and code understanding + +**What you'll use nvim-treesitter for:** +- Superior syntax highlighting for 40+ languages +- Intelligent code folding and text objects +- Incremental parsing for large files +- Foundation for other advanced plugins + +#### telescope.nvim + +- **Repository**: [https://github.com/nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) +- **Purpose**: Fuzzy finder and picker for files, buffers, and more + +**What you'll use telescope.nvim for:** +- Quick file navigation and opening +- Search through project files and content +- Git integration for branch and commit browsing +- Command palette functionality + +#### nvim-lspconfig + +- **Repository**: [https://github.com/neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) +- **Purpose**: Easy Language Server Protocol configuration + +**What you'll use nvim-lspconfig for:** +- Configure language servers for your programming languages +- IntelliSense, go-to-definition, and error diagnostics +- Code actions and refactoring capabilities +- Integration with completion and formatting plugins + +#### nvim-cmp + +- **Repository**: [https://github.com/hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp) +- **Purpose**: Autocompletion engine with multiple sources + +**What you'll use nvim-cmp for:** +- Intelligent code completion from LSP servers +- Snippet expansion and management +- Buffer and path completion +- Integration with external completion sources + +#### gitsigns.nvim + +- **Repository**: [https://github.com/lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) +- **Purpose**: Git integration with signs, hunks, and blame + +**What you'll use gitsigns.nvim for:** +- Visual Git diff indicators in the sign column +- Stage and unstage hunks directly from the editor +- Navigate through Git changes efficiently +- Inline Git blame information + +#### fugitive.vim + +- **Repository**: [https://github.com/tpope/vim-fugitive](https://github.com/tpope/vim-fugitive) +- **Purpose**: Comprehensive Git wrapper for Vim/Neovim + +**What you'll use fugitive.vim for:** +- Complete Git workflow from within Neovim +- Interactive staging and committing +- Branch management and merging +- Git history browsing and comparison + +#### nvim-tree.lua + +- **Repository**: [https://github.com/nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua) +- **Purpose**: File explorer tree for Neovim + +**What you'll use nvim-tree.lua for:** +- Visual file system navigation +- File and directory operations +- Project structure overview +- Integration with Git status indicators + +#### lualine.nvim + +- **Repository**: [https://github.com/nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) +- **Purpose**: Fast and customizable statusline for Neovim + +**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 + +#### undotree + +- **Repository**: [https://github.com/mbbill/undotree](https://github.com/mbbill/undotree) +- **Purpose**: Visual undo history tree for advanced undo/redo operations + +**What you'll use undotree for**: + - Navigate complex undo/redo history with visual tree representation + - Recover lost changes from branched undo paths + - Compare different states of your file during editing sessions + - Advanced text recovery and change management + +#### avante.nvim + +- **Repository**: https://github.com/yetone/avante.nvim +- **Purpose**: AI-powered code editing and chat interface + +**What you'll use avante.nvim for**: + + - Interactive AI chat for code explanations and debugging + - AI-assisted code refactoring and optimization + - Natural language code generation and modification + - Inline AI suggestions and code improvements + +#### supermaven-nvim + +- **Repository**: https://github.com/supermaven-inc/supermaven-nvim +- **Purpose**: Fast AI code completion with context awareness + +**What you'll use supermaven-nvim for**: + - Lightning-fast AI-powered code suggestions and completions + - Context-aware code generation based on your entire codebase + - Multi-language support with optimized performance + - Seamless integration with existing completion workflows + +--- + +You can find a list of more plguins at [https://github.com/rockerBOO/awesome-neovim](https://github.com/rockerBOO/awesome-neovim) +--- diff --git a/onboarding/code-editor-extensions-and-plugins/zed.md b/onboarding/code-editor-extensions-and-plugins/zed.md new file mode 100644 index 0000000..004da2e --- /dev/null +++ b/onboarding/code-editor-extensions-and-plugins/zed.md @@ -0,0 +1,130 @@ +# Zed Extensions + +Welcome to the Linux Foundation development team! This guide provides recommended extensions for the Zed code editor. + +## πŸš€ Getting Started + +1. **Review this entire document** to understand our recommended extensions and plugins +2. **Install the extensions relevant** to your development workflow +2. **Bookmark this page** for quick reference when setting up new development environments πŸ˜€ + +--- + +## 🎯 Zed Extensions + +### General Extensions + +#### Git Firefly +- **Purpose**: Enhanced Git workflow visualization and management +- **Extension ID**: `git-firefly` + +**What you'll use Git Firefly for:** + - Advanced Git history visualization with interactive timelines + - Enhanced branch management and merge conflict resolution + - Commit message templates and conventional commit support + - Git workflow automation and custom git command integration + - Advanced diff viewing with side-by-side comparisons + + +#### Emmet +- **Purpose**: High-speed HTML and CSS coding with abbreviation expansion +- **Extension ID**: `emmet` (Built-in to Zed) + +**What you'll use Emmet for:** + - Rapid HTML structure creation using CSS selector syntax + - CSS property abbreviation expansion for faster styling + - Lorem ipsum text generation and placeholder content + - Number increment/decrement operations for batch editing + - Wrap with abbreviation for restructuring existing code + +### Workflow Specific Extensions + +#### HTML +- **Purpose**: HTML language support with syntax highlighting and validation +- **Extension ID**: `html` (Built-in to Zed) + +**What you'll use HTML for:** + - Syntax highlighting and code completion for HTML elements + - Auto-completion for HTML attributes and values + - Tag matching and validation for proper HTML structure + - Integration with CSS and JavaScript for full web development + - Emmet-like abbreviation expansion for rapid HTML authoring + +#### TOML +- **Purpose**: TOML configuration file support with syntax highlighting +- **Extension ID**: `toml` + +**What you'll use TOML for:** + - Syntax highlighting for TOML configuration files + - Validation and error detection for TOML syntax + - Auto-completion for common TOML structures + - Support for Cargo.toml, pyproject.toml, and other config files + - Formatting and indentation for clean configuration files + +#### SQL +- **Purpose**: SQL language support for database development +- **Extension ID**: `sql` + +**What you'll use SQL for:** + - Syntax highlighting for SQL queries across multiple database dialects + - IntelliSense for SQL keywords, functions, and database objects + - Query formatting and beautification for readable code + - Error detection and validation for SQL syntax + - Integration with database connections and query execution + +#### Dockerfile +- **Purpose**: Docker container development and configuration support +- **Extension ID**: `dockerfile` + +**What you'll use Dockerfile for:** + - Syntax highlighting and validation for Dockerfile instructions + - Auto-completion for Docker commands and best practices + - Linting and security recommendations for container builds + - Integration with Docker CLI for building and testing containers + - Support for multi-stage builds and advanced Docker features + +#### Angular +- **Purpose**: Angular framework development with comprehensive tooling +- **Extension ID**: `angular` + +**What you'll use Angular for:** + - Syntax highlighting and IntelliSense for Angular templates + - Component, service, and directive code completion + - TypeScript integration with Angular-specific decorators + - Template syntax validation and error detection + - Integration with Angular CLI for project scaffolding and builds + +#### Vue +- **Purpose**: Vue.js framework development with single-file component support +- **Extension ID**: `vue` + +**What you'll use Vue for:** + - Syntax highlighting for Vue single-file components (.vue) + - Template, script, and style section IntelliSense + - Vue 3 Composition API and Options API support + - Component props and emit validation + - Integration with Vue CLI and Vite development workflows + +#### SCSS +- **Purpose**: SCSS/Sass preprocessor support for advanced CSS development +- **Extension ID**: `scss` + +**What you'll use SCSS for:** + - Syntax highlighting for SCSS/Sass variables, mixins, and functions + - Auto-completion for SCSS-specific features and built-in functions + - Nesting validation and formatting for clean stylesheet structure + - Color preview and picker integration for visual development + - Compilation and error detection for SCSS to CSS transformation + +#### Terraform +- **Purpose**: Infrastructure as Code development with Terraform support +- **Extension ID**: `terraform` + +**What you'll use Terraform for:** + - Syntax highlighting for Terraform configuration files (.tf) + - IntelliSense for Terraform resources, providers, and modules + - Validation and linting for Terraform best practices + - Integration with Terraform CLI for plan, apply, and destroy operations + - Support for Terraform workspaces and state management + +--- diff --git a/onboarding/developer-tools-and-platforms.md b/onboarding/developer-tools-and-platforms.md deleted file mode 100644 index 45d2676..0000000 --- a/onboarding/developer-tools-and-platforms.md +++ /dev/null @@ -1,264 +0,0 @@ -# Developer Tools & Platforms - -Welcome to the Linux Foundation development team! This guide provides an overview of the tools and platforms we use. - -## πŸš€ Getting Started - -1. **Review this entire document** to understand our tech tools and platforms -2. **Request access** to all relevant platforms (see each section for account setup instructions) -3. **Access platforms** with your Linux Foundation email account, unless otherwise noted -4. **Contact your manager or IT team** if you need help with access to any platform -5. **Bookmark this page** for quick reference πŸ˜€ - ---- - -## πŸ” Security and Access Management - -### 1Password - -- **Purpose**: Password management and secure credential storage -- **URL**: [https://1password.com/](https://1password.com/) -- **What it does**: - - Store and share team passwords, API keys, and sensitive information securely - - Generate strong passwords - - Secure notes and documents - - Two-factor authentication backup - ---- - -## GitHub Repositories - -### Linux Foundation - -- **Purpose**: Non-profit consortium dedicated to fostering the growth of Linux -- **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). - -### Engineering Artifact and Notes - -- **Purpose**: Collection of artifacts and notes for engineers -- **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). - ---- - -## πŸ”§ Development Tools - -### Integrated Development Environments (IDEs) - -#### Cursor - -- **Purpose**: AI-powered code editor with built-in AI assistance -- **URL**: [https://cursor.sh/](https://cursor.sh/) -- **What it does**: - - AI-powered code completion and generation - - Intelligent code refactoring and debugging - - Natural language to code translation - - Integration with popular extensions and themes -- **Account Access**: Ask your manager to submit a support ticket on your behalf - or send a message in the `#lfx-ai` Slack channel. -- **Extensions**: Consider installing the Jira and GitHub Model Context Protocol - servers. - -#### Zed - -- **Purpose**: High-performance, collaborative code editor -- **URL**: [https://zed.dev/](https://zed.dev/) -- **What it does**: - - Lightning-fast performance with native speed - - Real-time collaborative editing - - Built-in terminal and Git integration - - Minimalist design with powerful features -- **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. -- **Extensions**: Consider installing the Jira and GitHub Model Context Protocol - servers. - -#### Neovim - -- **Purpose**: Modern, extensible terminal-based text editor -- **URL**: [https://neovim.io/](https://neovim.io/) -- **What it does**: - - Highly customizable and extensible - - Powerful keyboard-driven editing - - Extensive plugin ecosystem - - Lua scripting for configuration -- **Account Access**: Requesting access required. Download and install. Most - users connect to The Linux Foundation GitHub account to access the CoPilot AI - models. - ---- - -## πŸ—ƒοΈ API Documentation - -### API Gateway - -- **Purpose**: Central API gateway for routing and managing API requests -- **URL**: [https://api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) -- **What it does**: - - Centralized API endpoint management - - API documentation - ---- - -## πŸ“‹ Project Management & Collaboration - -### Jira - -- **Purpose**: Issue tracking, project management, and agile development workflows -- **URL**: [https://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) -- **What it does**: - - Track bugs, features, and technical debt - - Sprint planning and agile workflows - - Project roadmap and release planning - ---- - -## πŸ“Š Monitoring and Analytics - -### DataDog - -- **Purpose**: Application performance monitoring, logging, and infrastructure metrics -- **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) -- **What it does**: - - Monitor application performance and uptime, including many LFX products and services - - View logs and screen recorded sessions for debugging - - Track infrastructure metrics and alerts - - Review Real User Monitoring (RUM) data for user experience insights - -### Snowflake - -- **Purpose**: Cloud data platform for data warehousing and analytics -- **URL**: [https://www.snowflake.com/en/](https://www.snowflake.com/en/) -- **What it does**: - - Data storage and processing - - Business intelligence queries - - Analytics and reporting -- **Account Access**: - - Step 1: Datalake Team: IT/Ops Team Account Setup - 1. Determine which roles should be added to the new user(s). - 2. Create a pull request to add the users and roles to the GitHub Snowflake - Terraform repository. Here’s a link [to the GitHub - repository](https://github.com/linuxfoundation/lfx-snowflake-terraform) and - the user configuration file. Anyone can create a pull request. - 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. - - Step 2: Developer: User Account Setup - 1. Once Step 1 above is complete, users can now log into Snowflake. - 2. [Direct Link to The Linux - Foundation](https://app.snowflake.com/jnmhvwd/xpb85243/) Snowflake account. - 3. Users should log in using their LF email (e.g., - [your_lf_email@linuxfoundation.org](your_lf_email@linuxfoundation.org)) via - the Google SSO option. - 4. Once logged in, the user should be redirected back to the Snowflake - landing page. - 5. Users should then notify the Datalake Team. The Datalake Team will share - any relevant dashboards or interactive views/applications - (sharing is done after the user has logged in the first time). - 6. Once the Datalake Team has granted access from the Snowflake console, - navigate to: Menu -> Projects -> Dashboards -> β€œShared with me" - ---- - -## Organization Diagram - -### LFX-Datalake - -- **Purpose**: Architecture diagram showing LFX services, data flows, and system dependencies -- **URL**: - [https://github.com/linuxfoundation/lfx-architecture/blob/main/diagrams/data-flow.md](https://github.com/linuxfoundation/lfx-architecture/blob/main/diagrams/data-flow.md) - ---- - -## πŸ“ Documents - -### Google Workspace - -#### Google Docs - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://drive.google.com/](https://drive.google.com/) -- **Account Access**: Google Workspace is managed through single sign-on (SSO). - -#### Google Spreadsheets - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://docs.google.com/spreadsheets/](https://docs.google.com/spreadsheets/) -- **Account Access**: Google Workspace is managed through single sign-on (SSO). - -#### Google Slides - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://docs.google.com/presentation/](https://docs.google.com/presentation/) -- **Account Access**: Google Workspace is managed through single sign-on (SSO). - -#### Google Videos - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://docs.google.com/videos](https://docs.google.com/video) -- **Account Access**: Google Workspace is managed through single sign-on (SSO). - -#### Google Forms - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://docs.google.com/forms](https://docs.google.com/forms) -- **Account Access**: Google Workspace is managed through single sign-on (SSO). - -#### Google Drive - -- **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://drive.google.com/](https://drive.google.com/) -- **Account Access**: Google Workspace is managed through single sign-on (SSO). - ---- - -## πŸ”¦ Internal Tools - -### Individual Dashboard - -- **Purpose**: Personal profile, view your events and meetings and technical contribution and training enrollment tracking -- **URL**: [https://openprofile.dev/](https://openprofile.dev/) - -### Calamari - -- **Purpose**: Internal Linux Foundation tool for contractor time off tracking -- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) - ---- - -## πŸ†˜ Getting Help - -If you need access to any of these tools or have questions about their usage: - -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) - ---- - -## πŸ“ Notes for New Developers - -- **Bookmark this page** for quick reference -- **Ask questions** - the team is here to help you get up to speed -- **Keep credentials secure** - always use 1Password for storing sensitive information -- **Follow environment protocols** - always test in dev/staging before production - ---- - -## πŸ”„ Keeping This File Updated - -This document should be updated whenever: - -- New tools are adopted by the team -- URLs or access procedures change -- Tools are deprecated or replaced - ---- - -*For questions about this documentation or updates to this document, please submit a pull request -or contact the development team.* diff --git a/onboarding/development-tools-and-platforms.md b/onboarding/development-tools-and-platforms.md new file mode 100644 index 0000000..4728e23 --- /dev/null +++ b/onboarding/development-tools-and-platforms.md @@ -0,0 +1,413 @@ +# Developer Tools & Platforms + +Welcome to the Linux Foundation development team! This guide provides an overview of the tools and platforms we use. + +## πŸš€ Getting Started + +1. **Review this entire document** to understand our tech tools and platforms +2. **Access platforms** with your Linux Foundation email account, unless otherwise noted +3. **Contact your manager or tech lead** if you need help with access to any platform +4. **Bookmark this page** for quick reference πŸ˜€ + +--- + +## πŸ” Security and Access Management + +### 1Password + +- **Purpose**: Password management and secure credential storage +- **URL**: [https://1password.com/](https://1password.com/) + +**What you'll use 1Password for:** +- Store and share team passwords, API keys, and sensitive information securely +- Generate strong passwords for all development accounts +- Access shared team vaults for common credentials +- Store secure notes and documents related to projects +- Backup codes for two-factor authentication across all platforms + +**How to get access:** +1. Access is typically granted +2. If you cannot access, contact your team lead + + +**Setup Steps:** +1. Install 1Password browser extension for seamless login experience +2. Accept team invitation via email and create your master password +3. Configure 1Password app on mobile device for 2FA backup codes + +--- + +## GitHub Repositories + +### Linux Foundation + +- **Purpose**: Non-profit consortium dedicated to fostering the growth of Linux +- **URL**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) + +**What you'll use GitHub for:** +- Clone and contribute to LFX platform repositories +- Create feature branches +- Submit pull requests +- Participate in code reviews and provide feedback to team members +- Track issues and collaborate on technical discussions +- Access documentation, coding standards, and architecture decisions + +**How to get access:** +1. Ensure your personal GitHub account is added to the organization +2. Message your manager with your GitHub username +3. Accept organization invitation within 7 days (check your email) + +**Setup Steps:** +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 +3. Clone your project's repository and follow it's `Getting Started` guide +4. Set up Git configuration with your personal GitHub email: `git config --global user.email "your.email@gmail.com"` + +### Engineering Artifact and Notes + +- **Purpose**: Collection of artifacts and notes for engineers +- **URL**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) + +**What you'll use lfx-engineering for:** +- Access onboarding materials and training resources +- Review architecture documentation and technical specifications +- Learn AI integrations and mcp clients +- Contribute to internal documentation and knowledge sharing + +**How to get access:** +1. Complete Linux Foundation GitHub organization access (see above) + +--- + +## πŸ”§ Development Tools + +### Integrated Development Environments (IDEs) + +#### Cursor + +- **Purpose**: AI-powered code editor with built-in AI assistance +- **URL**: [https://cursor.sh/](https://cursor.sh/) + +**What you'll use Cursor for:** +- AI-powered code completion and generation for faster development +- Intelligent code refactoring and debugging assistance +- Natural language to code translation for complex logic +- Integration with our team's extensions and coding standards +- Collaborative debugging sessions with AI assistance + +**How to get access:** +1. Message your tech lead to get access to the team plan +2. Accept team invitation via email and complete account setup + +**Setup Steps:** +1. Download and install Cursor +2. Sign in with your Linux Foundation email +3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/cursor.md) + +#### Zed + +- **Purpose**: High-performance, collaborative code editor +- **URL**: [https://zed.dev/](https://zed.dev/) + +**What you'll use Zed for:** +- Lightning-fast performance for large codebases +- Real-time collaborative editing during pair programming sessions +- Built-in terminal integration for development workflows +- Git integration for seamless version control +- Minimalist interface that reduces cognitive load during coding + +**Setup Steps:** +1. Download and install Zed +2. Sign in with your choice of email +3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/zed.md) + +#### Neovim + +- **Purpose**: Modern, extensible terminal-based text editor +- **URL**: [https://neovim.io/](https://neovim.io/) + +**What you'll use Neovim for:** +- Highly efficient keyboard-driven editing for experienced developers +- Customizable development environment tailored to your workflow +- Powerful plugin ecosystem for language-specific development +- Terminal-based editing for remote development and server work +- Lua scripting for advanced configuration and automation + +**Setup Steps:** +1. Install Neovim using your system's package manager +2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/neovim.md) + +--- + +## πŸ—ƒοΈ API Documentation + +### API Gateway + +- **Purpose**: Central API gateway for routing and managing API requests +- **URL**: [https://api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) + +**What you'll use API Gateway for:** +- Access comprehensive API documentation for all LFX services +- Test API endpoints during development and debugging +- Understand request/response formats and authentication requirements + +**How to get access:** +1. Access is typically granted +2. If you cannot access, contact your team lead + +--- + +## πŸ“‹ Project Management & Collaboration + +### Jira + +- **Purpose**: Issue tracking, project management, and agile development workflows +- **URL**: [https://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) + +**What you'll use Jira for:** +- Track and update progress on assigned bugs, features, and technical debt +- Participate in sprint planning meetings every two weeks +- Create detailed bug reports with reproduction steps and severity levels +- Manage feature requests through our workflow: Backlog β†’ In Progress β†’ Code Review β†’ Testing β†’ Done +- Estimate story points and track velocity metrics +- Generate reports for stakeholders and project planning + +**How to get access:** +1. You should receive an invitation to Atlassian via email +2. Accept invitation and complete account setup + +**Setup Steps:** +1. Sign in to Jira using your Linux Foundation credentials +2. Set up email notifications to your preference +3. View your team's project boards and understand the workflow stages +4. Install Jira mobile app for updates on the go + +--- + +## πŸ“Š Monitoring and Analytics + +### DataDog + +- **Purpose**: Application performance monitoring, logging, and infrastructure metrics +- **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) + +**What you'll use DataDog for:** +- Monitor application performance and uptime for services you develop +- Debug issues by analyzing logs and error traces from production environments +- Set up custom alerts for critical application metrics and thresholds +- Analyze user sessions and application behavior patterns +- View infrastructure metrics to understand system resource usage + +**How to get access:** +1. You should receive an invitation to Datadog via email +2. Accept invitation and head to Datadog to sign in + +### Snowflake + +- **Purpose**: Cloud data platform for data warehousing and analytics +- **URL**: [https://app.snowflake.com/](https://app.snowflake.com/) + +**What you'll use Snowflake for:** +- Query large datasets for business intelligence and reporting needs +- Analyze user behavior and application metrics for product decisions +- Extract data for machine learning models and analytics projects +- Generate custom reports for stakeholders and project planning +- Collaborate with data team on complex analytical queries + +**How to get access:** +1. Message your tech lead to get access +2. Once access is granted, head to Snowflake to sign in + +**Setup Steps:** +1. Select the account to sign into by it's identifier +2. Username is your Linux Foundation email + +--- + +## Organization Diagram + +### LFX-Datalake + +- **Purpose**: Architecture diagram showing LFX services, data flows, and system dependencies +- **URL**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) + +**What you'll use LFX-Datalake diagram for:** +- Understand overall organization architecture and platform relationships + +**How to get access:** +1. Request access to the specific diagram from your director or team lead + +### Linux Product & Engineering organization + +- **Purpose**: Organizational chart with team structure, roles and reporting relationships +- **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#) + +**What you'll use the organization chart for:** +- Understand team structure, roles, and reporting relationships + +**How to get access:** +1. Request access to the specific diagram from your director or team lead + +--- + +## πŸ“ Documents + +### Google Workspace + +#### Google Docs + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://drive.google.com/](https://drive.google.com/) + +**How to get access:** +- Access is automatic with your Linux Foundation Google Workspace account +- If you cannot access specific documents, request sharing permissions from document owner + +**Setup Steps:** +1. Ensure you're logged in with your @linuxfoundation.org account +2. Install Google Docs mobile app for document access on the go +3. Set up offline sync for important documents you need to access without internet + +#### Google Spreadsheets + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/spreadsheets/](https://docs.google.com/spreadsheets/) + + +**How to get access:** +- Access is automatic with your Linux Foundation Google Workspace account +- If you cannot access specific documents, request sharing permissions from spreadsheet owner + +**Setup Steps:** +1. Ensure you're logged in with your @linuxfoundation.org account +2. Install Google Sheets mobile app for document access on the go +3. Set up offline sync for important documents you need to access without internet + +#### Google Slides + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/presentation/](https://docs.google.com/presentation/) + +**How to get access:** +- Access is automatic with your Linux Foundation Google Workspace account +- If you cannot access specific documents, request sharing permissions from presentation owner + +**Setup Steps:** +1. Ensure you're logged in with your @linuxfoundation.org account +2. Install Google Slides mobile app for document access on the go +3. Set up offline sync for important documents you need to access without internet + +#### Google Vids + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/videos](https://docs.google.com/video) + +**How to get access:** +- Access is automatic with your Linux Foundation Google Workspace account +- If you cannot access specific documents, request sharing permissions from video owner + +**Setup Steps:** +1. Ensure you're logged in with your @linuxfoundation.org account +2. Install Google Vids mobile app for document access on the go +3. Set up offline sync for important documents you need to access without internet + +#### Google Forms + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://docs.google.com/forms](https://docs.google.com/forms) + +**How to get access:** +- Access is automatic with your Linux Foundation Google Workspace account +- If you cannot access specific documents, request sharing permissions from form owner + +**Setup Steps:** +1. Ensure you're logged in with your @linuxfoundation.org account +2. Install Google Forms mobile app for document access on the go +3. Set up offline sync for important documents you need to access without internet + +#### Google Drive + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://drive.google.com/](https://drive.google.com/) + +**How to get access:** +- Access is automatic with your Linux Foundation Google Workspace account + +**Setup Steps:** +1. Ensure you're logged in with your @linuxfoundation.org account +2. Install Google Drive mobile app for document access on the go +3. Set up offline sync for important documents you need to access without internet + +--- + +## πŸ”¦ Internal Tools + +### Individual Dashboard + +- **Purpose**: Personal profile, view your events and meetings and technical contribution and training enrollment tracking +- **URL**: [https://openprofile.dev/](https://openprofile.dev/) + +**What you'll use Individual Dashboard for:** +- Track your technical contributions across projects and repositories +- Monitor your training progress and certifications +- View upcoming meetings and events relevant to your role +- Access performance metrics and goal tracking information + +**Setup Steps:** +1. Log in using your Linux Foundation credentials + +### Calamari + +- **Purpose**: Internal Linux Foundation tool for time off tracking +- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) + +**What you'll use Calamari for:** +- Request vacation time, sick leave, and other time off +- View your time off balance and accrual rates +- Submit time off requests for manager approval +- View team calendar to coordinate time off with colleagues +- Track public holidays and company-wide time off policies + +**How to get access:** +- Access is automatic with your Linux Foundation credentials + +**Setup Steps:** +1. Log in using your Linux Foundation credentials + +--- + +## πŸ†˜ Getting Help + +If you need access to any of these tools or have questions about their usage: + +1. **For tool-specific questions**: Ask in the appropriate Slack channel or reach out to a fellow team member +2. **For access issues**: Contact your manager or tech lead for assistance + +--- + +## πŸ“ Notes for New Developers + +- **Bookmark this page** for quick reference during your first few weeks +- **Ask questions** - the team is here to help you get up to speed quickly +- **Keep credentials secure** - always use 1Password for storing sensitive information +- **Follow environment protocols** - always test in dev/staging before production +- **Complete setup checklists** - use the setup steps for each tool to ensure proper configuration +- **Join relevant Slack channels** - stay connected with your team for real-time support and updates + +--- + +## πŸ”„ Keeping This File Updated + +This document should be updated whenever: + +- New tools are adopted by the team +- URLs or access procedures change +- Tools are deprecated or replaced +- Setup procedures are modified or improved +- New onboarding feedback suggests improvements + +--- + +*For questions about this documentation or updates to this document, please submit a pull request +or contact the development team.* From c275362e0138f9a4110d65d8b043fc0f9a8785f6 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Mon, 25 Aug 2025 11:02:55 +0100 Subject: [PATCH 11/14] refactor: enhance onboarding documentation for development tools 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. --- .../cursor.md | 31 +- .../neovim.md | 77 +++-- .../code-editor-extensions-and-plugins/zed.md | 12 +- onboarding/development-tools-and-platforms.md | 324 ++++++++++-------- 4 files changed, 263 insertions(+), 181 deletions(-) diff --git a/onboarding/code-editor-extensions-and-plugins/cursor.md b/onboarding/code-editor-extensions-and-plugins/cursor.md index f60f0a8..f0d8616 100644 --- a/onboarding/code-editor-extensions-and-plugins/cursor.md +++ b/onboarding/code-editor-extensions-and-plugins/cursor.md @@ -6,7 +6,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende 1. **Review this entire document** to understand our recommended extensions and plugins 2. **Install the extensions relevant** to your development workflow -2. **Bookmark this page** for quick reference when setting up new development environments πŸ˜€ +3. **Bookmark this page** for quick reference when setting up new development environments πŸ˜€ --- @@ -20,6 +20,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `eamodio.gitlens` **What you'll use GitLens for:** + - View detailed Git blame information inline with code - Explore file and line history with rich visualizations - Navigate through repository and branch history @@ -32,6 +33,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `esbenp.prettier-vscode` **What you'll use Prettier for:** + - Automatically format code on save according to team standards - Ensure consistent code style across all team members - Integration with our ESLint configuration for comprehensive code quality @@ -42,6 +44,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `dbaeumer.vscode-eslint` **What you'll use ESLint for:** + - Real-time code quality checking and error detection - Enforce team coding standards and best practices - Automatic fixing of common issues and style violations @@ -53,6 +56,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `formulahendry.auto-rename-tag` **What you'll use Auto Rename Tag for:** + - Simultaneously rename opening and closing HTML/XML tags - Prevent mismatched tags when refactoring markup - Maintain tag consistency in React components @@ -63,6 +67,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: formulahendry.auto-close-tag **What you'll use Auto Close Tag for**: + - Automatically add closing tags when typing opening tags - Support for custom HTML elements and React components - Reduce typing and prevent unclosed tag errors @@ -74,6 +79,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `ms-azuretools.vscode-docker` **What you'll use Docker for:** + - Build, manage, and deploy Docker containers - IntelliSense for Dockerfile and docker-compose files - Container and image management from within the editor @@ -85,6 +91,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Autocomplete for file paths in import statements **What you'll use Path Intellisense for**: + - Intelligent autocompletion for file and folder paths - Reduce typos in import statements and file references - Navigate project structure more efficiently @@ -96,6 +103,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: AI-powered code review and analysis **What you'll use CodeRabbit for**: + - Real-time code review suggestions and improvements - Automated code quality analysis and recommendations - Security vulnerability detection in your code @@ -110,6 +118,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `Angular.ng-template` **What you'll use Angular Language Service for:** + - IntelliSense and autocompletion in Angular templates - Real-time error detection in component templates - Navigation between templates and component code @@ -121,6 +130,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `cyrilletuzi.angular-schematics` **What you'll use Angular Schematics for:** + - Generate components, services, modules, and other Angular artifacts - Scaffold new Angular applications and libraries - Apply code transformations and migrations @@ -132,6 +142,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `yoavbls.pretty-ts-errors` **What you'll use Pretty TypeScript Errors for:** + - Display TypeScript errors with improved readability and formatting - Better understanding of complex type errors and suggestions - Reduced cognitive load when debugging TypeScript issues @@ -142,6 +153,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `bradlc.vscode-tailwindcss` **What you'll use Tailwind CSS IntelliSense for:** + - Autocomplete for Tailwind CSS class names - Hover previews showing the actual CSS properties - Linting and validation of Tailwind classes @@ -153,6 +165,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `Anthropic.claude-dev` **What you'll use Claude Code for VSCode for:** + - AI-powered code completion and suggestions - Intelligent code refactoring and optimization - Natural language code generation and explanations @@ -164,6 +177,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `golang.go` **What you'll use Go for:** + - Syntax highlighting and code completion for Go - Integrated debugging with delve debugger - Automatic code formatting with gofmt on save @@ -187,6 +201,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `rangav.vscode-thunder-client` **What you'll use Thunder Client for:** + - GUI-based API testing with collections and environments - Import/export Postman collections - Scriptless testing with pre-request and test scripts @@ -198,6 +213,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `ms-ossdata.vscode-postgresql` **What you'll use PostgreSQL for:** + - Syntax highlighting for PostgreSQL-specific SQL - IntelliSense for PostgreSQL functions and keywords - Query execution and result visualization @@ -209,6 +225,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `redhat.vscode-yaml` **What you'll use YAML for:** + - Syntax highlighting and validation for YAML files - Schema validation for Kubernetes, Docker Compose, and CI/CD files - Auto-completion based on YAML schemas @@ -220,6 +237,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `ms-kubernetes-tools.vscode-kubernetes-tools` **What you'll use Kubernetes for:** + - Deploy and manage Kubernetes applications - Browse cluster resources and view logs - IntelliSense for Kubernetes YAML manifests @@ -232,10 +250,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Official Vue.js language server with TypeScript support **What you'll use Vue Language Features for**: -- Advanced TypeScript support in Vue components -- Better performance and accuracy than legacy Vue extensions -- Composition API and script setup syntax support -- Template type checking and validation -- Integration with Vue 3 features and modern Vue development + + - Advanced TypeScript support in Vue components + - Better performance and accuracy than legacy Vue extensions + - Composition API and script setup syntax support + - Template type checking and validation + - Integration with Vue 3 features and modern Vue development --- diff --git a/onboarding/code-editor-extensions-and-plugins/neovim.md b/onboarding/code-editor-extensions-and-plugins/neovim.md index e9f49c3..596a87d 100644 --- a/onboarding/code-editor-extensions-and-plugins/neovim.md +++ b/onboarding/code-editor-extensions-and-plugins/neovim.md @@ -19,10 +19,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Repository**: [https://github.com/folke/lazy.nvim](https://github.com/folke/lazy.nvim) **What you'll use lazy.nvim for:** -- Lazy-loading plugins for faster startup times -- Automatic plugin installation and updates -- Dependency management between plugins -- Performance optimization and configuration management + + - Lazy-loading plugins for faster startup times + - Automatic plugin installation and updates + - Dependency management between plugins + - Performance optimization and configuration management ### Essential Plugins @@ -32,10 +33,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Advanced syntax highlighting and code understanding **What you'll use nvim-treesitter for:** -- Superior syntax highlighting for 40+ languages -- Intelligent code folding and text objects -- Incremental parsing for large files -- Foundation for other advanced plugins + + - Superior syntax highlighting for 40+ languages + - Intelligent code folding and text objects + - Incremental parsing for large files + - Foundation for other advanced plugins #### telescope.nvim @@ -43,10 +45,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Fuzzy finder and picker for files, buffers, and more **What you'll use telescope.nvim for:** -- Quick file navigation and opening -- Search through project files and content -- Git integration for branch and commit browsing -- Command palette functionality + + - Quick file navigation and opening + - Search through project files and content + - Git integration for branch and commit browsing + - Command palette functionality #### nvim-lspconfig @@ -54,10 +57,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Easy Language Server Protocol configuration **What you'll use nvim-lspconfig for:** -- Configure language servers for your programming languages -- IntelliSense, go-to-definition, and error diagnostics -- Code actions and refactoring capabilities -- Integration with completion and formatting plugins + + - Configure language servers for your programming languages + - IntelliSense, go-to-definition, and error diagnostics + - Code actions and refactoring capabilities + - Integration with completion and formatting plugins #### nvim-cmp @@ -65,10 +69,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Autocompletion engine with multiple sources **What you'll use nvim-cmp for:** -- Intelligent code completion from LSP servers -- Snippet expansion and management -- Buffer and path completion -- Integration with external completion sources + + - Intelligent code completion from LSP servers + - Snippet expansion and management + - Buffer and path completion + - Integration with external completion sources #### gitsigns.nvim @@ -76,10 +81,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Git integration with signs, hunks, and blame **What you'll use gitsigns.nvim for:** -- Visual Git diff indicators in the sign column -- Stage and unstage hunks directly from the editor -- Navigate through Git changes efficiently -- Inline Git blame information + + - Visual Git diff indicators in the sign column + - Stage and unstage hunks directly from the editor + - Navigate through Git changes efficiently + - Inline Git blame information #### fugitive.vim @@ -87,10 +93,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Comprehensive Git wrapper for Vim/Neovim **What you'll use fugitive.vim for:** -- Complete Git workflow from within Neovim -- Interactive staging and committing -- Branch management and merging -- Git history browsing and comparison + + - Complete Git workflow from within Neovim + - Interactive staging and committing + - Branch management and merging + - Git history browsing and comparison #### nvim-tree.lua @@ -98,10 +105,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: File explorer tree for Neovim **What you'll use nvim-tree.lua for:** -- Visual file system navigation -- File and directory operations -- Project structure overview -- Integration with Git status indicators + + - Visual file system navigation + - File and directory operations + - Project structure overview + - Integration with Git status indicators #### lualine.nvim @@ -109,6 +117,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Fast and customizable statusline for Neovim **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 @@ -120,6 +129,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Visual undo history tree for advanced undo/redo operations **What you'll use undotree for**: + - Navigate complex undo/redo history with visual tree representation - Recover lost changes from branched undo paths - Compare different states of your file during editing sessions @@ -143,6 +153,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Purpose**: Fast AI code completion with context awareness **What you'll use supermaven-nvim for**: + - Lightning-fast AI-powered code suggestions and completions - Context-aware code generation based on your entire codebase - Multi-language support with optimized performance @@ -150,5 +161,5 @@ Welcome to the Linux Foundation development team! This guide provides recommende --- -You can find a list of more plguins 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) --- diff --git a/onboarding/code-editor-extensions-and-plugins/zed.md b/onboarding/code-editor-extensions-and-plugins/zed.md index 004da2e..c0aa297 100644 --- a/onboarding/code-editor-extensions-and-plugins/zed.md +++ b/onboarding/code-editor-extensions-and-plugins/zed.md @@ -6,7 +6,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende 1. **Review this entire document** to understand our recommended extensions and plugins 2. **Install the extensions relevant** to your development workflow -2. **Bookmark this page** for quick reference when setting up new development environments πŸ˜€ +3. **Bookmark this page** for quick reference when setting up new development environments πŸ˜€ --- @@ -19,6 +19,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `git-firefly` **What you'll use Git Firefly for:** + - Advanced Git history visualization with interactive timelines - Enhanced branch management and merge conflict resolution - Commit message templates and conventional commit support @@ -31,6 +32,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `emmet` (Built-in to Zed) **What you'll use Emmet for:** + - Rapid HTML structure creation using CSS selector syntax - CSS property abbreviation expansion for faster styling - Lorem ipsum text generation and placeholder content @@ -44,6 +46,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `html` (Built-in to Zed) **What you'll use HTML for:** + - Syntax highlighting and code completion for HTML elements - Auto-completion for HTML attributes and values - Tag matching and validation for proper HTML structure @@ -55,6 +58,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `toml` **What you'll use TOML for:** + - Syntax highlighting for TOML configuration files - Validation and error detection for TOML syntax - Auto-completion for common TOML structures @@ -66,6 +70,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `sql` **What you'll use SQL for:** + - Syntax highlighting for SQL queries across multiple database dialects - IntelliSense for SQL keywords, functions, and database objects - Query formatting and beautification for readable code @@ -77,6 +82,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `dockerfile` **What you'll use Dockerfile for:** + - Syntax highlighting and validation for Dockerfile instructions - Auto-completion for Docker commands and best practices - Linting and security recommendations for container builds @@ -88,6 +94,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `angular` **What you'll use Angular for:** + - Syntax highlighting and IntelliSense for Angular templates - Component, service, and directive code completion - TypeScript integration with Angular-specific decorators @@ -99,6 +106,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `vue` **What you'll use Vue for:** + - Syntax highlighting for Vue single-file components (.vue) - Template, script, and style section IntelliSense - Vue 3 Composition API and Options API support @@ -110,6 +118,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `scss` **What you'll use SCSS for:** + - Syntax highlighting for SCSS/Sass variables, mixins, and functions - Auto-completion for SCSS-specific features and built-in functions - Nesting validation and formatting for clean stylesheet structure @@ -121,6 +130,7 @@ Welcome to the Linux Foundation development team! This guide provides recommende - **Extension ID**: `terraform` **What you'll use Terraform for:** + - Syntax highlighting for Terraform configuration files (.tf) - IntelliSense for Terraform resources, providers, and modules - Validation and linting for Terraform best practices diff --git a/onboarding/development-tools-and-platforms.md b/onboarding/development-tools-and-platforms.md index 4728e23..74f6e7d 100644 --- a/onboarding/development-tools-and-platforms.md +++ b/onboarding/development-tools-and-platforms.md @@ -19,21 +19,24 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://1password.com/](https://1password.com/) **What you'll use 1Password for:** -- Store and share team passwords, API keys, and sensitive information securely -- Generate strong passwords for all development accounts -- Access shared team vaults for common credentials -- Store secure notes and documents related to projects -- Backup codes for two-factor authentication across all platforms + + - Store and share team passwords, API keys, and sensitive information securely + - Generate strong passwords for all development accounts + - Access shared team vaults for common credentials + - Store secure notes and documents related to projects + - Backup codes for two-factor authentication across all platforms **How to get access:** -1. Access is typically granted -2. If you cannot access, contact your team lead + + 1. Access is typically granted + 2. If you cannot access, contact your team lead **Setup Steps:** -1. Install 1Password browser extension for seamless login experience -2. Accept team invitation via email and create your master password -3. Configure 1Password app on mobile device for 2FA backup codes + + 1. Install 1Password browser extension for seamless login experience + 2. Accept team invitation via email and create your master password + 3. Configure 1Password app on mobile device for 2FA backup codes --- @@ -45,24 +48,27 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation) **What you'll use GitHub for:** -- Clone and contribute to LFX platform repositories -- Create feature branches -- Submit pull requests -- Participate in code reviews and provide feedback to team members -- Track issues and collaborate on technical discussions -- Access documentation, coding standards, and architecture decisions + + - Clone and contribute to LFX platform repositories + - Create feature branches + - Submit pull requests + - Participate in code reviews and provide feedback to team members + - Track issues and collaborate on technical discussions + - Access documentation, coding standards, and architecture decisions **How to get access:** -1. Ensure your personal GitHub account is added to the organization -2. Message your manager with your GitHub username -3. Accept organization invitation within 7 days (check your email) + + 1. You must have your personal GitHub account added to the Linux Foundation organization. + 2. To request access, ask your manager to submit a support ticket on your behalf. + 3. Access is managed through single sign-on (SSO). **Setup Steps:** -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 -3. Clone your project's repository and follow it's `Getting Started` guide -4. Set up Git configuration with your personal GitHub email: `git config --global user.email "your.email@gmail.com"` + + 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 ### Engineering Artifact and Notes @@ -70,13 +76,17 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://github.com/linuxfoundation/lfx-engineering](https://github.com/linuxfoundation/lfx-engineering) **What you'll use lfx-engineering for:** -- Access onboarding materials and training resources -- Review architecture documentation and technical specifications -- Learn AI integrations and mcp clients -- Contribute to internal documentation and knowledge sharing + + - Access onboarding materials and training resources + - Review architecture documentation and technical specifications + - Learn AI integrations and mcp clients + - Contribute to internal documentation and knowledge sharing **How to get access:** -1. Complete Linux Foundation GitHub organization access (see above) + + 1. You must have your personal GitHub account added to the Linux Foundation organization. + 2. To request access, ask your manager to submit a support ticket on your behalf. + 3. Access is managed through single sign-on (SSO). --- @@ -90,20 +100,24 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://cursor.sh/](https://cursor.sh/) **What you'll use Cursor for:** -- AI-powered code completion and generation for faster development -- Intelligent code refactoring and debugging assistance -- Natural language to code translation for complex logic -- Integration with our team's extensions and coding standards -- Collaborative debugging sessions with AI assistance + + - AI-powered code completion and generation for faster development + - Intelligent code refactoring and debugging assistance + - Natural language to code translation for complex logic + - Integration with our team's extensions and coding standards + - Collaborative debugging sessions with AI assistance **How to get access:** -1. Message your tech lead to get access to the team plan -2. Accept team invitation via email and complete account setup + + 1. Ask your manager to submit a support ticket on your behalf or send a message + in the `#lfx-ai` Slack channel. **Setup Steps:** -1. Download and install Cursor -2. Sign in with your Linux Foundation email -3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/cursor.md) + + 1. Download and install Cursor + 2. Sign in with your Linux Foundation email + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/cursor.md) + 4. Consider installing the Jira and GitHub Model Context Protocol servers. #### Zed @@ -111,16 +125,23 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://zed.dev/](https://zed.dev/) **What you'll use Zed for:** -- Lightning-fast performance for large codebases -- Real-time collaborative editing during pair programming sessions -- Built-in terminal integration for development workflows -- Git integration for seamless version control -- Minimalist interface that reduces cognitive load during coding + + - Lightning-fast performance for large codebases + - Real-time collaborative editing during pair programming sessions + - Built-in terminal integration for development workflows + - Git integration for seamless version control + - Minimalist interface that reduces cognitive load during coding + +**How to get access:** + + 1. Requesting access not required. Follow the online documentation to download and install. + 2. Most users connect to The Linux Foundation GitHub account to access the CoPilot AI models. **Setup Steps:** -1. Download and install Zed -2. Sign in with your choice of email -3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/zed.md) + + 1. Download and install Zed + 2. Sign in with your choice of email + 3. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/zed.md) #### Neovim @@ -128,15 +149,22 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://neovim.io/](https://neovim.io/) **What you'll use Neovim for:** -- Highly efficient keyboard-driven editing for experienced developers -- Customizable development environment tailored to your workflow -- Powerful plugin ecosystem for language-specific development -- Terminal-based editing for remote development and server work -- Lua scripting for advanced configuration and automation + + - Highly efficient keyboard-driven editing for experienced developers + - Customizable development environment tailored to your workflow + - Powerful plugin ecosystem for language-specific development + - Terminal-based editing for remote development and server work + - Lua scripting for advanced configuration and automation + +**How to get access:** + + 1. Requesting access not required. Follow the online documentation to download and install. + 2. Most users connect to The Linux Foundation GitHub account to access the CoPilot AI models. **Setup Steps:** -1. Install Neovim using your system's package manager -2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/neovim.md) + + 1. Install Neovim using your system's package manager + 2. Install the [recommended extensions](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/code-editor-extensions-and-plugins/neovim.md) --- @@ -148,13 +176,15 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://api-gw.dev.platform.linuxfoundation.org/](https://api-gw.dev.platform.linuxfoundation.org/) **What you'll use API Gateway for:** -- Access comprehensive API documentation for all LFX services -- Test API endpoints during development and debugging -- Understand request/response formats and authentication requirements + + - Access comprehensive API documentation for all LFX services + - Test API endpoints during development and debugging + - Understand request/response formats and authentication requirements **How to get access:** -1. Access is typically granted -2. If you cannot access, contact your team lead + + 1. Access is typically granted + 2. If you cannot access, contact your team lead --- @@ -166,22 +196,24 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://linuxfoundation.atlassian.net/jira/](https://linuxfoundation.atlassian.net/jira/) **What you'll use Jira for:** -- Track and update progress on assigned bugs, features, and technical debt -- Participate in sprint planning meetings every two weeks -- Create detailed bug reports with reproduction steps and severity levels -- Manage feature requests through our workflow: Backlog β†’ In Progress β†’ Code Review β†’ Testing β†’ Done -- Estimate story points and track velocity metrics -- Generate reports for stakeholders and project planning + + - Track and update progress on assigned bugs, features, and technical debt + - Create detailed bug reports with reproduction steps and severity levels + - Manage feature requests through our workflow: Backlog β†’ In Progress β†’ Code Review β†’ Testing β†’ Done + - Estimate story points and track velocity metrics + - Generate reports for stakeholders and project planning **How to get access:** -1. You should receive an invitation to Atlassian via email -2. Accept invitation and complete account setup + + 1. You should receive an invitation to Atlassian via email + 2. Accept invitation and complete account setup **Setup Steps:** -1. Sign in to Jira using your Linux Foundation credentials -2. Set up email notifications to your preference -3. View your team's project boards and understand the workflow stages -4. Install Jira mobile app for updates on the go + + 1. Sign in to Jira using your Linux Foundation credentials + 2. Set up email notifications to your preference + 3. View your team's project boards and understand the workflow stages + 4. Install Jira mobile app for updates on the go --- @@ -193,15 +225,16 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://datadog.linuxfoundation.org/](https://datadog.linuxfoundation.org/) **What you'll use DataDog for:** -- Monitor application performance and uptime for services you develop -- Debug issues by analyzing logs and error traces from production environments -- Set up custom alerts for critical application metrics and thresholds -- Analyze user sessions and application behavior patterns -- View infrastructure metrics to understand system resource usage + + - Monitor application performance and uptime, including many LFX products and services + - View logs and screen recorded sessions for debugging + - Review Real User Monitoring (RUM) data for user experience insights + - View infrastructure metrics to understand system resource usage **How to get access:** -1. You should receive an invitation to Datadog via email -2. Accept invitation and head to Datadog to sign in + + 1. You should receive an invitation to Datadog via email + 2. Accept invitation and head to Datadog to sign in ### Snowflake @@ -209,19 +242,38 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://app.snowflake.com/](https://app.snowflake.com/) **What you'll use Snowflake for:** -- Query large datasets for business intelligence and reporting needs -- Analyze user behavior and application metrics for product decisions -- Extract data for machine learning models and analytics projects -- Generate custom reports for stakeholders and project planning -- Collaborate with data team on complex analytical queries + + - Query large datasets for business intelligence and reporting needs + - Analyze user behavior and application metrics for product decisions + - Extract data for machine learning models and analytics projects + - Generate custom reports for stakeholders and project planning + - Collaborate with data team on complex analytical queries **How to get access:** -1. Message your tech lead to get access -2. Once access is granted, head to Snowflake to sign in -**Setup Steps:** -1. Select the account to sign into by it's identifier -2. Username is your Linux Foundation email + - Step 1: Datalake Team: IT/Ops Team Account Setup + 1. Determine which roles should be added to the new user(s). + 2. Create a pull request to add the users and roles to the GitHub Snowflake + Terraform repository. Here’s a link [to the GitHub + repository](https://github.com/linuxfoundation/lfx-snowflake-terraform) and + the user configuration file. Anyone can create a pull request. + 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. + - Step 2: Developer: User Account Setup + 1. Once Step 1 above is complete, users can now log into Snowflake. + 2. [Direct Link to The Linux + Foundation](https://app.snowflake.com/jnmhvwd/xpb85243/) Snowflake account. + 3. Users should log in using their LF email (e.g., + [your_lf_email@linuxfoundation.org](your_lf_email@linuxfoundation.org)) via + the Google SSO option. + 4. Once logged in, the user should be redirected back to the Snowflake + landing page. + 5. Users should then notify the Datalake Team. The Datalake Team will share + any relevant dashboards or interactive views/applications + (sharing is done after the user has logged in the first time). + 6. Once the Datalake Team has granted access from the Snowflake console, + navigate to: Menu -> Projects -> Dashboards -> β€œShared with me" --- @@ -233,10 +285,12 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) **What you'll use LFX-Datalake diagram for:** -- Understand overall organization architecture and platform relationships + + - Understand overall organization architecture and platform relationships **How to get access:** -1. Request access to the specific diagram from your director or team lead + + 1. Request access to the specific diagram from your director or team lead ### Linux Product & Engineering organization @@ -244,10 +298,20 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **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#) **What you'll use the organization chart for:** -- Understand team structure, roles, and reporting relationships + + - Understand team structure, roles, and reporting relationships **How to get access:** -1. Request access to the specific diagram from your director or team lead + + 1. Request access to the specific diagram from your director or team lead + + +TODO: Leaving for David Deal to update + +### LFX-Datalake + +- **Purpose**: Architecture diagram showing LFX services, data flows, and system dependencies +- **URL**: [https://github.com/linuxfoundation/lfx-architecture/blob/main/diagrams/data-flow.md](https://github.com/linuxfoundation/lfx-architecture/blob/main/diagrams/data-flow.md) --- @@ -261,13 +325,9 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://drive.google.com/](https://drive.google.com/) **How to get access:** -- Access is automatic with your Linux Foundation Google Workspace account -- If you cannot access specific documents, request sharing permissions from document owner -**Setup Steps:** -1. Ensure you're logged in with your @linuxfoundation.org account -2. Install Google Docs mobile app for document access on the go -3. Set up offline sync for important documents you need to access without internet + - Google Workspace is managed through single sign-on (SSO) + - If you cannot access specific documents, request sharing permissions from document owner #### Google Spreadsheets @@ -276,13 +336,9 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **How to get access:** -- Access is automatic with your Linux Foundation Google Workspace account -- If you cannot access specific documents, request sharing permissions from spreadsheet owner -**Setup Steps:** -1. Ensure you're logged in with your @linuxfoundation.org account -2. Install Google Sheets mobile app for document access on the go -3. Set up offline sync for important documents you need to access without internet + - Google Workspace is managed through single sign-on (SSO) + - If you cannot access specific documents, request sharing permissions from spreadsheet owner #### Google Slides @@ -290,27 +346,19 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://docs.google.com/presentation/](https://docs.google.com/presentation/) **How to get access:** -- Access is automatic with your Linux Foundation Google Workspace account -- If you cannot access specific documents, request sharing permissions from presentation owner -**Setup Steps:** -1. Ensure you're logged in with your @linuxfoundation.org account -2. Install Google Slides mobile app for document access on the go -3. Set up offline sync for important documents you need to access without internet + - Google Workspace is managed through single sign-on (SSO) + - If you cannot access specific documents, request sharing permissions from presentation owner #### Google Vids - **Purpose**: Linux Foundation storage of files shared with you -- **URL**: [https://docs.google.com/videos](https://docs.google.com/video) +- **URL**: [https://docs.google.com/videos](https://docs.google.com/videos) **How to get access:** -- Access is automatic with your Linux Foundation Google Workspace account -- If you cannot access specific documents, request sharing permissions from video owner -**Setup Steps:** -1. Ensure you're logged in with your @linuxfoundation.org account -2. Install Google Vids mobile app for document access on the go -3. Set up offline sync for important documents you need to access without internet + - Google Workspace is managed through single sign-on (SSO) + - If you cannot access specific documents, request sharing permissions from video owner #### Google Forms @@ -318,13 +366,9 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://docs.google.com/forms](https://docs.google.com/forms) **How to get access:** -- Access is automatic with your Linux Foundation Google Workspace account -- If you cannot access specific documents, request sharing permissions from form owner -**Setup Steps:** -1. Ensure you're logged in with your @linuxfoundation.org account -2. Install Google Forms mobile app for document access on the go -3. Set up offline sync for important documents you need to access without internet + - Google Workspace is managed through single sign-on (SSO) + - If you cannot access specific documents, request sharing permissions from form owner #### Google Drive @@ -332,12 +376,8 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://drive.google.com/](https://drive.google.com/) **How to get access:** -- Access is automatic with your Linux Foundation Google Workspace account -**Setup Steps:** -1. Ensure you're logged in with your @linuxfoundation.org account -2. Install Google Drive mobile app for document access on the go -3. Set up offline sync for important documents you need to access without internet + - Google Workspace is managed through single sign-on (SSO) --- @@ -349,13 +389,15 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [https://openprofile.dev/](https://openprofile.dev/) **What you'll use Individual Dashboard for:** -- Track your technical contributions across projects and repositories -- Monitor your training progress and certifications -- View upcoming meetings and events relevant to your role -- Access performance metrics and goal tracking information + + - Track your technical contributions across projects and repositories + - Monitor your training progress and certifications + - View upcoming meetings and events relevant to your role + - Access performance metrics and goal tracking information **Setup Steps:** -1. Log in using your Linux Foundation credentials + + 1. Log in using your Linux Foundation credentials ### Calamari @@ -363,17 +405,17 @@ Welcome to the Linux Foundation development team! This guide provides an overvie - **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) **What you'll use Calamari for:** -- Request vacation time, sick leave, and other time off -- View your time off balance and accrual rates -- Submit time off requests for manager approval -- View team calendar to coordinate time off with colleagues -- Track public holidays and company-wide time off policies + + - Request vacation time, sick leave, and other time off + - View your time off balance and accrual rates + - Submit time off requests for manager approval + - View team calendar to coordinate time off with colleagues + - Track public holidays and company-wide time off policies **How to get access:** -- Access is automatic with your Linux Foundation credentials -**Setup Steps:** -1. Log in using your Linux Foundation credentials + 1. You should receive an invitation to Calamari via email + 2. Accept invitation and complete account setup --- From 6f91d4d87e294e1d990175ab5da968258c07eaa5 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Mon, 25 Aug 2025 11:14:04 +0100 Subject: [PATCH 12/14] fix: update linting issues Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- .../cursor.md | 197 +++++++++--------- .../neovim.md | 102 ++++----- .../code-editor-extensions-and-plugins/zed.md | 111 +++++----- onboarding/development-tools-and-platforms.md | 155 +++++++------- 4 files changed, 291 insertions(+), 274 deletions(-) diff --git a/onboarding/code-editor-extensions-and-plugins/cursor.md b/onboarding/code-editor-extensions-and-plugins/cursor.md index f0d8616..339fa45 100644 --- a/onboarding/code-editor-extensions-and-plugins/cursor.md +++ b/onboarding/code-editor-extensions-and-plugins/cursor.md @@ -21,11 +21,11 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use GitLens for:** - - View detailed Git blame information inline with code - - Explore file and line history with rich visualizations - - Navigate through repository and branch history - - Compare changes across commits and branches - - Understand code evolution and contributor insights +- View detailed Git blame information inline with code +- Explore file and line history with rich visualizations +- Navigate through repository and branch history +- Compare changes across commits and branches +- Understand code evolution and contributor insights #### Prettier - Code formatter @@ -34,9 +34,9 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use Prettier for:** - - Automatically format code on save according to team standards - - Ensure consistent code style across all team members - - Integration with our ESLint configuration for comprehensive code quality +- Automatically format code on save according to team standards +- Ensure consistent code style across all team members +- Integration with our ESLint configuration for comprehensive code quality #### ESLint @@ -45,10 +45,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use ESLint for:** - - Real-time code quality checking and error detection - - Enforce team coding standards and best practices - - Automatic fixing of common issues and style violations - - Custom rule configuration for project-specific requirements +- Real-time code quality checking and error detection +- Enforce team coding standards and best practices +- Automatic fixing of common issues and style violations +- Custom rule configuration for project-specific requirements #### Auto Rename Tag @@ -57,9 +57,9 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use Auto Rename Tag for:** - - Simultaneously rename opening and closing HTML/XML tags - - Prevent mismatched tags when refactoring markup - - Maintain tag consistency in React components +- Simultaneously rename opening and closing HTML/XML tags +- Prevent mismatched tags when refactoring markup +- Maintain tag consistency in React components #### Auto Close Tag @@ -68,10 +68,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use Auto Close Tag for**: - - Automatically add closing tags when typing opening tags - - Support for custom HTML elements and React components - - Reduce typing and prevent unclosed tag errors - - Speed up markup development workflows +- Automatically add closing tags when typing opening tags +- Support for custom HTML elements and React components +- Reduce typing and prevent unclosed tag errors +- Speed up markup development workflows #### Docker @@ -80,10 +80,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use Docker for:** - - Build, manage, and deploy Docker containers - - IntelliSense for Dockerfile and docker-compose files - - Container and image management from within the editor - - Integration with remote development containers +- Build, manage, and deploy Docker containers +- IntelliSense for Dockerfile and docker-compose files +- Container and image management from within the editor +- Integration with remote development containers #### Path Intellisense @@ -92,10 +92,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use Path Intellisense for**: - - Intelligent autocompletion for file and folder paths - - Reduce typos in import statements and file references - - Navigate project structure more efficiently - - Support for relative and absolute path completion +- Intelligent autocompletion for file and folder paths +- Reduce typos in import statements and file references +- Navigate project structure more efficiently +- Support for relative and absolute path completion #### CodeRabbit @@ -104,145 +104,156 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use CodeRabbit for**: - - Real-time code review suggestions and improvements - - Automated code quality analysis and recommendations - - Security vulnerability detection in your code - - Performance optimization suggestions - - Code style and best practice enforcement - +- Real-time code review suggestions and improvements +- Automated code quality analysis and recommendations +- Security vulnerability detection in your code +- Performance optimization suggestions +- Code style and best practice enforcement ### Workflow Specific Extensions #### Angular Language Service + - **Purpose**: Enhanced Angular development with IntelliSense and diagnostics - **Extension ID**: `Angular.ng-template` **What you'll use Angular Language Service for:** - - IntelliSense and autocompletion in Angular templates - - Real-time error detection in component templates - - Navigation between templates and component code - - Type checking for Angular expressions and directives - - Quick fixes and refactoring support for Angular projects +- IntelliSense and autocompletion in Angular templates +- Real-time error detection in component templates +- Navigation between templates and component code +- Type checking for Angular expressions and directives +- Quick fixes and refactoring support for Angular projects #### Angular Schematics + - **Purpose**: Generate Angular code and project structures using schematics - **Extension ID**: `cyrilletuzi.angular-schematics` **What you'll use Angular Schematics for:** - - Generate components, services, modules, and other Angular artifacts - - Scaffold new Angular applications and libraries - - Apply code transformations and migrations - - Maintain consistent project structure across team - - Integrate with Angular CLI workflows +- Generate components, services, modules, and other Angular artifacts +- Scaffold new Angular applications and libraries +- Apply code transformations and migrations +- Maintain consistent project structure across team +- Integrate with Angular CLI workflows #### Pretty TypeScript Errors + - **Purpose**: Improved TypeScript error messages with better formatting - **Extension ID**: `yoavbls.pretty-ts-errors` **What you'll use Pretty TypeScript Errors for:** - - Display TypeScript errors with improved readability and formatting - - Better understanding of complex type errors and suggestions - - Reduced cognitive load when debugging TypeScript issues - - Enhanced developer experience with clearer error messages +- Display TypeScript errors with improved readability and formatting +- Better understanding of complex type errors and suggestions +- Reduced cognitive load when debugging TypeScript issues +- Enhanced developer experience with clearer error messages #### Tailwind CSS IntelliSense + - **Purpose**: Intelligent autocomplete and linting for Tailwind CSS - **Extension ID**: `bradlc.vscode-tailwindcss` **What you'll use Tailwind CSS IntelliSense for:** - - Autocomplete for Tailwind CSS class names - - Hover previews showing the actual CSS properties - - Linting and validation of Tailwind classes - - Color previews and syntax highlighting - - Support for custom Tailwind configurations +- Autocomplete for Tailwind CSS class names +- Hover previews showing the actual CSS properties +- Linting and validation of Tailwind classes +- Color previews and syntax highlighting +- Support for custom Tailwind configurations #### Claude Code for VSCode + - **Purpose**: AI-powered coding assistance integrated directly in your editor - **Extension ID**: `Anthropic.claude-dev` **What you'll use Claude Code for VSCode for:** - - AI-powered code completion and suggestions - - Intelligent code refactoring and optimization - - Natural language code generation and explanations - - Debugging assistance and error resolution - - Code review and improvement recommendations +- AI-powered code completion and suggestions +- Intelligent code refactoring and optimization +- Natural language code generation and explanations +- Debugging assistance and error resolution +- Code review and improvement recommendations #### Go + - **Purpose**: Official Go language support with comprehensive tooling - **Extension ID**: `golang.go` **What you'll use Go for:** - - Syntax highlighting and code completion for Go - - Integrated debugging with delve debugger - - Automatic code formatting with gofmt on save - - Test discovery and execution within the editor - - Import management and dependency resolution - - Integration with Go tools (go mod, go build, go test) +- Syntax highlighting and code completion for Go +- Integrated debugging with delve debugger +- Automatic code formatting with gofmt on save +- Test discovery and execution within the editor +- Import management and dependency resolution +- Integration with Go tools (go mod, go build, go test) #### REST Client + - **Purpose**: Test REST APIs directly from within the editor - **Extension ID**: `humao.rest-client` **What you'll use REST Client for:** - - Send HTTP requests and view responses without leaving the editor - - Save and organize API requests in .http files - - Environment variable support for different deployment stages - - Authentication support (Bearer tokens, Basic auth) - - Response formatting and syntax highlighting + +- Send HTTP requests and view responses without leaving the editor +- Save and organize API requests in .http files +- Environment variable support for different deployment stages +- Authentication support (Bearer tokens, Basic auth) +- Response formatting and syntax highlighting #### Thunder Client + - **Purpose**: Lightweight REST API testing client - **Extension ID**: `rangav.vscode-thunder-client` **What you'll use Thunder Client for:** - - GUI-based API testing with collections and environments - - Import/export Postman collections - - Scriptless testing with pre-request and test scripts - - Response history and request organization - - Team collaboration with shared collections +- GUI-based API testing with collections and environments +- Import/export Postman collections +- Scriptless testing with pre-request and test scripts +- Response history and request organization +- Team collaboration with shared collections #### PostgreSQL + - **Purpose**: PostgreSQL syntax highlighting and query execution - **Extension ID**: `ms-ossdata.vscode-postgresql` **What you'll use PostgreSQL for:** - - Syntax highlighting for PostgreSQL-specific SQL - - IntelliSense for PostgreSQL functions and keywords - - Query execution and result visualization - - Connection management for PostgreSQL databases - - Schema browsing and table structure viewing +- Syntax highlighting for PostgreSQL-specific SQL +- IntelliSense for PostgreSQL functions and keywords +- Query execution and result visualization +- Connection management for PostgreSQL databases +- Schema browsing and table structure viewing #### YAML + - **Purpose**: YAML language support with validation and formatting - **Extension ID**: `redhat.vscode-yaml` **What you'll use YAML for:** - - Syntax highlighting and validation for YAML files - - Schema validation for Kubernetes, Docker Compose, and CI/CD files - - Auto-completion based on YAML schemas - - Formatting and indentation correction - - Error detection and quick fixes +- Syntax highlighting and validation for YAML files +- Schema validation for Kubernetes, Docker Compose, and CI/CD files +- Auto-completion based on YAML schemas +- Formatting and indentation correction +- Error detection and quick fixes #### Kubernetes + - **Purpose**: Kubernetes cluster management and YAML editing - **Extension ID**: `ms-kubernetes-tools.vscode-kubernetes-tools` **What you'll use Kubernetes for:** - - Deploy and manage Kubernetes applications - - Browse cluster resources and view logs - - IntelliSense for Kubernetes YAML manifests - - Port forwarding and terminal access to pods - - Helm chart development and deployment +- Deploy and manage Kubernetes applications +- Browse cluster resources and view logs +- IntelliSense for Kubernetes YAML manifests +- Port forwarding and terminal access to pods +- Helm chart development and deployment #### Vue Language Features @@ -251,10 +262,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use Vue Language Features for**: - - Advanced TypeScript support in Vue components - - Better performance and accuracy than legacy Vue extensions - - Composition API and script setup syntax support - - Template type checking and validation - - Integration with Vue 3 features and modern Vue development +- Advanced TypeScript support in Vue components +- Better performance and accuracy than legacy Vue extensions +- Composition API and script setup syntax support +- Template type checking and validation +- Integration with Vue 3 features and modern Vue development --- diff --git a/onboarding/code-editor-extensions-and-plugins/neovim.md b/onboarding/code-editor-extensions-and-plugins/neovim.md index 596a87d..a41de77 100644 --- a/onboarding/code-editor-extensions-and-plugins/neovim.md +++ b/onboarding/code-editor-extensions-and-plugins/neovim.md @@ -20,10 +20,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use lazy.nvim for:** - - Lazy-loading plugins for faster startup times - - Automatic plugin installation and updates - - Dependency management between plugins - - Performance optimization and configuration management +- Lazy-loading plugins for faster startup times +- Automatic plugin installation and updates +- Dependency management between plugins +- Performance optimization and configuration management ### Essential Plugins @@ -34,10 +34,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use nvim-treesitter for:** - - Superior syntax highlighting for 40+ languages - - Intelligent code folding and text objects - - Incremental parsing for large files - - Foundation for other advanced plugins +- Superior syntax highlighting for 40+ languages +- Intelligent code folding and text objects +- Incremental parsing for large files +- Foundation for other advanced plugins #### telescope.nvim @@ -46,10 +46,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use telescope.nvim for:** - - Quick file navigation and opening - - Search through project files and content - - Git integration for branch and commit browsing - - Command palette functionality +- Quick file navigation and opening +- Search through project files and content +- Git integration for branch and commit browsing +- Command palette functionality #### nvim-lspconfig @@ -58,10 +58,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use nvim-lspconfig for:** - - Configure language servers for your programming languages - - IntelliSense, go-to-definition, and error diagnostics - - Code actions and refactoring capabilities - - Integration with completion and formatting plugins +- Configure language servers for your programming languages +- IntelliSense, go-to-definition, and error diagnostics +- Code actions and refactoring capabilities +- Integration with completion and formatting plugins #### nvim-cmp @@ -70,10 +70,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use nvim-cmp for:** - - Intelligent code completion from LSP servers - - Snippet expansion and management - - Buffer and path completion - - Integration with external completion sources +- Intelligent code completion from LSP servers +- Snippet expansion and management +- Buffer and path completion +- Integration with external completion sources #### gitsigns.nvim @@ -82,10 +82,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use gitsigns.nvim for:** - - Visual Git diff indicators in the sign column - - Stage and unstage hunks directly from the editor - - Navigate through Git changes efficiently - - Inline Git blame information +- Visual Git diff indicators in the sign column +- Stage and unstage hunks directly from the editor +- Navigate through Git changes efficiently +- Inline Git blame information #### fugitive.vim @@ -94,10 +94,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use fugitive.vim for:** - - Complete Git workflow from within Neovim - - Interactive staging and committing - - Branch management and merging - - Git history browsing and comparison +- Complete Git workflow from within Neovim +- Interactive staging and committing +- Branch management and merging +- Git history browsing and comparison #### nvim-tree.lua @@ -106,10 +106,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use nvim-tree.lua for:** - - Visual file system navigation - - File and directory operations - - Project structure overview - - Integration with Git status indicators +- Visual file system navigation +- File and directory operations +- Project structure overview +- Integration with Git status indicators #### lualine.nvim @@ -118,10 +118,10 @@ Welcome to the Linux Foundation development team! This guide provides recommende **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 +- 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 #### undotree @@ -130,36 +130,36 @@ Welcome to the Linux Foundation development team! This guide provides recommende **What you'll use undotree for**: - - Navigate complex undo/redo history with visual tree representation - - Recover lost changes from branched undo paths - - Compare different states of your file during editing sessions - - Advanced text recovery and change management +- Navigate complex undo/redo history with visual tree representation +- Recover lost changes from branched undo paths +- Compare different states of your file during editing sessions +- Advanced text recovery and change management #### avante.nvim -- **Repository**: https://github.com/yetone/avante.nvim +- **Repository**: - **Purpose**: AI-powered code editing and chat interface **What you'll use avante.nvim for**: - - Interactive AI chat for code explanations and debugging - - AI-assisted code refactoring and optimization - - Natural language code generation and modification - - Inline AI suggestions and code improvements +- Interactive AI chat for code explanations and debugging +- AI-assisted code refactoring and optimization +- Natural language code generation and modification +- Inline AI suggestions and code improvements #### supermaven-nvim -- **Repository**: https://github.com/supermaven-inc/supermaven-nvim +- **Repository**: - **Purpose**: Fast AI code completion with context awareness **What you'll use supermaven-nvim for**: - - Lightning-fast AI-powered code suggestions and completions - - Context-aware code generation based on your entire codebase - - Multi-language support with optimized performance - - Seamless integration with existing completion workflows +- Lightning-fast AI-powered code suggestions and completions +- Context-aware code generation based on your entire codebase +- Multi-language support with optimized performance +- Seamless integration with existing completion workflows ---- +--- You can find a list of more plugins at [https://github.com/rockerBOO/awesome-neovim](https://github.com/rockerBOO/awesome-neovim) --- diff --git a/onboarding/code-editor-extensions-and-plugins/zed.md b/onboarding/code-editor-extensions-and-plugins/zed.md index c0aa297..ac50f18 100644 --- a/onboarding/code-editor-extensions-and-plugins/zed.md +++ b/onboarding/code-editor-extensions-and-plugins/zed.md @@ -15,126 +15,135 @@ Welcome to the Linux Foundation development team! This guide provides recommende ### General Extensions #### Git Firefly + - **Purpose**: Enhanced Git workflow visualization and management - **Extension ID**: `git-firefly` **What you'll use Git Firefly for:** - - Advanced Git history visualization with interactive timelines - - Enhanced branch management and merge conflict resolution - - Commit message templates and conventional commit support - - Git workflow automation and custom git command integration - - Advanced diff viewing with side-by-side comparisons - +- Advanced Git history visualization with interactive timelines +- Enhanced branch management and merge conflict resolution +- Commit message templates and conventional commit support +- Git workflow automation and custom git command integration +- Advanced diff viewing with side-by-side comparisons #### Emmet + - **Purpose**: High-speed HTML and CSS coding with abbreviation expansion - **Extension ID**: `emmet` (Built-in to Zed) **What you'll use Emmet for:** - - Rapid HTML structure creation using CSS selector syntax - - CSS property abbreviation expansion for faster styling - - Lorem ipsum text generation and placeholder content - - Number increment/decrement operations for batch editing - - Wrap with abbreviation for restructuring existing code +- Rapid HTML structure creation using CSS selector syntax +- CSS property abbreviation expansion for faster styling +- Lorem ipsum text generation and placeholder content +- Number increment/decrement operations for batch editing +- Wrap with abbreviation for restructuring existing code ### Workflow Specific Extensions #### HTML + - **Purpose**: HTML language support with syntax highlighting and validation - **Extension ID**: `html` (Built-in to Zed) **What you'll use HTML for:** - - Syntax highlighting and code completion for HTML elements - - Auto-completion for HTML attributes and values - - Tag matching and validation for proper HTML structure - - Integration with CSS and JavaScript for full web development - - Emmet-like abbreviation expansion for rapid HTML authoring +- Syntax highlighting and code completion for HTML elements +- Auto-completion for HTML attributes and values +- Tag matching and validation for proper HTML structure +- Integration with CSS and JavaScript for full web development +- Emmet-like abbreviation expansion for rapid HTML authoring #### TOML + - **Purpose**: TOML configuration file support with syntax highlighting - **Extension ID**: `toml` **What you'll use TOML for:** - - Syntax highlighting for TOML configuration files - - Validation and error detection for TOML syntax - - Auto-completion for common TOML structures - - Support for Cargo.toml, pyproject.toml, and other config files - - Formatting and indentation for clean configuration files +- Syntax highlighting for TOML configuration files +- Validation and error detection for TOML syntax +- Auto-completion for common TOML structures +- Support for Cargo.toml, pyproject.toml, and other config files +- Formatting and indentation for clean configuration files #### SQL + - **Purpose**: SQL language support for database development - **Extension ID**: `sql` **What you'll use SQL for:** - - Syntax highlighting for SQL queries across multiple database dialects - - IntelliSense for SQL keywords, functions, and database objects - - Query formatting and beautification for readable code - - Error detection and validation for SQL syntax - - Integration with database connections and query execution +- Syntax highlighting for SQL queries across multiple database dialects +- IntelliSense for SQL keywords, functions, and database objects +- Query formatting and beautification for readable code +- Error detection and validation for SQL syntax +- Integration with database connections and query execution #### Dockerfile + - **Purpose**: Docker container development and configuration support - **Extension ID**: `dockerfile` **What you'll use Dockerfile for:** - - Syntax highlighting and validation for Dockerfile instructions - - Auto-completion for Docker commands and best practices - - Linting and security recommendations for container builds - - Integration with Docker CLI for building and testing containers - - Support for multi-stage builds and advanced Docker features +- Syntax highlighting and validation for Dockerfile instructions +- Auto-completion for Docker commands and best practices +- Linting and security recommendations for container builds +- Integration with Docker CLI for building and testing containers +- Support for multi-stage builds and advanced Docker features #### Angular + - **Purpose**: Angular framework development with comprehensive tooling - **Extension ID**: `angular` **What you'll use Angular for:** - - Syntax highlighting and IntelliSense for Angular templates - - Component, service, and directive code completion - - TypeScript integration with Angular-specific decorators - - Template syntax validation and error detection - - Integration with Angular CLI for project scaffolding and builds +- Syntax highlighting and IntelliSense for Angular templates +- Component, service, and directive code completion +- TypeScript integration with Angular-specific decorators +- Template syntax validation and error detection +- Integration with Angular CLI for project scaffolding and builds #### Vue + - **Purpose**: Vue.js framework development with single-file component support - **Extension ID**: `vue` **What you'll use Vue for:** - - Syntax highlighting for Vue single-file components (.vue) - - Template, script, and style section IntelliSense - - Vue 3 Composition API and Options API support - - Component props and emit validation - - Integration with Vue CLI and Vite development workflows +- Syntax highlighting for Vue single-file components (.vue) +- Template, script, and style section IntelliSense +- Vue 3 Composition API and Options API support +- Component props and emit validation +- Integration with Vue CLI and Vite development workflows #### SCSS + - **Purpose**: SCSS/Sass preprocessor support for advanced CSS development - **Extension ID**: `scss` **What you'll use SCSS for:** - - Syntax highlighting for SCSS/Sass variables, mixins, and functions - - Auto-completion for SCSS-specific features and built-in functions - - Nesting validation and formatting for clean stylesheet structure - - Color preview and picker integration for visual development - - Compilation and error detection for SCSS to CSS transformation +- Syntax highlighting for SCSS/Sass variables, mixins, and functions +- Auto-completion for SCSS-specific features and built-in functions +- Nesting validation and formatting for clean stylesheet structure +- Color preview and picker integration for visual development +- Compilation and error detection for SCSS to CSS transformation #### Terraform + - **Purpose**: Infrastructure as Code development with Terraform support - **Extension ID**: `terraform` **What you'll use Terraform for:** - - Syntax highlighting for Terraform configuration files (.tf) - - IntelliSense for Terraform resources, providers, and modules - - Validation and linting for Terraform best practices - - Integration with Terraform CLI for plan, apply, and destroy operations - - Support for Terraform workspaces and state management +- Syntax highlighting for Terraform configuration files (.tf) +- IntelliSense for Terraform resources, providers, and modules +- Validation and linting for Terraform best practices +- Integration with Terraform CLI for plan, apply, and destroy operations +- Support for Terraform workspaces and state management --- diff --git a/onboarding/development-tools-and-platforms.md b/onboarding/development-tools-and-platforms.md index 74f6e7d..1e1ce88 100644 --- a/onboarding/development-tools-and-platforms.md +++ b/onboarding/development-tools-and-platforms.md @@ -20,18 +20,17 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use 1Password for:** - - Store and share team passwords, API keys, and sensitive information securely - - Generate strong passwords for all development accounts - - Access shared team vaults for common credentials - - Store secure notes and documents related to projects - - Backup codes for two-factor authentication across all platforms +- Store and share team passwords, API keys, and sensitive information securely +- Generate strong passwords for all development accounts +- Access shared team vaults for common credentials +- Store secure notes and documents related to projects +- Backup codes for two-factor authentication across all platforms **How to get access:** 1. Access is typically granted 2. If you cannot access, contact your team lead - **Setup Steps:** 1. Install 1Password browser extension for seamless login experience @@ -49,17 +48,17 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use GitHub for:** - - Clone and contribute to LFX platform repositories - - Create feature branches - - Submit pull requests - - Participate in code reviews and provide feedback to team members - - Track issues and collaborate on technical discussions - - Access documentation, coding standards, and architecture decisions +- Clone and contribute to LFX platform repositories +- Create feature branches +- Submit pull requests +- Participate in code reviews and provide feedback to team members +- Track issues and collaborate on technical discussions +- Access documentation, coding standards, and architecture decisions **How to get access:** - 1. You must have your personal GitHub account added to the Linux Foundation organization. - 2. To request access, ask your manager to submit a support ticket on your behalf. + 1. You must have your personal GitHub account added to the Linux Foundation organization. + 2. To request access, ask your manager to submit a support ticket on your behalf. 3. Access is managed through single sign-on (SSO). **Setup Steps:** @@ -77,15 +76,15 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use lfx-engineering for:** - - Access onboarding materials and training resources - - Review architecture documentation and technical specifications - - Learn AI integrations and mcp clients - - Contribute to internal documentation and knowledge sharing +- Access onboarding materials and training resources +- Review architecture documentation and technical specifications +- Learn AI integrations and mcp clients +- Contribute to internal documentation and knowledge sharing **How to get access:** - 1. You must have your personal GitHub account added to the Linux Foundation organization. - 2. To request access, ask your manager to submit a support ticket on your behalf. + 1. You must have your personal GitHub account added to the Linux Foundation organization. + 2. To request access, ask your manager to submit a support ticket on your behalf. 3. Access is managed through single sign-on (SSO). --- @@ -101,11 +100,11 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use Cursor for:** - - AI-powered code completion and generation for faster development - - Intelligent code refactoring and debugging assistance - - Natural language to code translation for complex logic - - Integration with our team's extensions and coding standards - - Collaborative debugging sessions with AI assistance +- AI-powered code completion and generation for faster development +- Intelligent code refactoring and debugging assistance +- Natural language to code translation for complex logic +- Integration with our team's extensions and coding standards +- Collaborative debugging sessions with AI assistance **How to get access:** @@ -126,11 +125,11 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use Zed for:** - - Lightning-fast performance for large codebases - - Real-time collaborative editing during pair programming sessions - - Built-in terminal integration for development workflows - - Git integration for seamless version control - - Minimalist interface that reduces cognitive load during coding +- Lightning-fast performance for large codebases +- Real-time collaborative editing during pair programming sessions +- Built-in terminal integration for development workflows +- Git integration for seamless version control +- Minimalist interface that reduces cognitive load during coding **How to get access:** @@ -150,11 +149,11 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use Neovim for:** - - Highly efficient keyboard-driven editing for experienced developers - - Customizable development environment tailored to your workflow - - Powerful plugin ecosystem for language-specific development - - Terminal-based editing for remote development and server work - - Lua scripting for advanced configuration and automation +- Highly efficient keyboard-driven editing for experienced developers +- Customizable development environment tailored to your workflow +- Powerful plugin ecosystem for language-specific development +- Terminal-based editing for remote development and server work +- Lua scripting for advanced configuration and automation **How to get access:** @@ -177,9 +176,9 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use API Gateway for:** - - Access comprehensive API documentation for all LFX services - - Test API endpoints during development and debugging - - Understand request/response formats and authentication requirements +- Access comprehensive API documentation for all LFX services +- Test API endpoints during development and debugging +- Understand request/response formats and authentication requirements **How to get access:** @@ -197,11 +196,11 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use Jira for:** - - Track and update progress on assigned bugs, features, and technical debt - - Create detailed bug reports with reproduction steps and severity levels - - Manage feature requests through our workflow: Backlog β†’ In Progress β†’ Code Review β†’ Testing β†’ Done - - Estimate story points and track velocity metrics - - Generate reports for stakeholders and project planning +- Track and update progress on assigned bugs, features, and technical debt +- Create detailed bug reports with reproduction steps and severity levels +- Manage feature requests through our workflow: Backlog β†’ In Progress β†’ Code Review β†’ Testing β†’ Done +- Estimate story points and track velocity metrics +- Generate reports for stakeholders and project planning **How to get access:** @@ -211,7 +210,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **Setup Steps:** 1. Sign in to Jira using your Linux Foundation credentials - 2. Set up email notifications to your preference + 2. Set up email notifications to your preference 3. View your team's project boards and understand the workflow stages 4. Install Jira mobile app for updates on the go @@ -226,10 +225,10 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use DataDog for:** - - Monitor application performance and uptime, including many LFX products and services - - View logs and screen recorded sessions for debugging - - Review Real User Monitoring (RUM) data for user experience insights - - View infrastructure metrics to understand system resource usage +- Monitor application performance and uptime, including many LFX products and services +- View logs and screen recorded sessions for debugging +- Review Real User Monitoring (RUM) data for user experience insights +- View infrastructure metrics to understand system resource usage **How to get access:** @@ -243,15 +242,15 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use Snowflake for:** - - Query large datasets for business intelligence and reporting needs - - Analyze user behavior and application metrics for product decisions - - Extract data for machine learning models and analytics projects - - Generate custom reports for stakeholders and project planning - - Collaborate with data team on complex analytical queries +- Query large datasets for business intelligence and reporting needs +- Analyze user behavior and application metrics for product decisions +- Extract data for machine learning models and analytics projects +- Generate custom reports for stakeholders and project planning +- Collaborate with data team on complex analytical queries **How to get access:** - - Step 1: Datalake Team: IT/Ops Team Account Setup +- Step 1: Datalake Team: IT/Ops Team Account Setup 1. Determine which roles should be added to the new user(s). 2. Create a pull request to add the users and roles to the GitHub Snowflake Terraform repository. Here’s a link [to the GitHub @@ -260,7 +259,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie 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. - - Step 2: Developer: User Account Setup +- Step 2: Developer: User Account Setup 1. Once Step 1 above is complete, users can now log into Snowflake. 2. [Direct Link to The Linux Foundation](https://app.snowflake.com/jnmhvwd/xpb85243/) Snowflake account. @@ -286,7 +285,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use LFX-Datalake diagram for:** - - Understand overall organization architecture and platform relationships +- Understand overall organization architecture and platform relationships **How to get access:** @@ -299,13 +298,12 @@ Welcome to the Linux Foundation development team! This guide provides an overvie **What you'll use the organization chart for:** - - Understand team structure, roles, and reporting relationships +- Understand team structure, roles, and reporting relationships **How to get access:** 1. Request access to the specific diagram from your director or team lead - TODO: Leaving for David Deal to update ### LFX-Datalake @@ -326,19 +324,18 @@ TODO: Leaving for David Deal to update **How to get access:** - - Google Workspace is managed through single sign-on (SSO) - - If you cannot access specific documents, request sharing permissions from document owner +- Google Workspace is managed through single sign-on (SSO) +- If you cannot access specific documents, request sharing permissions from document owner #### Google Spreadsheets - **Purpose**: Linux Foundation storage of files shared with you - **URL**: [https://docs.google.com/spreadsheets/](https://docs.google.com/spreadsheets/) - **How to get access:** - - Google Workspace is managed through single sign-on (SSO) - - If you cannot access specific documents, request sharing permissions from spreadsheet owner +- Google Workspace is managed through single sign-on (SSO) +- If you cannot access specific documents, request sharing permissions from spreadsheet owner #### Google Slides @@ -347,8 +344,8 @@ TODO: Leaving for David Deal to update **How to get access:** - - Google Workspace is managed through single sign-on (SSO) - - If you cannot access specific documents, request sharing permissions from presentation owner +- Google Workspace is managed through single sign-on (SSO) +- If you cannot access specific documents, request sharing permissions from presentation owner #### Google Vids @@ -357,8 +354,8 @@ TODO: Leaving for David Deal to update **How to get access:** - - Google Workspace is managed through single sign-on (SSO) - - If you cannot access specific documents, request sharing permissions from video owner +- Google Workspace is managed through single sign-on (SSO) +- If you cannot access specific documents, request sharing permissions from video owner #### Google Forms @@ -367,8 +364,8 @@ TODO: Leaving for David Deal to update **How to get access:** - - Google Workspace is managed through single sign-on (SSO) - - If you cannot access specific documents, request sharing permissions from form owner +- Google Workspace is managed through single sign-on (SSO) +- If you cannot access specific documents, request sharing permissions from form owner #### Google Drive @@ -377,7 +374,7 @@ TODO: Leaving for David Deal to update **How to get access:** - - Google Workspace is managed through single sign-on (SSO) +- Google Workspace is managed through single sign-on (SSO) --- @@ -390,10 +387,10 @@ TODO: Leaving for David Deal to update **What you'll use Individual Dashboard for:** - - Track your technical contributions across projects and repositories - - Monitor your training progress and certifications - - View upcoming meetings and events relevant to your role - - Access performance metrics and goal tracking information +- Track your technical contributions across projects and repositories +- Monitor your training progress and certifications +- View upcoming meetings and events relevant to your role +- Access performance metrics and goal tracking information **Setup Steps:** @@ -406,11 +403,11 @@ TODO: Leaving for David Deal to update **What you'll use Calamari for:** - - Request vacation time, sick leave, and other time off - - View your time off balance and accrual rates - - Submit time off requests for manager approval - - View team calendar to coordinate time off with colleagues - - Track public holidays and company-wide time off policies +- Request vacation time, sick leave, and other time off +- View your time off balance and accrual rates +- Submit time off requests for manager approval +- View team calendar to coordinate time off with colleagues +- Track public holidays and company-wide time off policies **How to get access:** From 9a96d1f7054a06911133e1f406cca717dc0ea6cc Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Mon, 25 Aug 2025 11:26:44 +0100 Subject: [PATCH 13/14] fix: update liniting issues Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/code-editor-extensions-and-plugins/neovim.md | 1 - onboarding/development-tools-and-platforms.md | 6 +++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/onboarding/code-editor-extensions-and-plugins/neovim.md b/onboarding/code-editor-extensions-and-plugins/neovim.md index a41de77..48b8f3d 100644 --- a/onboarding/code-editor-extensions-and-plugins/neovim.md +++ b/onboarding/code-editor-extensions-and-plugins/neovim.md @@ -162,4 +162,3 @@ Welcome to the Linux Foundation development team! This guide provides recommende --- You can find a list of more plugins at [https://github.com/rockerBOO/awesome-neovim](https://github.com/rockerBOO/awesome-neovim) ---- diff --git a/onboarding/development-tools-and-platforms.md b/onboarding/development-tools-and-platforms.md index 1e1ce88..11e4311 100644 --- a/onboarding/development-tools-and-platforms.md +++ b/onboarding/development-tools-and-platforms.md @@ -257,7 +257,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie repository](https://github.com/linuxfoundation/lfx-snowflake-terraform) and the user configuration file. Anyone can create a pull request. 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 + Slack channel. They will review and merge the pull request changes which will trigger a deployment to the Snowflake production environment. - Step 2: Developer: User Account Setup 1. Once Step 1 above is complete, users can now log into Snowflake. @@ -306,7 +306,7 @@ Welcome to the Linux Foundation development team! This guide provides an overvie TODO: Leaving for David Deal to update -### LFX-Datalake +### LFX-Datalake2 - **Purpose**: Architecture diagram showing LFX services, data flows, and system dependencies - **URL**: [https://github.com/linuxfoundation/lfx-architecture/blob/main/diagrams/data-flow.md](https://github.com/linuxfoundation/lfx-architecture/blob/main/diagrams/data-flow.md) @@ -399,7 +399,7 @@ TODO: Leaving for David Deal to update ### Calamari - **Purpose**: Internal Linux Foundation tool for time off tracking -- **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) +- **URL**: [https://lfx.calamari.io/](http://lfx.calamari.io/) **What you'll use Calamari for:** From 10615a3e18b67a40973afac2ebd0c60cc21113f8 Mon Sep 17 00:00:00 2001 From: Audi Young <122812915+audigregorie@users.noreply.github.com> Date: Mon, 25 Aug 2025 11:52:11 +0100 Subject: [PATCH 14/14] fix: update spelling issue Signed-off-by: Audi Young <122812915+audigregorie@users.noreply.github.com> --- onboarding/development-tools-and-platforms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/onboarding/development-tools-and-platforms.md b/onboarding/development-tools-and-platforms.md index 11e4311..713bfc7 100644 --- a/onboarding/development-tools-and-platforms.md +++ b/onboarding/development-tools-and-platforms.md @@ -399,7 +399,7 @@ TODO: Leaving for David Deal to update ### Calamari - **Purpose**: Internal Linux Foundation tool for time off tracking -- **URL**: [https://lfx.calamari.io/](http://lfx.calamari.io/) +- **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/) **What you'll use Calamari for:**