-
Notifications
You must be signed in to change notification settings - Fork 0
chore: add engineering onboarding documentation #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 3 commits
3486f19
4270140
5a515a9
3d95850
2a07d76
4af33dd
8f5453d
43df975
b6d2c03
a092453
dc9e279
c275362
66cd70c
6f91d4d
9a96d1f
10615a3
c7652f1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,244 @@ | ||
| # 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/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 | ||
|
|
||
| --- | ||
|
|
||
| ## 🏗️ 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**: | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - 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 | ||
|
Check failure on line 237 in onboarding/frontend.md
|
||
| - URLs or access procedures change | ||
| - Tools are deprecated or replaced | ||
|
|
||
| --- | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| *For questions about this documentation or updates to this document, please submit a pull request or contact the development team.* | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,31 @@ | ||||||||
| # 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. | ||||||||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||
|
|
||||||||
| ## 🚀 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! | ||||||||
|
||||||||
| *This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code! | |
| *This guide focuses on LFX platforms and their Getting Started wiki, where developers can build | |
| their local environment and actively contribute code!* |
🧰 Tools
🪛 GitHub Check: markdown-lint
[failure] 31-31: Line length [Expected: 120; Actual: 151]
onboarding/lfx-platforms-list.md:31:121 MD013/line-length Line length [Expected: 120; Actual: 151]
🤖 Prompt for AI Agents
In onboarding/lfx-platforms-list.md around line 31, the italicized sentence is
over 120 characters and unnecessarily uses backticks around "Getting Started";
reflow the sentence to keep line length under 120 characters and remove the
code-style backticks (use plain text or italics instead), splitting into two
shorter sentences or adding a line break to comply with MD013 while preserving
the original meaning about developers building local environments and
contributing code.
Uh oh!
There was an error while loading. Please reload this page.