mirror of
https://github.com/fleetdm/fleet
synced 2026-05-06 14:58:33 +00:00
5e9cc244df
See doc <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a new architectural decision record outlining the standard process for managing and updating third-party libraries with local modifications. * Updated the ADR index to include links and descriptions for ADR-0001 through ADR-0004, improving documentation clarity and accessibility. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Luke Heath <luke@fleetdm.com> |
||
|---|---|---|
| .. | ||
| adr | ||
| architecture | ||
| assets | ||
| getting-started | ||
| guides | ||
| product-groups | ||
| reference | ||
| research | ||
| responsibilities | ||
| workflows | ||
| README.md | ||
Fleet Contributor Documentation
Welcome to the Fleet contributor documentation! This documentation is designed to help you contribute to the Fleet project.
Documentation structure
The documentation is organized into the following sections:
- Getting Started - Setup, building, and testing Fleet
- Guides - How-to guides for common tasks
- Architecture - High-level architecture documentation
- Product Groups - Documentation for specific product groups
- Workflows - Development workflows
- Reference - API reference, configuration, etc.
- ADRs - Architectural Decision Records
- Research - Research documents for product groups
- Responsibilities - Responsibility documents for product groups
Product groups
Fleet is organized into three main product groups:
- MDM - Mobile Device Management
- Orchestration - Device orchestration using osquery
- Software - Software inventory, vulnerability management, and software installation
Contributing
If you're new to Fleet, we recommend starting with the Getting Started section to set up your development environment.
Once you're set up, you can explore the Guides section to learn how to contribute to specific areas of the project.
Architectural Decision Records (ADRs)
We use Architectural Decision Records to document significant architectural decisions. If you're making a significant architectural change, please create an ADR to document your decision.