Commit graph

42 commits

Author SHA1 Message Date
Eric
3468ae4e5c
Website: move swag CTA on docs pages. (#29019)
Closes: #28949 

Changes:
- Moved the swag CTA to the right sidebar on documentation pages
2025-05-09 15:11:12 -05:00
Eric
8117631926
Website: Update CTAs (#26874)
Closes: https://github.com/fleetdm/confidential/issues/9801

Changes:
- Updated the handbook's sidebar CTA to scroll with the page
- Updated the swag CTA in the docs to scroll with the page.
- Updated the CTA at the bottom of osquery table schema pages
2025-03-05 18:14:26 -06:00
Eric
84d222d16d
Website: add navigation and search bar to documentation pages (#25795)
Closes #25655

Changes:
- Created a new component: `<docs-nav-and-search>`, a component that
displays links to documentation pages and a search bar.
- Added the `<docs-nav-and-search>` component to documentation pages,
query pages, policy pages, vitals pages, app library pages, and osquery
schema documentation pages.
- Updated the documentation template page to match the latest
wireframes.
- Updated the osquery schema documentation pages to match the latest
wireframes.

---------

Co-authored-by: Mike Thomas <[email protected]>
2025-02-03 21:13:26 +09:00
Mike McNeil
3dd2a80bcc
Add some comments and get eric started (#23666)
Co-authored-by: Eric <[email protected]>
2024-11-22 12:14:50 -06:00
Eric
1c2f4a77d0
Website: Update sidebar on article template page and scrolling sidebar functions (#23594)
Changes:
- Updated the styles and layout of the article template page sidebar to
match the latest wireframes
- Updated the scrolling function for sticky sidebars on articles and
docs pages
- Updated the sidebar CTA on article pages to check `typeof me` instead
of `me`.
2024-11-06 14:35:48 -06:00
Eric
484936144e
Website: add swag request CTA to /device-management page (#23370)
Closes: #23222


Changes:
- Added a swag request CTA to the /device-management page that is
visible to users visiting from the contiguous US




When this PR is merged, a new version of [this Zapier
automation](https://zapier.com/editor/158652809/draft/237372699) needs
to be published
2024-10-30 14:59:55 +09:00
Eric
c646d0ac51
Website: Update "On this page:" links on documentation pages. (#21580)
Changes:
- Updated how "On this page" links are generated for /docs pages.
2024-08-26 16:32:35 -05:00
Mike Thomas
2171544ad1
Docs quick reference optimization (#21331)
This PR closes https://github.com/fleetdm/fleet/issues/21108

@noahtalerman, I double-checked all redirects, and they are working.
Clicking through the URLs in [this
spreadsheet](https://docs.google.com/spreadsheets/d/1djVynIMuJK4pT5ziJW12CluVqcaoxxnCLaBO3VXfAt4/edit?usp=sharing)
is a pretty quick way to go through them all. Note that "Audit logs" and
"Understanding host vitals" redirect to the contributor docs on GitHub,
so they will throw a 404 until this is merged.

Some new guides benefitted from a name change, so they make more sense
as stand-alone guides, and also so that we don't have to mess around
with more redirects later. Those name changes followed [this
convention](https://fleetdm.com/handbook/company/communications#headings-and-titles),
which was recently documented in the handbook.

Have fun!

---------

Co-authored-by: Eric <[email protected]>
Co-authored-by: Noah Talerman <[email protected]>
2024-08-16 15:30:31 -05:00
Eric
fa529e47f9
Website: add Segment analytics (#20867)
Related to: https://github.com/fleetdm/confidential/issues/7339

Changes:
- Added a script tag for segment
- Added segment tracking for contact form submissions, signups, and swag
requests.
2024-07-31 13:26:54 -05:00
Mike McNeil
1b6fa1a8c8
Website: Update key event names (#20065)
TODO: Update the other spots and in linkedin

cc @Drew-P-drawers

---------

Co-authored-by: Eric <[email protected]>
2024-06-27 14:18:51 -05:00
Eric
19a4e07b94
Website: Add LinkedIn conversion tracking (#19921)
Related to: #19603

Changes:
- Added LinkedIn conversion tracking to the signup page, swag request
form, and contact forms.
2024-06-20 16:43:43 -05:00
Eric
bcf3052117
Website: Send analytics events (#19745)
Related to: #19603 

Changes:
- Updated the contact page to send an event (`website_contact_forms`) to
Google Analytics when a user submits the form
- Update the signup page to send an event (`website_sign_up`) to Google
Analytics when a user signs up
- Updated the swag request button in the docs to send an event
(`website_swag_request`) to Google Analytics when a user visits the swag
request typeform.
2024-06-13 17:07:14 -05:00
Eric
038526a3e9
Website: Update quote links on landing pages and frontend redirects (#19095)
Closes: #18965

Changes:
- Updated page scripts that used `window.locaiton` to use parasail's
`goto` method.
- Updated the quotes at the top of the landing pages to be wrapped in
links to give them a proper hover state.
- Updated the quote on the /vulnerability-management page to be a link
to the author's LinkedIn page.
2024-05-16 17:01:37 -05:00
Eric
2dd7b6e564
Website: add "Deploy Fleet" docs page. (#18992)
https://github.com/fleetdm/fleet/issues/16660

Changes:
- Added a new page (deploy-fleet.md) to the deploying docs
- Moved the content from the following pages to the
deploy/reference-architectures page:
  - Systemd
  - Proxies
  - Public IPs
  - Monitoring Fleet
  - Introduction
- Reordered the pages in the Deploy docs folder
- Added a redirect: `/docs/deploy/introduction »
/docs/deploy/deploy-fleet`

---------

Co-authored-by: Mike Thomas <[email protected]>
2024-05-15 13:56:36 +09:00
Eric
4a1e202acb
Website: Update contact page and CTAs (#17450)
Changes:
- Updated the contact page to have a second form that users can fill out
to schedule a Calendly meeting with Fleet.
- Updated CTAs on all landing pages, product category pages, article
pages, pricing page, and license dispenser.
- Updated the CTAs on the landing page generator template
- Removed the function that opens the hubspot chat widget from page
scripts.
- Updated `deliver-contact-form-message` to send a request to a Zapier
webhook
- Created a new action: `deliver-talk-to-us-form-submission` that sends
form submissions to a Zapier webhook.
2024-03-07 10:07:50 +09:00
Eric
0d3f992874
Website: update ordered list styles on documentation pages (#15786)
Closes: https://github.com/fleetdm/confidential/issues/4072

Changes: 
- Updated the styles for numbers on ordered lists on
docs/handbook/article pages to match the latest wireframes.
- Updated the documentation page script to set counters for numbered
steps to be the value of their `start` attribute.
2024-01-05 15:25:11 -06:00
Eric
3fe08fecba
Website: Handle scrolling to in-page links when query parameters are provided. (#15423)
Closes: #15415

Changes:
- Updated the documentation and handbook page scripts to navigate users
who visit a URL with a hash link with query parameters attached to the
correct section.
2023-12-04 14:59:26 -06:00
Eric
9c352ef5a0
Website: Bug fixes/Style updates on docs and landing pages. (#13810)
Closes: #13774
Closes: #13775
Closes: #13773
Closes: #13778

Changes:
- Updated hero text horizontal padding on landing pages.
- Updated the padding between sections on landing pages
- Fixed the background gradient on the /support page
- Updated the mobile docs navigation to show the section of the
documentation
2023-09-12 17:45:08 -05:00
Eric
d89a1b4e92
Website: Update buttons on documentation pages (#13096)
Closes: #12989

Changes:
- Increased the clickable area of the edit page button on documentation
pages.
- Updated the click event that is added to headings on documentation
pages.
2023-08-04 12:11:56 -05:00
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 <[email protected]>
Co-authored-by: Rachael Shaw <[email protected]>
2023-07-27 17:40:01 -05:00
Eric
87714f466c
Website: Upgrade to DocSearch v3 (#12563)
Changes:
- Upgraded the version of Algolia DocSearch we use on the Fleet website.
- Updated search box styles in the docs, handbook, and osquery schema
pages.
2023-07-12 09:54:05 +09:00
Eric
d050f7f1f7
Website: Update documentation scroll event handler (#12547)
Changes: 
- Updated the event handler for the sticky right-side navigation and the
"Back to the top" button on docs pages only to run if those elements
exist, and disabled the event handler on the documentation landing page.
2023-06-27 17:56:03 -05:00
Eric
3cc7c971c2
Website: Add back to top button on documentation and handbook pages (#12348)
Changes:
- Updated the handbook and documentation pages to have a "Back to top"
button that appears when a user scrolls more than 2000 pixels down the
page (on screens larger than 991px width)
2023-06-23 20:00:27 +09:00
Eric
d676118307
Website: Upgrade highlight.js dependency to improve syntax highlighting on documentation pages (#12370)
Closes: #12214

Changes:
- Upgraded the version of highlight.js we're using from `v9.10.0` to
`v10.7.3` to add support for YAML syntax highlighting.
- Updated highlight.js usage (`hljs.highlightBlock()`»
`hljs.highlightElement()`)
2023-06-16 17:07:06 +09:00
Eric
309297182a
Website: Add HubSpot chat widget and replace calendly links (#11677)
Closes: https://github.com/fleetdm/confidential/issues/2699
Changes: 
- Removed the Papercups chat widget.
- Changed the "Talk to an expert" buttons on the website to open the
HubSpot chat widget.
- Updated the Fleet Sandbox registration page to link to the MDM setup
docs.
- Changed the earliest supported versions of iOS and Safari the Fleet
website support to v11.

After this PR is merged, we will need to activate the new chat flow in
HubSpot.
2023-05-12 19:07:50 -05:00
Eric
b6fa586904
Website: Update generated subtopics in Markdown content (#10724)
https://fleetdm.slack.com/archives/C01EZVBHFHU/p1679598174642469

Changes:
- Updated the handbook and documentation pages page script to strip `'`
characters from subtopic IDs before they're converted to kebab case.
2023-03-23 15:13:51 -05:00
Eric
f970f6fb8d
Website: Remove extra dashes from markdown links (#10657)
Closes: #10458

Changes:
- Updated the generated id's for headings in Markdown content to remove
extra dashes in words that have multiple letter casings (e.g., `#my-sql`
» `#mysql`, `#git-hub-security` » `#github-security`)
- Updated links to Markdown headings that have changed.
.  ..

---------

Co-authored-by: Mike McNeil <[email protected]>
2023-03-22 19:34:59 -05:00
Eric
7190b74f2f
Website: browser compatibility updates (Edge v17, Chrome v55, Firefox v54, Opera v42, & Safari v10) (#10583)
Closes: #10496 

Changes:
- Fixed alignment issues with the <scrollable-tweets> component's page
indicator (Edge v16 & Safari 10)
- Added a hard-coded height to embedded youtube videos in Markdown
content to fix it rendering with a height of 0 (Edge v17 & Firefox v54)
- Fixed table example syntax highlighting (Edge v17, Chrome v55, Firefox
v54, Opera v42, & Safari v10)
- Added a set width to the edit page button on tables pages (Safari v10,
Firefox v54)
- Fixed a bug with the sidebar height on tables pages (Edge v17)
- Fixed styling on the pricing calculator inputs (Safari v10 & Firefox
v54)
- Fixed a layout issue with the pricing calculator call-to-action
buttons (Safari v10)
- Hid browser-specific form input buttons (Firefox v54)
- Fixed the sidebar CTA image on documentation pages (Opera v42)
- Fixed a CSS issue with the user story banner on `/platform` (Safari
v10, Firefox v54, Chrome v55, Opera v42)
- Updated the documentation page script to only copy links to the user's
clipboard if the user's browser supports it.
- Updated minimum browser versions for Edge, Chrome, and Opera for async
functions support. (Edge v16 » Edge v17, Chrome v51 » Chrome v55, Opera
v38 » Opera v42)
2023-03-17 19:36:15 -05:00
Eric
4093650599
Website: Add Fleet Premium CTA to documentation pages (#9796)
Closes: https://github.com/fleetdm/fleet/issues/9785

Changes:
- Updated the documentation page script to set a `currentDocsSection`
variable
- Added Fleet Premium calls to action that link to the `/upgrade` page
to the left sidebar on documentation pages.


cc: @jarodreyes
2023-02-10 18:37:47 -06:00
Eric
2f00e528dc
Website: Move docsearch public api key to config variable (#7771)
* move docsearch api key to a config variable, update styles to disable outline on input

* Update basic-handbook.less

* Update basic-handbook.less

* update config variable name & update comment
2022-09-21 18:13:47 -05:00
Eric
62a7d1afa2
Website: Update documentation page sidebars and calls to action. (#7388)
* Website: Make docs table of contents not sticky

* move docs sidebar CTA, update styles

* website: updated docs cta graphic

- updated docs cta graphic

Co-authored-by: Mike Thomas <[email protected]>
Co-authored-by: Mike Thomas <[email protected]>
2022-08-25 17:27:50 -05:00
Eric
b303a509fd
Update subtopics on docs and handbook pages (#7069) 2022-08-05 10:29:21 -05:00
Eric
6b1b73c59e
Website: Make all documentation navigation on fleetdm.com sticky (#5680)
* website: sticky documentation nav

* website: move documentation navigation when header is hidden

* revert whitespace changes

* lint fix

* requested changes

* Update layout.ejs

* move scroll listener to documentation page script, adjust styles

* Lint fix

* Update basic-documentation.page.js
2022-05-19 15:53:43 -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
7bb11b2bbd
Update Docsearch configuration (#3582)
* update docsearch config

* update docsearch filters
2022-01-11 10:34:38 -06:00
eashaw
b56b44b1c8
Add search to fleetdm.com/handbook (#2545)
* uncommented searchbar, live search config

* update docsearch config

* Remove second search bar, adjust layout of page to work with a single search bar

* lint fix

* Update basic-handbook.less
2021-10-19 08:44:49 +09:00
eashaw
491992c1b5
Handle scrolling to hash links when coming from an external page (#2513) 2021-10-13 17:31:25 -05:00
eashaw
834289c0c8
Copy documentation links to clipboard when a user clicks on them (#2442)
* copying header links

* copied text notification

* animation and comment update

* Update basic-documentation.less

* Update basic-documentation.page.js

* using for loop instead of lodash, updated function to remove copied class, handling double clicks, move notification

* Update basic-documentation.page.js
2021-10-07 15:27:36 -05:00
eashaw
57ba22d2b0
Add clickable anchor links in fleetdm.com/docs (#2010)
* added a default renderer for headings to keep the links consistent with the ids

* adjusted the render function to create a link for each heading

* added styles for the heading links and link icon

* changing variable names to be more specific, fixing sidebar links, hiding autogenerated <ul>s

* Removed lodash require, updated comment, removed px from icon filename, and updated link to image.
2021-09-16 17:04:26 +09:00
eashaw
f6627c4cae
Add Algolia DocSearch to fleetdm.com/docs (#1958)
* added docsearch with test config (currently breaks non docs pages)

* added docsearch.less to mixins and variables

* consolidated the search bar styles

* changed doc search layout, removed css link for doc search

* style for mobile search bar

* cleaning up indentation and tags

* added Docsearch

Note: there needs to be a matching docsearch input in the layout or docsearch will throw an error

* remove TODO

* adjusting styles to match wireframes

* moving DocSearch to documentation page script & added DocSearch to dependencies

* link fixes

* renaming customized DocSearch style sheet

* lint fixes, style tweaks, changing class names & IDs, bringing customized styles back out of dependencies

* Update index.less

* Update code-blocks.less

* Update basic-documentation.page.js
2021-09-09 13:08:35 +09: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
Mike McNeil
d50b48e7c2
Absorb yaml queries into website, + stub /queries + /documentation (#812)
* Upgrade to get rid of REPL schmutz

* rename workflow to lessen ambiguity vs. markdown compilation of docs

* ensure lockfile makes it to fleetdm.com prod

* skip force git add of package-lock to avoid confusion for now. (reverts 4e7e23990c)

* rename build script (because now it won't always be markdown source files)

* update metadata to match prev commit

* change key name in generated sailsrc for consistency

* stub query library page

* used named params so others can tell what's up with the forcing

* expand comments

* expand comments

* intermediate commit- playing with inlining the guts from doctemplater

* stub basic docpage shell and a little page to preview that on

* Compile YAML and set up query library page

* clean sailsrc

* optimize build by running everything in parallel

* Add note about the fact that we don't even need to clone anything since we've consolidated it all into one repo now.  facepalm

* un-parallelize one bit that fails in CI if it's parallelized (it'll go away soon anyway)
2021-05-20 03:22:42 -05:00