Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-24 09:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 31
fleet/docs/Contributing
History
Noah Talerman 2a60823a93
Update Kubernetes best practice docs (#16807) 
- Remove example YAML file from docs to deduplicate
- Update "Prepare a new version of Fleet" handbook instructions to point
to the best practice YAML
- Add README to point to docs
- Move tools for deploying Fleet on Kubernetes to `Deploy/` folder.
- Add @dherder as CODEOWNER so that Dave gets pinged every time a
contributor wants to make a change to the Kubernetes

---------

Co-authored-by: Dave Herder <27025660+dherder@users.noreply.github.com>
Co-authored-by: Luke Heath <luke@fleetdm.com>
2024-02-27 22:49:48 -06: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 API design: enable profiles based on labels (#15117) 2024-02-23 12:54:18 -06:00
API-Versioning.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05: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 (#14761) 2023-11-03 14:53:02 -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 document flags required for fleetd error reporting (#14656) 2023-10-19 23:49:18 -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 API design: Get email w/o relying on end user (#15445) 2024-01-10 17:29:51 -05:00
File-carving.md Improve fleetctl CLI docs page (#16877) 2024-02-23 13:14:47 -06:00
Fleet-UI-Testing.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -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
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 Update Kubernetes best practice docs (#16807) 2024-02-27 22:49:48 -06: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 Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Testing-and-local-development.md Windows MDM docs: turn on Windows MDM (#13943) 2023-10-04 15:39:09 -04:00
Troubleshooting-live-queries.md Move "Troubleshooting live queries" page to contributors docs (#16775) 2024-02-19 16:39:12 +01:00
Vulnerability-processing.md Vulnerability processing docs improvement (#15306) 2023-12-15 15:54:10 -06:00

README.md

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.