diff --git a/handbook/engineering/README.md b/handbook/engineering/README.md index 9aa456eb60..8f73f27e11 100644 --- a/handbook/engineering/README.md +++ b/handbook/engineering/README.md @@ -417,14 +417,16 @@ When merging a pull request from a community contributor: ## Changes to tables' schema Whenever a PR is proposed for making changes to our [tables' schema](https://fleetdm.com/tables/screenlock)(e.g. to schema/tables/screenlock.yml), it also has to be reflected in our osquery_fleet_schema.json file. -It should be done by running these commands: + +The website team will [periodically](https://fleetdm.com/handbook/marketing/website-handbook#rituals) update the json file with the latest changes. If the changes should be deployed sooner, you can generate the new json file yourself by running these commands: ``` cd website ./node_modules/sails/bin/sails.js run generate-merged-schema ``` + > When adding a new table, make sure it does not already exist with the same name. If it does, consider changing the new table name or merge the two tables if it makes sense. -> If a table is added to our ChromeOS extension but it does not exist in osquery, add a note that mentions it. As in this [example](https://github.com/fleetdm/fleet/blob/e95e075e77b683167e86d50960e3dc17045e3c44/schema/tables/mdm.yml#L2). +> If a table is added to our ChromeOS extension but it does not exist in osquery or if it is a table added by fleetd, add a note that mentions it. As in this [example](https://github.com/fleetdm/fleet/blob/e95e075e77b683167e86d50960e3dc17045e3c44/schema/tables/mdm.yml#L2). ## Quality diff --git a/handbook/marketing/website-handbook.md b/handbook/marketing/website-handbook.md index 1523f11908..34fe3bcd1b 100644 --- a/handbook/marketing/website-handbook.md +++ b/handbook/marketing/website-handbook.md @@ -229,6 +229,11 @@ TODO: Document. TODO: Document. +## Rituals +| Ritual | Frequency | Description | DRI | +|:-----------------------------|:-------------------------|:----------------------------------------------------|-------------------| +| Generate latest schema | once every 3 weeks | After each sprint, generate the latest tables json file to incorporate any new schema documentation. | Eric Shaw | +