Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 229 additions & 0 deletions onboarding/frontend.md
Original file line number Diff line number Diff line change
@@ -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

Check failure on line 16 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1Password"]

onboarding/frontend.md:16 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1Password"]
- **Purpose**: Password management and secure credential storage

Check failure on line 17 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Lists should be surrounded by blank lines [Context: "- **Purpose**: Password manage..."]

onboarding/frontend.md:17 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **Purpose**: Password manage..."]
- **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

Check failure on line 30 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Version Control - GitHub"]

onboarding/frontend.md:30 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Version Control - GitHub"]
- **Main Organization**: [https://github.com/linuxfoundation](https://github.com/linuxfoundation)

Check failure on line 31 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Lists should be surrounded by blank lines [Context: "- **Main Organization**: [http..."]

onboarding/frontend.md:31 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **Main Organization**: [http..."]
- **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)

Check failure on line 39 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Integrated Development Environments (IDEs)"]

onboarding/frontend.md:39 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Integrated Development Environments (IDEs)"]
#### Cursor

Check failure on line 40 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "#### Cursor"]

onboarding/frontend.md:40 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "#### Cursor"]

- **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

Check failure on line 77 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### LFX-Engineering Onboarding Platforms List"]

onboarding/frontend.md:77 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### LFX-Engineering Onboarding Platforms List"]
- **Purpose**: List of LFX-related platforms along with their `Getting Started` wiki

Check failure on line 78 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Lists should be surrounded by blank lines [Context: "- **Purpose**: List of LFX-rel..."]

onboarding/frontend.md:78 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **Purpose**: List of LFX-rel..."]
- **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)
Copy link

Copilot AI Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL points to a directory path that references the file being created in this PR. This creates a circular reference and the link will not work as intended. Consider linking to the actual file: lf-platforms-list.md or updating the path structure.

