Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-04-21 21:47:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 117
fleet/docs/Contributing/README.md

37 lines
1.8 KiB
Markdown
Raw Normal View History

Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
# Fleet Contributor Documentation
Part 3 of documentation restructure. Contribution section. (#149) This PR includes the Contribution section of the documentation restructure #144.
2020-12-24 22:33:03 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
Welcome to the Fleet contributor documentation! This documentation is designed to help you contribute to the Fleet project.
Part 3 of documentation restructure. Contribution section. (#149) This PR includes the Contribution section of the documentation restructure #144.
2020-12-24 22:33:03 +00:00
Update contrib docs headers to sentence case (#29276)
2025-05-20 16:26:35 +00:00
## Documentation structure
Run-Locally-Built-Orbit (#9359) Adding documentation. No testing needed other than reviewing the correctness of the added documentation.
2023-01-19 16:31:24 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
The documentation is organized into the following sections:
Part 3 of documentation restructure. Contribution section. (#149) This PR includes the Contribution section of the documentation restructure #144.
2020-12-24 22:33:03 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
- [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
Update developer docs (#159) - Separate migration documentation from build. - Add link to server on localhost after setup.
2020-12-30 23:20:02 +00:00
Update contrib docs headers to sentence case (#29276)
2025-05-20 16:26:35 +00:00
## Product groups
Part 3 of documentation restructure. Contribution section. (#149) This PR includes the Contribution section of the documentation restructure #144.
2020-12-24 22:33:03 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
Fleet is organized into three main product groups:
Part 3 of documentation restructure. Contribution section. (#149) This PR includes the Contribution section of the documentation restructure #144.
2020-12-24 22:33:03 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
- [MDM](product-groups/mdm/README.md) - Mobile Device Management
- [Orchestration](product-groups/orchestration/README.md) - Device orchestration using osquery
Software documentation updates (#42164) A few small changes to the Contributing documentation as part of oncall responsibility.
2026-03-24 16:39:47 +00:00
- [Security & Compliance](product-groups/security-compliance/README.md) - Software inventory, vulnerability management
- [Software](product-groups/software/README.md) - Software installation
Add top level links to "Contributing" section and move up Load testing "Results" (#2779) - Add top level links to the "Seeding Data" and "API for contributors" doc pages - Move "Results" section in "Loading testing" closer to the top of document
2021-11-05 14:03:05 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
## Contributing
Add top level links to "Contributing" section and move up Load testing "Results" (#2779) - Add top level links to the "Seeding Data" and "API for contributors" doc pages - Move "Results" section in "Loading testing" closer to the top of document
2021-11-05 14:03:05 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
If you're new to Fleet, we recommend starting with the [Getting Started](getting-started/README.md) section to set up your development environment.
Add documentation for deploying ChromeOS test extensions. (#12579) Adding documentation --------- Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com> Co-authored-by: Rachael Shaw <r@rachael.wtf> Co-authored-by: Luke Heath <luke@fleetdm.com>
2023-07-14 18:44:36 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
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.
Add docs for upgrading Go (#27693) For #27605 Adds a guide to the contributor docs about how to upgrade the Go version used to build Fleet.
2025-04-02 20:30:32 +00:00
Organize contributor docs and establish ADR process and template (#29101)
2025-05-17 20:03:52 +00:00
## 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.
Reference in a new issue Copy permalink