fleet/docs/Contributing
Ian Littman f1949ac2bf
Add VPP policy automation support to backend (#25154)
For #23529, #23530.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-01-13 15:53:24 -06:00
..
research/mdm Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -05:00
Adding-new-endpoints.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
API-for-contributors.md Small formatting fix in API for contributors (#25336) 2025-01-10 11:51:35 -06:00
API-Versioning.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Audit-logs.md Add VPP policy automation support to backend (#25154) 2025-01-13 15:53:24 -06:00
Automatically-generating-UI-component-boilerplate.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Building-Fleet.md Update Building-Fleet.md (#22858) 2024-10-15 12:56:20 -05:00
Committing-Changes.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Configuration-for-contributors.md Add detail_query_overrides to contributor docs (#24589) 2024-12-10 15:46:59 -05:00
Deploying-chrome-test-ext.md Enroll hosts docs improvements (#14862) 2023-11-20 19:39:41 +01:00
Enroll-hosts-with-plain-osquery.md Enroll hosts docs improvements (#14862) 2023-11-20 19:39:41 +01:00
FAQ.md List paths used by Fleet desktop (#23891) 2024-12-13 17:47:50 -06:00
File-carving.md Add docs for --dev default MinIO buckets (#21721) 2024-08-30 16:12:43 -05:00
Fleet-UI-Testing.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
fleetctl-apply.md Fix YAML-in-Markdown formatting in Team scripts area of fleetctl apply docs (#21382) 2024-08-19 13:58:16 -05:00
fleetd-development-and-release-strategy.md Docs: Replace Orbit with Fleetd (#12443) 2023-07-21 19:33:31 -05:00
high-level-architecture.md Docs: Add pageOrderInSection meta tag to high-level-architecture.md (#15090) 2023-11-10 11:10:28 -06:00
Infrastructure.md Handbook/company/leadership#structure-of-departmental-handbook-pages (#14811) 2023-11-21 13:55:46 -06:00
MDM-custom-configuration-web-url Add page to contributor docs for custom configuration web URL (#17081) 2024-02-27 09:06:35 -05:00
MDM.md mdm docs index (#22716) 2024-10-11 16:42:45 -03:00
Migrations.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
README.md Docs: Replace Orbit with Fleetd (#12443) 2023-07-21 19:33:31 -05:00
Releasing-Fleet.md Preserve manual release instructions (#22867) 2024-10-11 11:34:38 -05:00
Run-Locally-Built-Fleetd.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
Seeding-Data.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
set-up-custom-end-user-email.md add internal docs to set end user email (#16573) 2024-02-02 18:13:07 -03:00
Simulate-slow-network.md Remove unused toxiproxy service (#21554) 2024-08-26 13:28:51 -03:00
Teams.md Add contributor docs to document the teams/no team conventions (#24569) 2024-12-10 10:19:28 -05:00
Testing-and-local-development.md Updated MailHog/Mailpit instructions for current UI and consistency (#24954) 2024-12-20 14:29:41 -06:00
Troubleshooting-live-queries.md Move "Troubleshooting live queries" page to contributors docs (#16775) 2024-02-19 16:39:12 +01:00
Understanding-host-vitals.md Remove homebrew app casks (#24593) 2024-12-24 13:25:53 -07:00
Vulnerability-processing.md Update vulnerability processing docs to reference goval-dictionary (#21536) 2024-08-26 21:38:03 -05:00
windows-mdm-glossary-and-protocol.md Windows MDM Fix Manual Detection (#17721) 2024-03-21 15:09:05 -04:00

Contributing

Building Fleet

Learn about building the code, development infrastructure, and database migrations.

Build and run Fleetd from local code

Building and running your modified code.

Testing

Look at Fleet's full test suite and integration tests.

Migrations

Learn about creating and updating database migrations.

Committing changes

Learn how to merge changes into the codebase.

Releasing Fleet

Learn the process for how to release Fleet.

Seeding data

Learn how to add fake data to your development instance.

API for contributors

Get to grips with Fleet API routes. This documentation is helpful for developing or contributing to Fleet.

Deploying ChromeOS test extensions

Learn how to deploy a test version of the fleetd Chrome extension for debug purposes.

FAQ

Find commonly asked questions and answers about contributing to Fleet as part of our community.