Suggested change
- **URL**: [https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lf-platforms-list](https://github.com/linuxfoundation/lfx-engineering/tree/main/onboarding/lf-platforms-list)
- **URL**: [https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lf-platforms-list.md](https://github.com/linuxfoundation/lfx-engineering/blob/main/onboarding/lf-platforms-list.md)

Copilot uses AI. Check for mistakes.
- **What to do**: Review the list and follow the guide of the platforms you need to work with

---

## 🏗️ Platform Environments

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all related to PCC. If anything, it should either not be part of this documentation, or we need it for all platforms.


### Development Environment

Check failure on line 86 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Development Environment"]

onboarding/frontend.md:86 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Development Environment"]
- **Purpose**: Development environment for testing new features and changes

Check failure on line 87 in onboarding/frontend.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Lists should be surrounded by blank lines [Context: "- **Purpose**: Development env..."]

onboarding/frontend.md:87 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **Purpose**: Development env..."]
- **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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no account setup for this.


---

## 📋 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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not official tools that are used by LF


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid leaking deep links to internal design docs

The Whimsical and Lucidchart deep links expose specific workspace/document IDs in a public repo. Even if access is gated, publishing direct IDs can aid enumeration and may violate internal link-sharing guidelines.

Replace deep links with the product homepages + instructions to request access, or link to an internal wiki that’s access-controlled:

 ### Whimsical
 - **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps
 - **URL**: [https://whimsical.com/](https://whimsical.com/)
-- **Key Workspaces**:
-  - **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X)
+- **Key Workspaces**: Ask your manager/tech lead to invite you to the appropriate Whimsical workspaces (see internal wiki for workspace names/links).
@@
 ### Lucidchart
-- **Organization Structure**: [https://lucid.app/](https://lucid.app/)
+- **URL**: [https://lucid.app/](https://lucid.app/)
 - **Purpose**: Visual diagramming and organizational charts
-- **Key Workspaces**:
-  - **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#)
+- **Key Workspaces**: Ask your manager/tech lead to invite you to the “Linux P&E” Lucidchart org (see internal wiki for links).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Design & Planning
### Whimsical
- **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps
- **URL**: [https://whimsical.com/](https://whimsical.com/)
- **Key Workspaces**:
- **LFX-Datalake**: [https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X)
- **What it does**:
- Create mockups and wireframes
- Document processes and workflows
- Collaborate on designs and architecture
- Mind mapping and brainstorming
- **Account Setup**: Request invitation from your manager or tech lead
### Lucidchart
- **Organization Structure**: [https://lucid.app/](https://lucid.app/)
- **Purpose**: Visual diagramming and organizational charts
- **Key Workspaces**:
- **Linux P&E organization**: [https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#)
- **What it does**:
- View company structure and team organization
- Create flowcharts and system diagrams
- Document processes and workflows
- Collaborative diagram creation
- **Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email account
## Design & Planning
### Whimsical
- **Purpose**: Visual collaboration platform for wireframes, flowcharts, and mind maps
- **URL**: [https://whimsical.com/](https://whimsical.com/)
- **Key Workspaces**: Ask your manager/tech lead to invite you to the appropriate Whimsical workspaces (see internal wiki for workspace names/links).
- **What it does**:
- Create mockups and wireframes
- Document processes and workflows
- Collaborate on designs and architecture
- Mind mapping and brainstorming
- **Account Setup**: Request invitation from your manager or tech lead
### Lucidchart
- **URL**: [https://lucid.app/](https://lucid.app/)
- **Purpose**: Visual diagramming and organizational charts
- **Key Workspaces**: Ask your manager/tech lead to invite you to the “Linux P&E” Lucidchart org (see internal wiki for links).
- **What it does**:
- View company structure and team organization
- Create flowcharts and system diagrams
- Document processes and workflows
- Collaborative diagram creation
- **Account Setup**: Request invitation from your director or tech lead and access with your Linux Foundation email account
🧰 Tools
🪛 LanguageTool

[grammar] ~153-~153: There might be a mistake here.
Context: ...--- ## Design & Planning ### Whimsical - Purpose: Visual collaboration platform...

(QB_NEW_EN)


[grammar] ~154-~154: There might be a mistake here.
Context: ...or wireframes, flowcharts, and mind maps - URL: [https://whimsical.com/](https://...

(QB_NEW_EN)


[grammar] ~155-~155: There might be a mistake here.
Context: ... maps - URL: https://whimsical.com/ - Key Workspaces: - LFX-Datalake: ...

(QB_NEW_EN)


[grammar] ~156-~156: There might be a mistake here.
Context: ...://whimsical.com/) - Key Workspaces: - LFX-Datalake: [https://whimsical.com/l...

(QB_NEW_EN)


[grammar] ~157-~157: There might be a mistake here.
Context: ....com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X](https://whimsical.com/lfx-datalake-Qgy1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and w...

(QB_NEW_EN)


[grammar] ~158-~158: There might be a mistake here.
Context: ...1wT6KC4RtrhCbfVQ37X) - What it does: - Create mockups and wireframes - Docume...

(QB_NEW_EN)


[grammar] ~159-~159: There might be a mistake here.
Context: ...oes**: - Create mockups and wireframes - Document processes and workflows - Col...

(QB_NEW_EN)


[grammar] ~160-~160: There might be a mistake here.
Context: ...mes - Document processes and workflows - Collaborate on designs and architecture ...

(QB_NEW_EN)


[grammar] ~161-~161: There might be a mistake here.
Context: ... Collaborate on designs and architecture - Mind mapping and brainstorming - **Accou...

(QB_NEW_EN)


[grammar] ~162-~162: There might be a mistake here.
Context: ...cture - Mind mapping and brainstorming - Account Setup: Request invitation from...

(QB_NEW_EN)


[grammar] ~165-~165: There might be a mistake here.
Context: ...our manager or tech lead ### Lucidchart - Organization Structure: [https://lucid...

(QB_NEW_EN)


[grammar] ~166-~166: There might be a mistake here.
Context: ...ization Structure**: https://lucid.app/ - Purpose: Visual diagramming and organi...

(QB_NEW_EN)


[grammar] ~167-~167: There might be a mistake here.
Context: ...al diagramming and organizational charts - Key Workspaces: - **Linux P&E organi...

(QB_NEW_EN)


[grammar] ~168-~168: There might be a mistake here.
Context: ...anizational charts - Key Workspaces: - Linux P&E organization: [https://lucid...

(QB_NEW_EN)


[grammar] ~169-~169: There might be a mistake here.
Context: ...93-4f6e-9f31-77cb28de4f81/edit?page=0_0#](https://lucid.app/lucidchart/a39693e8-9f93-4f6e-9f31-77cb28de4f81/edit?page=0_0#) - What it does: - View company structu...

(QB_NEW_EN)


[grammar] ~170-~170: There might be a mistake here.
Context: ...4f81/edit?page=0_0#) - What it does: - View company structure and team organiza...

(QB_NEW_EN)


[grammar] ~175-~175: There might be a mistake here.
Context: ...e diagram creation - Account Setup: Request invitation from your director or tech l...

(QB_NEW_EN)

🤖 Prompt for AI Agents
In onboarding/frontend.md around lines 151 to 176, the Whimsical and Lucidchart
entries expose deep workspace/document links; remove or replace those deep links
with the product homepages (https://whimsical.com/ and https://lucid.app/) and a
short instruction to request access from the manager/tech lead or via the
internal access-controlled wiki; update the "Key Workspaces" lines to either
point to an internal wiki entry (access-controlled) or to a generic "request
access" note, and ensure no workspace/document IDs remain in the public file.

---

## 📁 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.*

30 changes: 30 additions & 0 deletions onboarding/lf-platforms-list.md
Original file line number Diff line number Diff line change
@@ -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!
Copy link

Copilot AI Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence has incomplete punctuation and unclear wording. Consider revising to: 'This guide focuses on LFX platforms and their Getting Started wikis, where developers can build their local environment and actively contribute code.'

Suggested change
*This guide focuses on LFX platforms and their `Getting Started` wiki, where developers can build their local environment and actively contribute code!
*This guide focuses on LFX platforms and their Getting Started wikis, where developers can set up their local environment and actively contribute code.*

Copilot uses AI. Check for mistakes.