mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 21:47:20 +00:00
36 lines
1.8 KiB
Markdown
36 lines
1.8 KiB
Markdown
# 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](getting-started/README.md) - Setup, building, and testing Fleet
|
|
- [Guides](guides/README.md) - How-to guides for common tasks
|
|
- [Architecture](architecture/README.md) - High-level architecture documentation
|
|
- [Product Groups](product-groups/README.md) - Documentation for specific product groups
|
|
- [Workflows](workflows/README.md) - Development workflows
|
|
- [Reference](reference/README.md) - API reference, configuration, etc.
|
|
- [ADRs](adr/README.md) - Architectural Decision Records
|
|
- [Research](research/) - Research documents for product groups
|
|
- [Responsibilities](responsibilities/) - Responsibility documents for product groups
|
|
|
|
## Product groups
|
|
|
|
Fleet is organized into three main product groups:
|
|
|
|
- [MDM](product-groups/mdm/README.md) - Mobile Device Management
|
|
- [Orchestration](product-groups/orchestration/README.md) - Device orchestration using osquery
|
|
- [Security & Compliance](product-groups/security-compliance/README.md) - Software inventory, vulnerability management
|
|
- [Software](product-groups/software/README.md) - Software installation
|
|
|
|
## Contributing
|
|
|
|
If you're new to Fleet, we recommend starting with the [Getting Started](getting-started/README.md) section to set up your development environment.
|
|
|
|
Once you're set up, you can explore the [Guides](guides/README.md) section to learn how to contribute to specific areas of the project.
|
|
|
|
## Architectural Decision Records (ADRs)
|
|
|
|
We use [Architectural Decision Records](adr/README.md) to document significant architectural decisions. If you're making a significant architectural change, please create an ADR to document your decision.
|