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..339fa45 --- /dev/null +++ b/onboarding/code-editor-extensions-and-plugins/cursor.md @@ -0,0 +1,271 @@ +# 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 +3. **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..48b8f3d --- /dev/null +++ b/onboarding/code-editor-extensions-and-plugins/neovim.md @@ -0,0 +1,164 @@ +# 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**: +- **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**: +- **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 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 new file mode 100644 index 0000000..ac50f18 --- /dev/null +++ b/onboarding/code-editor-extensions-and-plugins/zed.md @@ -0,0 +1,149 @@ +# 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 +3. **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/development-tools-and-platforms.md b/onboarding/development-tools-and-platforms.md new file mode 100644 index 0000000..713bfc7 --- /dev/null +++ b/onboarding/development-tools-and-platforms.md @@ -0,0 +1,452 @@ +# 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. 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 + 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 + +- **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. 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). + +--- + +## πŸ”§ 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. 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) + 4. 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 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 + +**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) + +#### 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 + +**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) + +--- + +## πŸ—ƒοΈ 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 +- 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, 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 + +### 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:** + +- 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 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. + 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://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 + +TODO: Leaving for David Deal to update + +### 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) + +--- + +## πŸ“ 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:** + +- 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 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:** + +- 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/videos) + +**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 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:** + +- Google Workspace is managed through single sign-on (SSO) +- If you cannot access specific documents, request sharing permissions from form owner + +#### Google Drive + +- **Purpose**: Linux Foundation storage of files shared with you +- **URL**: [https://drive.google.com/](https://drive.google.com/) + +**How to get 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/) + +**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**: [https://lfx.calamari.io/](https://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:** + + 1. You should receive an invitation to Calamari via email + 2. Accept invitation and complete account setup + +--- + +## πŸ†˜ 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.*