mirror of https://github.com/fleetdm/fleet synced 2026-05-19 06:58:30 +00:00

History

Zach Wasserman 11097befb4 Add last used information for Windows software (programs) (#30577 ) For #28819		2025-07-08 12:58:25 -07:00
..
adr	ADR-0001: Pilot splitting service layer into separate Go packages 📦 (#29850 )	2025-06-17 11:28:22 -05:00
architecture	Disk Encryption contributor doc updates (#30538 )	2025-07-07 11:07:33 -04:00
assets	SCIM Entra ID support (#28832 )	2025-05-08 13:02:49 -05:00
getting-started	Replace home-made SAML implementation with https://github.com/crewjam/saml (#28486 )	2025-07-07 15:13:46 -03:00
guides	Clean up "here" link anchors for docs, ee, and frontend dirs (#29742 )	2025-06-13 15:05:52 -05:00
product-groups	Add last used information for Windows software (programs) (#30577 )	2025-07-08 12:58:25 -07:00
reference	Docs v4.70.0 (#30432 )	2025-06-30 16:33:32 -05:00
research	Clean up "here" link anchors for docs, ee, and frontend dirs (#29742 )	2025-06-13 15:05:52 -05:00
responsibilities	Organize contributor docs and establish ADR process and template (#29101 )	2025-05-17 15:03:52 -05:00
workflows	Clean up "here" link anchors for docs, ee, and frontend dirs (#29742 )	2025-06-13 15:05: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.