chore: add engineering onboarding documentation #21
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,224 @@ | ||||||
| # 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**: Ensure your personal GitHub account is added to the organization | ||||||
|
|
||||||
| ### 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**: Ensure your personal GitHub account is added to the organization | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## 🔧 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**: Request access to our team plan. | ||||||
|
|
||||||
| #### 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. Download and install. | ||||||
|
|
||||||
| #### 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. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## 🗃️ 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 | ||||||
| - View logs and screen recorded sessions for debugging | ||||||
| - Track infrastructure metrics and alerts | ||||||
|
|
||||||
| ### 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 | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## 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) | ||||||
|
|
||||||
| ### 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 | ||||||
|
|
||||||
| ### Google Workspace | ||||||
|
|
||||||
| #### 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 Vids | ||||||
|
|
||||||
| - **Purpose**: Linux Foundation storage of files shared with you | ||||||
| - **URL**: [https://docs.google.com/videos](https://docs.google.com/video) | ||||||
|
|
||||||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| #### Google Forms | ||||||
|
|
||||||
| - **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, 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 time off tracking | ||||||
| - **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) | ||||||
|
|
||||||
|
||||||
| - **URL**: [http://lfx.calamari.io/](http://lfx.calamari.io/) | |
| - **URL**: [https://lfx.calamari.io/](https://lfx.calamari.io/) |
🤖 Prompt for AI Agents
in onboarding/developer-tools-and-platforms.md around lines 188 to 189, the
Calamari link uses http which can cause mixed-content and downgrade risks;
update the URL to use https (https://lfx.calamari.io/) in the markdown link,
verify the HTTPS endpoint is reachable, and commit the updated link text so
documentation consistently uses secure links.
Contributor
There was a problem hiding this comment.
@audigregorie Thank you for addressing the security concern! Using HTTPS for the Calamari URL will help ensure secure connections and prevent potential mixed-content issues.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct Google Docs URL
Linking Docs to Drive is confusing. Point to the Docs app.
🧰 Tools
🪛 LanguageTool
[grammar] ~148-~148: There might be a mistake here.
Context: ...ndation storage of files shared with you - URL: [https://drive.google.com/](https...
(QB_NEW_EN)
🤖 Prompt for AI Agents