Commit graph

23 commits

Author SHA1 Message Date
Eric
26abd032db
Fix scrollbar on Firefox on windows (#5446) 2022-04-28 19:13:52 -05:00
Eric
c11bd43f6f
Website: sticky "On this page" navigation (#5342)
* sticky nav

* Update basic-documentation.less

* Update basic-documentation.less
2022-04-28 11:33:56 +09:00
Eric
71edc210b2
Website: Add blockquote styles to Handbook and Docs pages (#5009)
* add custom blockquote render and styles

* Update to-html.js

* adjust margin, replace icon

* increase margin on image

* Style updates

After seeing it in action, I noticed some improvements. I also updated Figma to reflect.

• Changed colors and icon alignment
• Adjusted top/bottom margins
• Adjusted corner radius
• Added new color variable (existing in Figma) to colors.less

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
2022-04-08 20:36:55 -05:00
Eric
dc27706193
Update website button styles (#4957)
* update button styles, make get-started match our styling conventions

* fix lint test, remove text-muted

* Update bootstrap-overrides.less

* remove `width: auto`
2022-04-06 13:55:05 -05:00
Mike Thomas
1cab8f4c74
Removed Nunito font (#3692)
* Removed Nunito font

We currently only use Nunito Sans as the Fleet typeface. These two references to Nunito were an error on my part in the design files.

Removed:
• Nunito font family

Changed:
• Nunito references to use Nunito Sans

* Replace Nunito with Nunito Sans

Co-authored-by: eashaw <caglc@live.com>
2022-01-17 11:20:18 -06:00
eashaw
39e210cd98
Update load testing documentation (#2979)
* update load testing, mobile table styles

* testing table layouts

* final tables

* update table styles

* Update basic-documentation.less

* revert unintentional change

* Update basic-documentation.less
2021-11-17 11:48:33 +09:00
eashaw
9a40b7d4ed
Add next steps to "learn how to use fleet" docs (#2797)
* added buttons, styles, meta tags for buttons,

* static buttons

* Update basic-documentation.less

* requested changes

* revert unintentional change
2021-11-08 21:10:52 +09:00
eashaw
53c815fbd4
focus-visable -> focus (#2605) 2021-10-22 13:51:59 +09: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
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
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
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
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
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
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
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 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: eashaw <caglc@live.com>
2021-08-17 19:55:13 -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
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