search

fleetdm / fleet

Open-source platform for IT, security, and infrastructure teams. (Linux, macOS, Chrome, Windows, cloud, data center)
https://fleetdm.com
Other
2.93k stars 409 forks source link

Add a yaml reference document available for server configuration options #13957

Open georgekarrv opened 1 year ago

georgekarrv commented 1 year ago

Goal

As a User I want to be able to find an example of all available yaml configuration options in one document

Context

Skaffold has a very nice yaml reference page https://skaffold.dev/docs/references/yaml/ that explains each key inline so it's a one stop shop to see how to set certain values. We have a page that is disjointed and doesn't include all available options https://fleetdm.com/docs/configuration/fleet-server-configuration (also certain keys are embedded down a level and it's not clear which ones exist at what level so this example reference would make it clear where each of these values belong

Potential solutions

  1. New doc page with all supported key / value pairs documented and explained in the yaml format so it's clear at what indentation / grouping everything belongs
zhumo commented 12 months ago

Hey @mike-j-thomas I think this page George links to is an example of good documentation for yml. Could you take a look and have a think as to:

  1. What you like/dislike about it
  2. What aspects of the UI/UX we could take
  3. What content things we need
mike-j-thomas commented 11 months ago

Thanks for submitting @georgekarrv. This would require a layout change that we are unable to prioritize at the moment, so I'd like to reshape the scope of this issue to adding the content that we are missing to the docs.

Could you give me some more information about the options we are missing?