mirror of https://github.com/fleetdm/fleet synced 2026-05-23 00:49:03 +00:00

History

Sarah Gillespie 9fcd2e15c2 Add one-time challenge support to custom SCEP proxy (#29832 )		2025-06-12 08:56:13 -05:00
..
adr	Update contrib docs headers to sentence case (#29276 )	2025-05-20 11:26:35 -05:00
architecture	Update contrib docs headers to sentence case (#29276 )	2025-05-20 11:26:35 -05:00
assets	SCIM Entra ID support (#28832 )	2025-05-08 13:02:49 -05:00
getting-started	Building Fleet: Link to specific Node version (#29735 )	2025-06-03 15:12:33 -06:00
guides	Update contrib docs headers to sentence case (#29276 )	2025-05-20 11:26:35 -05:00
product-groups	Add one-time challenge support to custom SCEP proxy (#29832 )	2025-06-12 08:56:13 -05:00
reference	Add contributor docs for self-service uninstall results endpoint (#29835 )	2025-06-11 16:27:56 -05:00
research	Add research doc: account-driven user enrollment (#29469 )	2025-05-27 15:19:56 -05:00
responsibilities	Organize contributor docs and establish ADR process and template (#29101 )	2025-05-17 15:03:52 -05:00
workflows	Organize contributor docs and establish ADR process and template (#29101 )	2025-05-17 15:03:52 -05:00
README.md	Update contrib docs headers to sentence case (#29276 )	2025-05-20 11:26:35 -05:00

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.