Commit graph

54 commits

Author SHA1 Message Date
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
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 <[email protected]>
2023-05-25 12:40:19 +09: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
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
Co-authored-by: Mike McNeil <[email protected]>
2023-01-11 11:29:38 -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
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 <[email protected]>
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 <[email protected]>
2022-11-10 17:12:24 -06: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 2e9d63208f.

* 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
cf7ee367d4
Remove custom heading renderer when compiling markdown tables (#8054)
Co-authored-by: Mike McNeil <[email protected]>
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 <[email protected]>
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 <[email protected]>
Co-authored-by: Mike McNeil <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
2022-07-27 16:55:06 -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 <[email protected]>

* 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 <[email protected]>
Co-authored-by: Mike Thomas <[email protected]>
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 <[email protected]>
Co-authored-by: Desmi-Dizney <[email protected]>
Co-authored-by: Tim Kern <[email protected]>
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
Mike Thomas
8b3a3e2eca
Create the-future-of-device-management-ep1.md (#6050)
* Create the-future-of-device-management-ep1.md

Missing from this PR:

- [ ] Set up podcast article category
- [ ] Link to podcast
- [ ] Podcast cover artwork
- [ ] Nice to have: subheading style

* PR update

- added podcasts category
- changed added article `category` to "podcasts"
- removed placeholder `articleImageUrl`

* PR update

– added Apple, Spotify, and PodBean podcast links
- added article artwork

Co-authored-by: eashaw <[email protected]>
2022-06-07 10:21:56 +09:00
Eric
592d277a07
Website: generated handbook index (#5955)
* Website: generated index planning

* revert whitespace change

* add title to handbook pages, generate handbook index

* Update basic-handbook.page.js

* suggestions from review

Co-authored-by: Mike McNeil <[email protected]>
2022-06-02 18:09:00 -05:00
Eric
0d3cae7d80
Website: fix external article images (#5720) 2022-05-12 17:21:53 -05:00
Eric
fba695be86
Website: Update build script to support relative image links (#5674)
* website: modify image links to point to assets folder

* website: update links to article images

* update comments

* revert sailsrc change

* Update build-static-content.js

* suggested changes from review
2022-05-12 10:21:44 -05:00
Eric
cd046bf2fc
Website: Update default filters for query library, remove tag capitalization (#5523)
* update tag formatting + query library default filters

* make all tags lower case
2022-05-03 19:39:56 -05:00
Eric
f713668390
Website: Add article landing and category pages (#5428)
* articles page

* update articles route to handle category urls

* update articles page

* add articleImageUrl meta tags to article pages

* basic empty state, add comments

* Update view-articles.js

* Update articles.less

* add articles, update styles and image url validation

* lint fix

* Update routes.js

* Update articles.ejs

* Update articles.page.js

Updated article category descriptions.

* migrated more articles

I migrated more articles so that all categories are populated.

* Added thumbnails to new posts

* Some style tweaks

- Tweaked a couple of styles
- Added cursor: pointer to filters
- Changed "Blog" to "Articles" in the navigation
- Changed /blog to /articles in the navigation

Co-authored-by: Mike Thomas <[email protected]>
2022-04-28 15:16:07 +09:00
Eric
cd0ec13a0c
Website add articles page. (#5243)
* create '/articles' and add 4 test articles

* update build-static-content script for '/articles'

* article pages

* Validate article page metaData

* add articles linked from header, remove test articles

* update article styles

* comment out /articles route, update blog post links

* Move article category page to different branch for future PR

* Update build-static-content.js

* remove pagescript

* Update deploying-fleet-on-render.md

* update meta tags

* lint fixes

* Style & Markdown updates

Made a couple of fixes to the styling and markdown.

* update view action, replace route with regex, update links

* authorsGitHubUserName -> authorGitHubUsername, authorsFullName -> authorFullName

Co-authored-by: Mike Thomas <[email protected]>
2022-04-22 12:27:03 -05:00
eashaw
0af5e161d0
Remove numbers from documentation filenames in Fleet repo (#4313)
* Renaming files and a lot of find and replace

* pageRank meta tags, sorting by page rank

* reranking

* removing numbers

* revert changing links that are locked to a commit

* update metatag name, uncomment github contributers

* Update basic-documentation.page.js

* revert link change

* more explicit errors, change pageOrderInSection numbers, updated sort

* Update build-static-content.js

* update comment

* update handbook link

* handbook entry

* update sort

* update changelog doc links to use fleetdm.com

* move standard query library back to old location, update links/references to location

* revert unintentional link changes

* Update handbook/community.md

Co-authored-by: Mike Thomas <[email protected]>

Co-authored-by: Mike Thomas <[email protected]>
Co-authored-by: Mike McNeil <[email protected]>
2022-02-23 12:17:55 -06:00
eashaw
243306de02
Add tags to standard query library and fleetdm.com/queries (#3970)
* handle query tags in build-static-content script, update query readme

* show tags in query library, add ability to filter by tags

* fix lint errors

* update mobile styles

* fix CTA link

* update mobile layout

* remove tag line-height and font size

* Update build-static-content.js

* Style update

* remove margin from selected tag, adjust OS logo placement

* requested changes from code review

Co-authored-by: Mike Thomas <[email protected]>
2022-02-03 15:49:36 -06:00
Noah Talerman
7dafc5ab66
Add policies to standard query library (#3848)
- Add 3 policies to `standard-query-library.yml` and update standard policy templates in the Fleet UI
2022-01-25 15:00:31 -05:00
eashaw
0cca889dd3
Add policies to the standard query library on fleetdm.com (#2939)
* setting query purpose using kind

* updated query library sort

* change query purpose section, add resolution section

* Update query-library.ejs

* remove policies from standard query library, updated commented out policy resolution checks

* Update query-library.page.js
2021-11-19 10:51:02 -06:00
eashaw
ba251d22d8
Remove html comments from code blocks on fleetdm.com/docs (#2899)
* Update build-static-content.js

* Update build-static-content.js

* update comment
2021-11-12 17:38:55 +09:00
Luke Heath
99673eb148
Fix broken links to docs (#2561) 2021-10-22 12:39:20 -05:00
eashaw
4d0b19d8fb
Fix broken links and duplicate IDs on fleetdm.com/docs (#2426)
* update heading renderer, fix links to blog.fleetdm.com

* inverted conditional, using ensureUniq
2021-10-07 12:20:41 -05:00
eashaw
0ea4972920
Implement /handbook on fleetdm.com (#2230)
* uncomment handbook route, disable redirect, add link to top nav

* Handbook page, note: most of this is directly copied from the docs, build handbook

* added maintainer <meta> tags

* handbook styles

* handbook broken up into different files

* update handbook layout

* updating markdown files

* handbook layout, adjusted header margins to make room for handbook

* handling links to specific sections in markdown compilation

* lint fixes

* commented out search bar for now

* cleaned up page script

* update handbook and clean up styles

* Delete handbook.md

* updated product content from latest version

* clean up styles, remove hardcoded image widths

* markdown updates

* title and description for /handbook, removed commented out route

* fix styles on firefox, remove commented logs

* lint fix

* update class name

* fix broken link

* updated how hashes are handled in links, adjusted links in handbook

* lint fix

* updated function names, removed comments, small markdown syntax fix

* move handbook link into footer
2021-09-27 20:16:49 -05:00
eashaw
c1a795cff8
Fix broken link in markdown compilation (#2162)
* handle links to fleetdm.com

* Update build-static-content.js

* Update build-static-content.js

* update comment
2021-09-21 13:52:37 -05:00
eashaw
e115358a51
Fix failing build script (#2147)
* update path to query library

* throw error if there is no YAML file
2021-09-20 15:42:54 -05:00
eashaw
208c627666
Link to documentation on github from fleetdm.com/docs (#2041)
* added a pathInDocsFolder attribute to the markdown pages

* updated call to action, and changed the link to the markdown file in the fleet repo

* update comment

* update comment and variable name
2021-09-17 08:07:18 +09:00
gillespi314
8edbab0651
Hide remediation field for query detail pages on website (#2051)
Co-authored-by: Mike McNeil <[email protected]>
2021-09-14 12:55:45 -05:00
Mike McNeil
029f67d36b
remove concept of "Detection", for now (in favor of what's coming) (#2046)
* remove concept of "Detection", for now (in favor of what's coming)

* remove extra --- to make YAML parse properly

* Simplify the check to remove remediation check for now

* Run compile script any time docs or handbook is changed
2021-09-14 11:43:45 -05:00
Mike McNeil
8097251565
Put live documentation on fleetdm.com (#1380)
* minor clarifications

* further expand comments and stubs

* absorb custom titles embedded in metadata, plus further comment expansion and a followup fix for something i left hanging in f8cbc14829

* Skip non-markdown files and use real path maths

* Prep for running in parallel (Remove `continue` so this isn't dependent on the `for` loop)

* determine + track unique HTML output paths

* Compile markdown + spit out real HTML  (without involving any but the crunchy nougaty dependency from the very center of everything)

* add md metadata parsing

* add timestamp

* Update build-static-content.js

* attach misc metadata as "other"

* how doc images might should work (this also aligns with how the select few images in the sailsjs.com docs work)

* add file extension to generated HTML files

* "options"=>"meta"

* Make "htmlId" useful for alphabetically sorting pages within their bottom-level section

See recent comments on https://github.com/fleetdm/fleet/issues/706 for more information.

* list out the most important, specific build-time transformations

* Omit ordering prefixes like "1-" from expected content page URLs

* add a little zone for consolidating backwards compatible permalinks

* interpret README.md files by mapping their URLs to match their containing folder

* clarify plan for images

* decrease probability of collisions

* Make capitalization smarter using known acronyms, proper nouns, and a smarter numeric word trim

* Resolve app path in case pwd is different in prod

* Delete HTML output from previous runs, if any

* condense the stuff about github emojis

* got rid of "permalink" thing, since id gets automatically attached during markdown compilation anyway

Also "permalink" isn't even a good name for what this is.  See https://github.com/fleetdm/fleet/issues/706#issuecomment-884693931

* …and that eliminates the need for the cheerio dep!

* Bring in bubbles+syntax highlighting into build script, and remove sails.helpers.compileMarkdownContent()  -- this leaves link munging as a todo though

* trivial (condense comments)

* Remove unused code from toHtml() helper

* Implemented target="_blank" and root-relative-ification

* remove todo about emojis after testing and verifying it works just fine

* trivial: add link to comment in case github emojis matter at some point

* consolidate "what ifs" in comments

* Leave this up to Sarah, for now. (Either bring it back here in the build script or do it all on the frontend)

* Enable /docs and /handbook routes, and add example of a redirect for a legacy/deprecated URL

* implement routing

* Upgrade deps

this takes advantages of the latest work from @eashaw, @rachaelshaw, and the rest of the Sails community

* tweak var names and comments

* make readme pages use their folder names to determine their default (fallback) titles

as discussed in https://github.com/fleetdm/fleet/issues/706#issuecomment-884788002

* first (good enough for now) pass at link rewriting

as discussed in https://github.com/fleetdm/fleet/issues/706#issuecomment-884742072

* Adapt docs pages to build from markdown output

* Continue work on docs pages

* Add landing page

* Remove unused code; minor changes

* Replace regex

* fixes https://github.com/fleetdm/fleet/pull/1380#issuecomment-891429581

* Don't rely on "path" being a global var

* Syle fleetdm doc pages

* Continue work on docs pages

* Fix linting error

* Disable lesshint style warnings

* parasails-has-no-page-script attribute

Added a parasails-has-no-page-script attribute to the docs template, added a check for that attribute in parasails.js and removed the empty page script for 498

* bring in latest parasails dep

* trivial

* Update links to dedupe and not open in new tab unless actually external

* Disable handbook for now til styles are ready

* fix CTA links

* trivial

* make sitemap.xml get served in prod

* hide search boxes for now, remove hard-coded version and make releases open in new tab

* clean out unused files

Co-authored-by: gillespi314 <[email protected]>
Co-authored-by: eashaw <[email protected]>
2021-08-17 19:55:13 -05:00