Commit Graph

81 Commits

Author SHA1 Message Date
Eric
8fb22579ea
Reorganize Fleet documentation (#12871)
Closes: #12611

Changes:
- Added three new documentation sections `/docs/get-started/`,
`/docs/configuration` and `/docs/rest api/`
- Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and
`/docs/deploying` » `/docs/deploy/`
- Moved `/docs/using-fleet/process-events.md` to `/articles` and updated
the meta tags to change it into a guide.
- Added support for a new meta tag: `navSection`. This meta tag is used
to organize pages in the sidebar navigation on fleetdm.com/docs
- Moved `docs/using-fleet/application-security.md` and
`docs/using-fleet/security-audits.md` to the security handbook.
- Moved `docs/deploying/load-testing.md` and
`docs/deploying/debugging.md` to the engineering handbook.
- Moved the following files/folders:
- `docs/using-fleet/configuration-files/` »
`docs/configuration/configuration-files/`
- `docs/deploying/configuration.md` »
`docs/configuration/fleet-server-configuration.md`
    -  `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md`
- `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md`
- Updated filenames:
- `docs/using-fleet/permissions.md` »
`docs/using-fleet/manage-access.md`
- `docs/using-fleet/adding-hosts.md` »
`docs/using-fleet/enroll-hosts.md`
    -  `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md`
- `docs/using-fleet/fleet-ctl-agent-updates.md` »
`docs/using-fleet/update-agents.md`
- `docs/using-fleet/chromeos.md` »
`docs/using-fleet/enroll-chromebooks.md`
- Updated the generated markdown in `server/fleet/gen_activity_doc.go`
and `server/service/osquery_utils/gen_queries_doc.go`
- Updated the navigation sidebar and mobile dropdown links on docs pages
to group pages by their `navSection` meta tag.
- Updated fleetdm.com/docs not to show pages in the `docs/contributing/`
folder in the sidebar navigation
- Added redirects for docs pages that have moved.

.

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-07-27 17:40:01 -05:00
Eric
22b8b2cb85
Exclude uninitialized macOS hosts in Vanta sync script (#12478)
Closes: https://github.com/fleetdm/fleet/issues/12450

Changes:
- Updated the `send-data-to-vanta` script to exclude hosts that have an
`mdm.enrollment_status` set to `Pending`
2023-06-23 18:17:18 -05:00
Eric
e9fd28717d
Website: Throw error in build script if a handbook page is missing a maintainedBy meta tag (#12364)
Closes: #12361
Changes:
- Added an error to the `build-static-content` script that is thrown if
a a handbook page is missing a `maintainedBy` meta tag.
- Added a `maintainedBy` meta tag to
`handbook/company/head-of-public-sector.md`
2023-06-16 15:09:17 -05:00
Eric
0d54d242ff
Website: Update regex used to change markdown links (#12325)
Closes: #12315
Changes:
- Updated the regex that is used to change Markdown links to fleetdm.com
into web root-relative links to support fleetdm.com links that start
with `www.`
2023-06-16 13:27:59 -05:00
Luke Heath
e4c38dfb7c
Exclude handbook and ceo labels from contributor PR count (#12226) 2023-06-09 10:55:12 -05:00
Eric
ac8cd8e024
Website: Throw error if Markdown content contains a Vue template (#12096)
Changes:
- Updated the build-static-content script to throw an error if a
Markdown file contains a vue template (e.g., `{{ foo }}`)
- Updated an example in the "Using Fleet" FAQ to use single curly
brackets (`{{host}} ` » `{host}`)


Context: https://github.com/fleetdm/fleet/pull/12088
2023-06-01 14:06:02 -05:00
Eric
d18db8f9ee
Website: Add support for ChromeOS to query library and osquery schema pages. (#12013)
Closes https://github.com/fleetdm/fleet/issues/11837

Changes:
- Changed the OS icons used on tables/ and queries/ pages.
- updated `get-extended-osquery-schema` to change the `platform` value
of osquery table columns to be the normalized platform name (`chromeos`
» `ChromeOS`)
- updated `build-static-content` to support three `platforms` values
when adding platform compatibility notes to generated Markdown tables
(e.g., "**Only available on macOS, Linux, and Windows.**" )
- Added dropdown options and icons for ChromeOS on osquery schema table
pages, query details pages, and the query library.
2023-05-31 11:48:00 -05:00
Eric
02bb987b22
Website: Update pricing page (#11910)
Changes:
- Updated the pricing page to match the latest wireframes.
- Updated the features in `pricing-features-table.yml`
- Updated `build-static-content.js` to remove support for the Ultimate
tier in `pricing-features-table.yml`

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
2023-05-25 12:40:19 +09:00
Luke Heath
5779bd2381
Update GitHub PR and bugs KPI script (#11680) 2023-05-12 17:08:00 -05:00
Eric
c7244add59
Website: Retry failed PUT requests to Vanta (#11023)
Changes:
- Chained a `.retry()` onto the PUT requests to Vanta in the
`send-data-to-vanta` script
.
2023-04-07 10:28:58 -05:00
Eric
243e0bc6f1
Update send-data-to-vanta script (#10384)
Changes:
- Updated the send-data-to-vanta to set a boolean value for the
`isManaged` property of Windows and macOS hosts if the
`enrollment_status` of a host's `mdm` property is either "On (automatic)
or "On (manual)".
2023-03-08 12:06:16 -06:00
Eric
403b067056
Update Vanta integration to sync Windows hosts (#10346)
Closes: #9735

Changes:
- Updated the `send-data-to-vanta` script to:
   - Sync Windows hosts with Vanta.
   - Report the MDM status of macOS hosts.
- Updated the notes on the `/connect-vanta` page to link to the screen
lock policy for Windows.
2023-03-08 09:45:53 -06:00
Mike McNeil
8466671cef
Exclude draft PRs from KPIs (#10327)
@eashaw DEF check this code, please. I didn't test it at all and wrote
it during a meeting and lots of interruptions.
2023-03-06 15:57:53 -06:00
Eric
295208a77b
Website: Remove newlines from osquery schema table column decsriptions. (#10002)
Closes: #9963 

Changes:
- Updated`build-static-content` script to replace newlines in the
`description` property of osquery schema columns. This prevents
multi-line descriptions from adding additional rows when a multi-line
description is added to a Markdown table.
2023-02-21 20:20:08 -06:00
Zach Wasserman
2c66547b72
Give Vanta empty drives array when we don't know about encryption (#9918)
Vanta doesn't like undefined/null values for the encryption status.
Hopefully it will accept an empty array.
2023-02-17 14:40:30 -06:00
Zach Wasserman
c99d7677e7
Skip setting details for pending enrollment MDM hosts (#9911) 2023-02-17 10:56:08 -08:00
Eric
753d200e45
Website: Update Vanta integration script error logging (#9910)
Changes:
- Changed the message logged when a Vanta integration has an error to a
warning so our Papertrail alerts will be triggered whenever a Vanta
integration has an error.
2023-02-17 12:28:17 -06:00
Zach Wasserman
e4141e68b0
Support hosts with no software in Vanta integration (#9909) 2023-02-17 10:06:31 -08:00
Zach Wasserman
7cb51d7ba2
Change reporting of MFA to Vanta for API-only users (#9896)
The intention is to have Vanta stop showing warnings for missing MFA on
API-only users. It's not clear if setting `UNSUPPORTED` is the correct
solution, but it does seem more accurate than setting the `mfaEnabled`
to `true`.
2023-02-17 08:49:20 -08:00
Eric
416963de36
Website: Update pricing page (#9621)
Closes https://github.com/fleetdm/confidential/issues/1818

Changes:
- Updated the layout and content of the `/pricing` page
- `pricing-features-table.yml`: Added an "Ultimate" tier with three
features.
- `build-static-content.js` - Updated the build script to add support
for the "Ultimate" tier in `pricing-features-table.yml`

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
2023-02-06 10:41:36 -06:00
Eric
09b88d0341
Website: Add "Requires MDM" badge to /queries page (#9296)
Changes:
- Added a "MDM required" tag to the queries in the standard query
library that use the `managed_policies` table.
- Updated the build script to add a `requiresMdm` value to queries added
to `builtStaticContent.queries`, and to set it to true if a query has
the "MDM required" tags
- Updated the `/queries` page to add a "Requires MDM" badge to queries
that have `requiresMdm: true`
 . . .

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-01-12 10:05:03 -06:00
Eric
47d43d5307
Website: fix failing GitHub workflows (#9285)
Changes:
- Updated the `build-static-content` script to use a GitHub API token
for requests if one is provided e.g., `sails run build-static-content
--githubAccessToken="foo"`
- Updated the `build-for-prod` npm script to run the
`build-static-content` script with a variable named `BUILD_SCRIPT_ARGS`.
- Updated the "Deploy Fleet website" and "Test Fleet website" workflows
to run the `build-for-prod` script with a GitHub API token
. .

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-01-11 13:31:20 -06:00
Eric
9ddd5f2ede
Website: Add MDM page (#9264)
Changes:
- Added a new page: `/device-management`
- Added a new action: `deliver-mdm-beta-signup.js` - This action sends a
post request to a Zapier webhook when a user submits a form on the
`/device-managment` page.
- Added a new component: `<scrollable-tweets>`
- Updated routes, importer, policies, cloud-sdk, and
`download-sitemap.js`
- Updated the route for our success story articles to live at
`fleetdm.com/success-stories/*` (Previously at
`fleetdm.com/device-management/*`) and updated `config/routes.js` to
have redirects for each article in that category
- Updated the "Use cases" navigation item to "Platform" and changed the
platform link to "How it works"

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-01-11 11:29:38 -06:00
Eric
ace1fa0d37
Website: Add Vanta integration (#9072)
* stubing out required pages

* Add Vanta authorization action, create externalAuthorization(name will most likely change) Model

* rebuild cloud sdk

* Draft script

* update importer, update connect-vanta page

* layout updates

* update action

* change model name

* update model name

* update script

* Update vanta callback page

* add new model to lint config

* update model attributes

* update vanta connection page to require url protocol, fix lint error in routes

* rename page, vanta-callback » vanta-authorization

* Update errors, handle incomplete connections

* Update model attribute names

* Remove console.log(), add error message for non-Fleet Premium users

* update importer, fix lint error

* update send-data-to-vanta script

* Update create-vanta-authorization-request.js

* update page name

* update comments and error messages

* layout changes

* update status codes used in exits

* Add comment

* Update .eslintrc

* Update create-vanta-authorization-request.js

* Update view-vanta-authorization.js

* Update VantaConnection.js

* Update send-data-to-vanta.js

* Update create-vanta-authorization-request.js

* Update mobile styles

* update text

* update error text, show sucess message if account has already been authorized

* lint fix

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-12-21 23:39:39 -06:00
Eric
b8c2db08c9
Website: Update build script to throw an error if Markdown contains a @fleetdm.com email address (#9027) 2022-12-15 17:59:24 -06:00
Zach Wasserman
fce4bae018
Fix typos in website code (#9015) 2022-12-13 15:33:23 -08:00
Eric
a8fe6b4bec
Update bug and pull request report script (#8735)
* Update PR and Bug script

* Update get-bug-and-pr-report.js

* Update get-bug-and-pr-report.js

* update variable names

* update script to pull the last 300 closed pull requests

* Add open PR metric

* Update get-bug-and-pr-report.js

* Update get-bug-and-pr-report.js

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-12-05 17:01:03 -06:00
Eric
2d0f33f369
Website: Add script for creating HTML email partials from Markdown articles (#7574)
* add to-html-email

* email-preview

* add build-html-email script, update .gitignore

* email preview and email-templates pages, update routes, importer and policies

* add newsletter email layout, build-html-email script, to-html-email updates

* Update .gitignore

* add newsletter emails section to growth handbook

* update scripts

* update fonts in emails

* Update README.md

* Update build-html-email.js

* update comments, add page scripts to layouts

* revert change to build-static-content

* update script

* update email layout and helper

* update handbook entry

* update template data and helper

* update email layout

* update fake data and unsubscribe link

* move added handbook section to the marketing handbook

* rename script

* update colors in unused email template

* update capitalization in helper

* view-email-preview » view-email-template-preview

* Hide emails generated from markdown if they don't exist

* update preview page

* update markdown email directory, create sample article email

* lint fixes, add target="_blank" to links in emails

* update page layouts & styles

* update sample newsletter email, code font, newsletter layout

* Update README.md

* Update view-email-template-preview.js

Co-authored-by: Tim Kern <tim@fleetdm.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-12-05 16:30:24 -06:00
Eric
d92d9980ce
Website: Build pricing page from yaml file (#8549)
* Create pricing-features-table.yml

* update built-static-content to add the pricing table configuration to builtStaticContent

* Update pricing page to use builtStaticContent.pricingTable

* Update view-pricing.js

* update pricing table, lint fix

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-12-05 14:11:46 -06:00
Eric
0853d338f8
Website: Update table pages (#8410)
* add link to "defaults to root" text and evented table labels

* override requires_user_context value in merged schema

* update link styles on table pages

* Update get-extended-osquery-schema.js

* encodeURIComponent

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-11-10 17:12:24 -06:00
Eric
f5da19ced5
Website: add script to get average open bug and pull request age (#8490)
* Create script

* update base headers

* Update get-average-bug-and-pr-age.js

* add timeout to sails.helpers.flow.until
2022-10-31 23:10:30 -05:00
Eric
e82962e4a7
Add Fleet override schema files (#8278)
* create schema/tables, add yaml schema tables

* Update osquery-table-details.ejs

* Generate schema from schema/tables/ folder

* Create generate-yaml-tables-from-json.js

* update created table files

* update fleet override validation

* update error messages, add fleetRepoUrl

* Delete generate-yaml-tables-from-json.js

* Update osquery-table-details.ejs

* Update whitespace in table examples

* Revert "Update osquery-table-details.ejs"

This reverts commit 2e9d63208f59997d492375ebaf1d0ec7e4afe468.

* add YAML tables generated from updated Fleet schema

* lint fixes

* update arp_cache and docker_containers tables
2022-10-18 14:13:42 -05:00
Eric
588c9abef3
modify markdown links on table pages (#8123) 2022-10-07 11:48:37 -05:00
Eric
8fecef3ed5
Update merged schema helper and script. (#8092)
* update helper to use the osquery schema from the osquery/osquery-site repo

* update script description and generated json filename

* Add ritual to digital experience handbook

* add merged schema

* Update README.md

* Update get-extended-osquery-schema.js
2022-10-05 15:10:08 -05:00
Eric
cf7ee367d4
Remove custom heading renderer when compiling markdown tables (#8054)
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-09-30 18:03:52 -05:00
Eric
ddb074996c
Website: Move schema table merging into helper, update build script (#7980)
* move table schema merging into helper

* update helper name, add evented value to table configuration

* update indentation

* update error messages for readability

* typo

* update helper name, exits and description

* Add missing columns to osquery_tables.json

* add merge schema script

* rename script to `generate-merged-schema`

* Update generate-merged-schema.js

* Add error messages

* update error messages

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-09-29 16:38:10 -05:00
Eric
9dbf84fb4b
Website: Add pages for schema tables (#7679)
* add osquery tables page

* update build script, add fleet schema folder

* update layout and page script

* add edit-page button, search, remove test attribute from fleet schema

* update styles

* syntax highlighting, update highlight.js, adjust layout

* lint fixes

* Update view-osquery-tables.js

* requested changes from 1:1

* requested changes

- Rename osquery-tables to osquery-table-details & update routes and policies
- Update wildcard input and tables details route
- Fix lint error
- adjust self-calling functions in page script
- rename function and adjust the order of functions in page script

* add osquery tables to builtStaticContent.markdownPages

* update schema folder readme

* add redirect for /tables

* update table input

* remove comment from stylesheet, update syntax highlighting, use variable names from colors.less

* update inputs in view action

* Updates from PR review

* fix lint error

* update syntax highlighting, table page styles

* Update build-static-content.js

* requested changes from code review

* Update build-static-content.js

* fix build script error

* remove string.replaceAll()

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-09-23 19:06:55 -05:00
Eric
9eb518bd4d
Website: Add metadata error to build-static-content (#7776)
* add error message to metadata processing

* Update error message

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-09-23 18:23:37 -05:00
Eric
a5d2d7e390
Website: add support for description meta tags in markdown articles (#7887)
* add support for meta description tags on markdown articles

* Add description meta tag section to article formatting guide
2022-09-21 17:14:58 -05:00
Eric
a15d87f932
Add --skipGithubRequests option to build-static-content (#7024)
* add local flag to build script

* remove defaultsTo from input

* update comments

* local » skipGithubRequests, use fake profile pictures for contributors

* encodeURIComponent(username)
2022-08-03 10:45:28 -05:00
Eric
780a00d849
update invalid custom title error (#7021) 2022-08-02 14:27:31 -05:00
Eric
9e2b7c5f26
Website: Minor scripts/build-static-content.js updates (#6974)
* Build static content updates

* update comment

* Add link

* Expand comment with another link and more explicitness

* Address requested change from https://github.com/fleetdm/fleet/pull/6974/files#r935075522

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-08-01 22:23:43 -05:00
Eric
46aa36356b
Website: Update LANG markers regex in build-static-content.js (#6785)
* Update LANG markers regex

* update regex to remove extra newlines from codeblocks

* revert regex in build-static-content

* remove nested codeblock

* update whitespace in changed codeblock

* update regex replace to match indentation on LANG tags

* update regex, add error if markdown was compiled with nested codeblocks

* Revert lang marker regex

* remove newlines before codeblocks in lists

* Update error, move LANG tag regex replace

* update comment to clarify what we mean by nested codeblocks

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-07-27 16:55:06 -05:00
Mike McNeil
39fea292b9
Tool: Bring back mergefreeze API integration (#6905)
* Tool: Bring back mergefreeze API integration

Context: https://github.com/fleetdm/fleet/pull/5628#issuecomment-1196175485

Unfortunately, the API doesn't work.

* Lay out how this would work in the database - but instead, do it ephemerally for now

* Remove model

* Maintain state (the easy way for now)
2022-07-27 00:36:31 -05:00
Eric
f10e33d387
Website: update article categories (#6679)
* add deploy category, change product to guides

* update links to deployment guides

* Update deploy-fleet-on-hetzner-cloud.md

* Update enrolling-a-digital-ocean-droplet-on-a-fleet-instance.md

* Update how-to-install-osquery-and-enroll-linux-devices-into-fleet.md

* Update delivering-data-to-snowflake-from-fleet-and-osquery.md

* Update how-to-install-osquery-and-enroll-windows-devices-into-fleet.md

* Update how-to-install-osquery-and-enroll-macos-devices-into-fleet.md

* Update deploying-fleet-on-aws-with-terraform.md

* Update deploying-fleet-on-render.md

* Update how-to-uninstall-osquery.md

* Update osquery-a-tool-to-easily-ask-questions-about-operating-systems.md

* Update get-and-stay-compliant-across-your-devices-with-fleet.md

* Update work-may-be-watching-but-it-might-not-be-as-bad-as-you-think.md

* Update converting-unix-timestamps-with-osquery.md

* Update correlate-network-connections-with-community-id-in-osquery.md

* Update using-elasticsearch-and-kibana-to-visualize-osquery-performance.md

* Update fleet-quick-tips-querying-procdump-eula-has-been-accepted.md

* Update locate-assets-with-osquery.md

* Update osquery-consider-joining-against-the-users-table.md

* Update import-and-export-queries-and-packs-in-fleet.md

* Update ebpf-the-future-of-osquery-on-linux.md

* Update generate-process-trees-with-osquery.md

* Update get-and-stay-compliant-across-your-devices-with-fleet.md

* Update work-may-be-watching-but-it-might-not-be-as-bad-as-you-think.md

* Update ebpf-the-future-of-osquery-on-linux.md

* Change category meta value back to guides

Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>

* change article category

* update latest article category

* add redirects for articles not handled by cloudflare rules

* Update to main nav

I did a little more housekeeping on the main nav for when we do the switch on these categories.

- Added link to /deploy under Guides on the Documentation dropdown.
- Added link to /guides under Guides on the Documentation dropdown
- Removed the now redundant "See all" from under Guides on the Documentation dropdown
- Removed the now redundant "See all" from under Articles on the Community dropdown (There's no need to point users to All categories any more, since all the category land are now linked to independently from the main nav.

* Update article category name

Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
2022-07-21 13:59:51 +09:00
Mike Thomas
7aaf677c66
state of device management blog post (#6192)
* state of device management blog post

- Article to help promote the report
- Needed before merge: "Reports" article category

* add report category and update routes

* Update state-of-device-management.md

I reworded part of this to make it easier to read. Let me know if I can be of any more help. :)

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
Co-authored-by: Tim Kern <tim@fleetdm.com>
2022-07-07 17:37:43 +00:00
Eric
1c51eadc1e
Website: Fix build script (#6320)
Fixing a error caused by e94e41a9f9
2022-06-21 15:35:13 -05:00
Eric
7694937793
Website: update build script (#6271)
* Website: update build script

* update .replace() to use HTML entities
2022-06-21 14:36:03 -05:00
Eric
73db2ae15e
Website: add <call-to-action> component (#6244)
* Website: add <call-to-action> component

* Lint fixes
2022-06-21 09:08:35 +09:00
Eric
9965da174c
Website: add .retry() to Github API calls in estimation report script (#6132)
* website: add retry() to Github api calls in estimation script

* Update deliver-estimation-report.js
2022-06-09 00:08:13 -05:00