Commit Graph

52 Commits

Author SHA1 Message Date
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
14ac341b30
Normalize docs and handbook headings (#2428)
* header styles

* update headers

* updated headings

* update padding

* handbook headings, update landing page breadcrumbs

* update heading and font-size

* Update 03-Example-deployment-scenarios.md

* handbook styles

* Update basic-handbook.page.js

* lint fixes
2021-10-07 23:40:22 +09:00
eashaw
ac45bc0706
Docs image updates (#2297)
* addred cropped images to replace images in configuration.md, fixed duplicated alt text, added box-shadow to images

* more cropping

* reduce padding on ordered lists, point urls in markdown to where images will be

* Update 02-Configuration.md

* Update build-static-content.js

* remove box-shadow on images

* Update 02-Configuration.md

* Added handbook entry about images

* changed img tags to markdown links to be consistent

* undo small style change

* Update build-static-content.js

* Update handbook/product.md

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-10-05 08:25:34 +09:00
eashaw
b21a7dbcf2
Update media queries on fleetdm.com/docs and /handbook (#2343)
* increase get started masthead nav margin

* update docs and handbook media queries
2021-10-04 11:53:48 -05:00
Mike Thomas
167053d57c
Handbook style fix (#2253)
Reduced handbook template width to bring inline with the width in Figma. (The extra 200px forces the text content a little too wide, introducing reading fatigue.)

Reverted paragraph font size back to default 16px, and also removed the bootstrap override to avoid duplicate declarations.

Thank you @eashaw for humoring me with the font-size change. I realise now that it's not the size, but the actual font that is the issue. Looks like there is a discrepancy between how Figma and the browser are rendering Nunito (specifically the curly tails on the 'l'). I will track this separately for later.
2021-09-29 12:34:16 +09:00
eashaw
b1f92e1009
Update mobile documentation styles and call to action (#2250)
* mobile styles for edit page button, display bottom of page CTA on mobile, fix link tags

* adjust button position, lint fix

* updated css to use [purpose=''] instead of class names and removed unneeded classes
2021-09-28 12:33:47 +09: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
6413befdd1
Add edit page button to the top of documentation pages on fleetdm.com/docs (#2165)
* floating edit button on hover

* update class name

* adjust padding and border-radius

* fix failing lint test

* Update website/assets/styles/pages/docs/basic-documentation.less

* Update website/assets/styles/pages/docs/basic-documentation.less

* Update website/assets/styles/pages/docs/basic-documentation.less

* Update website/assets/styles/pages/docs/basic-documentation.less

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-09-22 14:05:53 +09:00
eashaw
accfa22189
updated styles, class names, and renderer (#2169) 2021-09-21 16:17:45 -05:00
eashaw
470889ba3a
Update code blocks in documentation (#2151)
* updated css to be compatible with Chrome 87 and earlier

* fixed JSON syntax code blocks, remove empty response data

* Update code-blocks.less

* fix broken links
2021-09-20 20:59:45 -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
ca9cb48ae4
Add more padding to the docs at <990px width (#1982)
* remove padding class from container

* styles for >576px and 576px - 990px

* mobile styles, rearranged stylesheet to go from larger sizes to smaller sizes

* fix padding on breadcrumbs-and-search

* Update homepage.ejs
2021-09-10 15:31:03 -05:00
eashaw
0294ec0f25
Add fleetdm.com/press-kit (#1981)
* created /press-kit page and updated routes and policies

* updated styles, placeholder-images

* created assets/images/press-kit/ and moved all relevant files

* changed filenames for logo previews

* cleaning up html, adjusting mobile styles

* removed empty <divs>, lint fix in stylesheet

* Added link to /press-kit in page footer

* Update layout.ejs
2021-09-10 06:56:29 +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
eashaw
13cae833c0
Change code block headings in documentation (#1943)
* updated headings to remove codeblocks

* Update 3-REST-API.md

* Update 2-Configuration.md

* h5 styles

* h6 styles, removed h5 font-size
2021-09-08 03:55:55 +09:00
eashaw
2c8b65dcd7
Update Get Started Page (#1914)
* Added Log into fleet step and info icon

* adjust padding
2021-09-03 13:00:04 +09:00
eashaw
9fc16e1e44
Documentation style changes (#1897)
* added color from figma

* table styles, adjusting padding and margin on headings, removing indentation on left nav

* <code> styles, adjusted padding on code blocks to match figma
2021-09-02 12:25:22 +09:00
gillespi314
194ad5963b
Fleetdm.com: Fix browser compatibility issues (#1849)
* Fix browser compatibility issues

* Improve browser compatibility for fleetdm.com
2021-08-30 16:31:53 +09:00
gillespi314
feba649db5
New "Get started" page on fleetdm.com (#1721)
* Add "Get started" page to fleetdm.com

* Update website/views/pages/get-started.ejs

* Update get-started.ejs

Responsive button fixes.

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-08-20 10:34:14 +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 f8cbc14829d91e7577c63307fd9c4346dbc229bb

* 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 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: eashaw <caglc@live.com>
2021-08-17 19:55:13 -05:00
Mike Thomas
b2afa7fd4f
updated to homepage community section (#1461) 2021-07-24 08:46:02 +09:00
gillespi314
5e20b6792e
Adjust query library styling (#1386) 2021-07-16 19:42:54 -05:00
gillespi314
b705ad3c97
Fleetdm.com: Add back button and update page styles for query library detail pages (#1398)
* Refactor query-details page

* Simplify query-detail page html and css

* Add alt text for image
2021-07-16 19:15:53 -05:00
gillespi314
87ab319b30
Launch transparency page for fleetdm.com (#1391)
* Implement transparency page for fleetdm.com
2021-07-15 09:48:21 -05:00
Mike Thomas
7ffb327ae9
Watch video button and seamless cloud fix (#1381)
* Watch video button and seamless cloud fix

* Update website/views/pages/homepage.ejs

Added btn-link bootstrap class.

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
2021-07-15 07:02:06 +09:00
gillespi314
5bb4a05b44
Fleetdm.com: Template for documentation pages (#1297)
* Create fleetdm.com docs template

* Create controller and view for docs template

* Refine docs template

* Add links to docs template

* Refactor docs page schema

* Add img alt text

* Implement docs landing page

* Update links

* Fix padding; fix related topics; stretch link

* Fix browser compatibility issues

* sandbox in-development doc routes and fiddle around with the aliases to make our doc urls shorter (useful when embedding in code comments, etc)

resolves https://github.com/fleetdm/fleet/pull/1297#discussion_r666682928

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-07-09 00:58:40 -05:00
Mike Thomas
891a49145d
Faqs and style fixes (#1306)
* Pricing FAQ + minor fixes

* Update pricing.ejs
2021-07-05 18:45:08 -05:00
gillespi314
3a9a773741
Ship redesigned homepage for fleetdm.com (#1147)
* Redesign homepage, masthead and page footer

* Fix linting errors

* Fix Slack link text on xxs screen

* Replace logos

* Update homepage.ejs

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-07-01 18:06:14 -05:00
gillespi314
676f3f0bd5
Query library improvements -- Round 2 (#973)
-Modify build-static-content back-end script to implement GitHub Users API and build contributor profile information into query library pages
-Remove related functionality from client-side page scripts
-Add dropdown menu to select filters
-Refine html and css
2021-06-10 12:57:37 -05:00
gillespi314
71f53e6f4e
Query library improvements (#945)
* Add contributor avatars to query-detail page

* Add check for contributors; style elements

* Add GitHub avatars, style css, reorder page script

* Add os logos, adjust styles

* Add mobile styles, refactor scripts, prettier

* Update img paths, fix linting errors
2021-06-03 19:34:40 -05:00
gillespi314
0c236fd701
Ship v1 of standard query library (#898)
* Implement detail page for standard query lib

* Add alt text for image

* Replace id with css class

* Implement query-libary page for fleetdm.com

* Remove console.log

* Implement client-side search for query library

* Add responsive breakppoints

* Fix input tag
2021-05-28 16:57:04 -05:00
gillespi314
e27fda73b2
Implement query-library page for fleetdm.com (#891)
* Implement detail page for standard query lib

* Add alt text for image

* Replace id with css class

* Implement query-libary page for fleetdm.com

* Remove console.log
2021-05-28 16:00:40 -05:00
gillespi314
5ec25e461f
Implement query detail page for standard query library (#887)
* Implement detail page for standard query lib

* Add alt text for image

* Replace id with css class
2021-05-28 12:00:54 -05:00
Mike McNeil
ac220ba6e5
Obviate doc-templater dependency + dynamic sitemap.xml (#827)
* trivial

* Simplify build-static-content script and rip out the old markdown compilation for query library

* improve error msg

* trivial

* move helper

* bring in the skeleton

* Compile handbook as well, and bring more stuff inline

* instead of generating sitemap.xml file, could just serve it as a route

* Serve sitemap.xml on the fly

* add failsafe to prevent search engine accidents

* add remaining hand-coded pages to sitemap

* rearrange routes and get rid of commented-out ones

* Update build-static-content.js

* stub out the remaining pieces

* Add assertion (Which actually helped catch a real duplicate query: get-mac-os-disk-free-space-percentage)

* clean out inadvertently committed stuff in sailsrc

* route and serve data for correct query by slug + fix error message re duplicate query slugs + added assertion for duplicate doc page slugs

* yaml == dev dependency

* remove doc-templater dependency, as promised

* stub out handbook page

* clarify comments & remove unnecessary skipAssets

* Update build-static-content.js

* res.badConfig()

* add missing exit that I left out back in ec95df6a4b

* remove unused file

* update comments before commenting out and moving over to basic-documentation.less

* move example styling of generated HTML over to docs/handbook

* include both links

* Fix sitemap.xml URLs in local dev by fixing baseUrl config for local development (since Fleet itself is on 1337).

* followup to d55c777590

* Include query pages in sitemap.xml (+make urls generated for docs/handbook in build script slightly more real) -- but also don't serve sitemap

* sails.config.builtStaticContent.allPages » sails.config.buildStaticContent.markdownPages  (also remove unnecessary trailing slash trimming)

* trivial

* check config when serving sitemap + smarter error message for contributors

* hook up GitHub link to edit the query

* remove html ids

* Update query-detail.ejs

* somre more setup re https://github.com/fleetdm/fleet/issues/368#issuecomment-848566533
2021-05-26 03:24:38 -05:00
RachelElysia
69501b4727
Website query library styling (#800)
* Style query-details to match Figma

* Add ignored partial content to query-detail comment

* Stlye markdown html elements using CSS

* Render lightbulb icon

* Remove superfluous div

* Remove markdown build from sailsrc

* Remove coding workspace

* Fix bug

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>

* trim trailing whitespace + leave note about stuff living outside page selector

* fix stringQuotes and duplicateProperty lesshint checks

* fix importantRule lesshint check

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-05-26 01:16:05 -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 4e7e23990c472e84f3f24391ef360a175f725609)

* 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
RachelElysia
06f89c2978
Website: Pricing page (mobile) (#788)
* Cleaner mobile view

* Website styling and move quote
2021-05-19 10:15:57 -05:00
Mike McNeil
9d420068ef
Update capabilities chart + copy edits + fix lint (was broken for local dev only - re md compilation) (#768)
* fix linter so it doesn't freak out when developing w/ compiled markdown content locally

* copy edits + add back call to action at bottom of homepage so there's somewhere to go
2021-05-14 03:25:40 -05:00
gillespi314
74b4cd535f
Revise website contact form (#753)
* Add topic select, revise content of contact form

* Fix styling of btn-primary class

* Restore deliver-contact-form-message function

* Fix lesshint linting errors

* Fix on hover style of btn-primary

* Adjust box-shadow for btn-primary

* Update contact form

* Fix lesshint linting errors

* Add personalization to submitted form modal

* Add responsive styles to contact form
2021-05-13 09:13:34 -05:00
Mike McNeil
56e143a14f
Compile markdown docs (#714)
* Brought in the mostly-unchanged stuff from Sails website- changed just enough to get it working

* inline beforeConvert and afterConvert, for readability

because it's better when you tell a story with the parts of the story in order

* trivial (change arg name for clarity)

* trivial (apply more up-to-date err callback convention)

* modernize some of the bits relying on reassigning arguments

* convert the rest of the way to async/await

* trivial

* just aesthetics

* remove reliance on app-level config

* mostly i'm doing this to remember how it works

* normalize better so this can be more flexible

* this makes it work (albeit needs a bit more fluffing)

* strip out more sails-specific stuff

* clean up menu files between runs, scrape off a bit more technical debt

* scrape out some more dead code

* use devDependencies for markdown compilation stuff since it won't be compiling at runtime

* stub script for compiling markdown content

* Fill in implementation of script, rename helper.

* add note about the non-markdown file problem

* tweak output paths for clarity

* Improve generated menu content and set up groundwork for being able to easily access it via config

* Use .sailsrc to hold onto menu content, so it's injected into config for easier access (rather than reading JSON files whenever needed)

* more explicit tmp filename, in case we forget how this works later

* fix typo in build script (missing .js extension)

* Stub query detail page and a dev route for developing it

http://localhost:2024/sandbox/example-query

* fix helper friendlyName

* Run compilation in series to avoid race condition in doc-templater when cloning from the same repo.  Add todos about sitemap and further menu data cleanup.

* make sandbox actually useful

* Help prevent accidental checking in of compiled HTML files.

* rename script and generated folder in partials/

* fix/expand script metadata
2021-05-09 23:48:59 -05:00
gillespi314
5af0d6b870
Update website styling (#715)
* Update website styling

* Convert ellipse margin from rem to px

* Adjust padding to match neighboring card element

* Fix linting errors

* Remove unneeded div
2021-05-07 13:54:29 -05:00
RachelElysia
d7fbf55131
Website font and schedule button (#676)
* Correct fonts: Nunito and Nunito Sans

* Modify schedule demo button

* Arrow speed

* Add all font weights to website font

* Globalize font size for header, paragraph, footer

* Readable color for dropdown-item:active

Co-authored-by: Rachel Elysia Perkins <rachel@fleetdm.com>
2021-04-28 16:31:43 +09:00
Mike Thomas
23ba4be402
Updated header text on homepage (#673)
- Updated header text on homepage
- Add new log destination graphics
2021-04-22 11:23:21 -07:00
RachelElysia
0474999bd2
Add get-started page to fleetdm.com (#590)
* Add get-started page
* Includes Styling
* Includes Routing switch
Review and suggestions added by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
Review and suggestions added by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-04-06 11:23:13 -04:00
RachelElysia
37d519a4fb
Revert "Get started (#583)" (#584)
This reverts commit 08775b6309 which was not ready for deployment.
2021-04-02 17:16:29 -07:00
RachelElysia
08775b6309
Get started (#583)
* Add get-started
* Add learn more section
2021-04-02 18:24:20 -04:00
RachelElysia
2314def1a1
Create pricing page (#575)
* Copy homepage pricing over to pricing page
* Remove commented-out FAQ skeleton on pricing page
2021-04-02 16:12:28 -04:00
noahtalerman
09aad8ff07
On fleetdm.com, add stubbed "Pricing" page (#571)
Add action, template stub, and stylesheet for "Pricing" page
2021-03-31 17:24:42 -07:00
noahtalerman
85b31a3523
On fleetdm.com, add stubbed "Get started" page (#570)
- Add action, template stub, and stylesheet for "Get started" page
- Add new styles for site header
- Update feature comparison to indicate agent autoupdates are now available!
2021-03-31 16:08:36 -07:00
noahtalerman
0c31044340
Add top navigation, add new assets, and edit text on fleetdm.com (#517)
* Add nav items for desktop width

* Finish desktop width navigation styles

* Add new assets

* Add mobile menu and graphic

* Add assets and new navigation

* trivial (just for consistency, in case we ever change where that points)

* Make image go away on small screens

* Update deploy-google-cloud-75x60@2x.png

Uploaded correct sized retina image.

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
Co-authored-by: mthomas-fleet <mthomas@fleetdm.com>
2021-03-23 17:56:15 +09:00