Draft osquery schema for fleetdm.com and Fleet product

[mike-j-thomas]

Related

https://github.com/fleetdm/confidential/issues/1619

Goal

100% of osquery tables advertised inside the product work correctly and intuitively, or are clearly documented with caveats explaining where their behavior is not what someone might expect. Or if they're deprecated and should not be used, or if they should not be used sometimes.

How

• From: https://osquery.io/schema which is already in a programmatically parseable format because we use it in the product in the query console

• Endgame: Probably separate pages per table -- something like this: https://fleetdm.com/tables/account_policy_data

• Steps

• Wireframe what the page looks like that shows the tables consider mobile and wireframe how you get to it, and its URL
  McNeil: Would love to hear your theory on how to send folks to this page and its URL

Vision: Over time, add additional context to make the documentation more useful. This value-add stuff likely only lives on the fleetdm.com side, for convenience / to simplify editing the website.

Example: https://sailsjs.com/documentation/reference/request-req/req-method
Versus: https://expressjs.com/en/api.html#req.method

Related

• Parent epic: https://github.com/fleetdm/confidential/issues/1646

[mike-j-thomas]

Note to self: assign this to @DominusKelvin in the release planning session for v4.14.x disregard this comment.

[mike-j-thomas]

FYI: @mikermcneil I confused your request to turn the Digital Experience part of this OKR into an issue and made this issue for your entire OKR instead.

@noahtalerman this may be useful to you because it looks like you're up first to get this moving. You might want to follow suit with what I did in the description for the Digital Experience portion of this ticket.

Alternatively, we could archive this ticket and awkwardly straighten our pants as we walk away, pretending that none of this ever happened 🤦‍♂️

[mike-j-thomas]

@noahtalerman, I created this ticket when this OKR fell under Digital Experience. Please let me know if this is of any use to you. Otherwise, I think we can just close it.

[mike-j-thomas]

@noahtalerman, edit to the above. It looks like it still is listed under Digital Experience. Before we transitioned devrel, my intention was for Kathy and Kelvin to work on this documentation. Is that still possible?

[noahtalerman]

my intention was for Kathy and Kelvin to work on this documentation. Is that still possible?

@mike-j-thomas yes, this makes sense to me. Can you please make sure that this documentation task is added as a "Product" OKR in the OKRs Google sheet? https://docs.google.com/spreadsheets/d/1tFsVzX3aqfTdtnuQfYkODdkX8nDEZQ4IHxNNOIayrE0/edit#gid=0

[noahtalerman]

@xpkoala heads up, this is a public issue tracking the same goal (first checkbox in this issue's description) as fleetdm/confidential#940.

I linked fleetdm/confidential#940 to this issue.

[mike-j-thomas]

@noahtalerman, I'm just checking in about where you are with testing osquery tables? I want to start adding them to the Fleet docs as soon as possible. Thanks.