mirror of
https://github.com/empayre/fleet.git
synced 2024-11-06 08:55:24 +00:00
2a60823a93
- 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>
104 lines
7.1 KiB
Plaintext
104 lines
7.1 KiB
Plaintext
##############################################################################################
|
||
# ██████╗ ██████╗ ██████╗ ███████╗ ██████╗ ██╗ ██╗███╗ ██╗███████╗██████╗ ███████╗
|
||
# ██╔════╝██╔═══██╗██╔══██╗██╔════╝██╔═══██╗██║ ██║████╗ ██║██╔════╝██╔══██╗██╔════╝
|
||
# ██║ ██║ ██║██║ ██║█████╗ ██║ ██║██║ █╗ ██║██╔██╗ ██║█████╗ ██████╔╝███████╗
|
||
# ██║ ██║ ██║██║ ██║██╔══╝ ██║ ██║██║███╗██║██║╚██╗██║██╔══╝ ██╔══██╗╚════██║
|
||
# ╚██████╗╚██████╔╝██████╔╝███████╗╚██████╔╝╚███╔███╔╝██║ ╚████║███████╗██║ ██║███████║
|
||
# ╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚══╝╚══╝ ╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝╚══════╝
|
||
##############################################################################################
|
||
# ⛔ This file indicates REQUIRED reviewers for changes to certain file paths in this repo.
|
||
#
|
||
# > How? This "requiredness" is provided natively by GitHub. If a team is specified, then
|
||
# > the logic behaves slightly differently. See GitHub's latest documentation on CODEOWNERS
|
||
# > for more information. CODEOWNERS is especially useful for paths that usually end up
|
||
# > in PRs with lots of other reviewers.)
|
||
#
|
||
# ⚠️ For file paths not listed, the DRI is instead indicated in website/config/custom.js.
|
||
# Regardless of whether a path's DRI is configured in CODEOWNERS or custom.js, the DRI is
|
||
# automatically requested for review when changes are proposed.
|
||
# [!] But beware: No path should ever be configured as a DRI in both CODEOWNERS _and_
|
||
# the website config.
|
||
# [!] In addition, no path should ever be configured in CODEOWNERS if there is ALSO one
|
||
# of its ancestral paths configured in website/config/custom.js.
|
||
#
|
||
# ✅ Some paths also have multiple individuals who are allowed to make changes without review,
|
||
# even though they are not the DRI. These are called "maintainers".
|
||
#
|
||
# For more information on how this works, see:
|
||
# - What is a DRI and how is this configured? https://fleetdm.com/handbook/company/why-this-way#why-direct-responsibility
|
||
# - Historical context: https://github.com/fleetdm/fleet/pull/12786
|
||
##############################################################################################
|
||
|
||
|
||
##############################################################################################
|
||
# 🚀 Golang files and other files related to the core product backend.
|
||
# (1 or more Golang-literate engineers is required to review changes.)
|
||
# FUTURE: Look for a way to not have this notify every single person in this "github team".
|
||
##############################################################################################
|
||
*.go @fleetdm/go
|
||
go.sum @fleetdm/go
|
||
go.mod @fleetdm/go
|
||
/server/ @fleetdm/go
|
||
/cmd/ @fleetdm/go
|
||
|
||
##############################################################################################
|
||
# 🚀 React files and other files related to the core product frontend.
|
||
# (1 or more React-literate engineers is required to review changes.)
|
||
# FUTURE: Look for a way to not have this notify every single person in this "github team".
|
||
##############################################################################################
|
||
/frontend/ @fleetdm/frontend
|
||
|
||
##############################################################################################
|
||
# 🚀 Config as code for infrastructure, internal security and IT use cases, and more.
|
||
# (1 or more infra-literate engineers is required to review changes.)
|
||
# FUTURE: Look for a way to not have this notify every single person in this "github team".
|
||
##############################################################################################
|
||
/infrastructure/ @fleetdm/infra @edwardsb
|
||
/charts/ @fleetdm/infra @edwardsb
|
||
/terraform/ @fleetdm/infra @edwardsb
|
||
|
||
##############################################################################################
|
||
# ⚗️ Reference, config surface, built-in queries, API, and other documentation.
|
||
#
|
||
# (see website/config/custom.js for DRIs of other paths not listed here)
|
||
##############################################################################################
|
||
/docs @rachaelshaw
|
||
/docs/Using-Fleet/REST-API.md @rachaelshaw # « REST API reference documentation
|
||
/docs/Contributing/API-for-contributors.md @rachaelshaw # « Advanced / contributors-only API reference documentation
|
||
/schema @eashaw # « Data tables (osquery/fleetd schema) documentation
|
||
/docs/Deploy/kubernetes/ @dherder # « Kubernetes best practice
|
||
##############################################################################################
|
||
# 🫧 Pricing and features
|
||
#
|
||
# (see website/config/custom.js for DRIs of other paths not listed here)
|
||
##############################################################################################
|
||
/handbook/company/pricing-features-table.yml @mikermcneil # « CEO is current DRI for features table
|
||
|
||
##############################################################################################
|
||
# 🦿 Repo automation and change control settings
|
||
##############################################################################################
|
||
/CODEOWNERS @mikermcneil # See https://github.com/fleetdm/fleet/pull/13195
|
||
|
||
##############################################################################################
|
||
# 🦿 Handbook
|
||
#
|
||
# (see website/config/custom.js for DRIs of other paths not listed here)
|
||
##############################################################################################
|
||
/handbook/company @mikermcneil
|
||
/handbook/README.md @mikermcneil
|
||
/handbook/business-operations @sampfluger88
|
||
/handbook/digital-experience @sampfluger88
|
||
/handbook/customer-success @sampfluger88
|
||
/handbook/demand @sampfluger88
|
||
/handbook/engineering @sampfluger88
|
||
/handbook/sales @sampfluger88
|
||
/handbook/product-design @sampfluger88
|
||
|
||
##############################################################################################
|
||
# 🦿 GitHub issue templates
|
||
##############################################################################################
|
||
/.github/ISSUE_TEMPLATE @sampfluger88 # See https://github.com/fleetdm/fleet/pull/16203
|
||
|
||
# ℹ️ But wait, there's more!
|
||
# See the comments up top to learn where else DRIs and maintainers are configured.
|