* updating docs to make things a bit more clear
* fixing broken links
* more broken links
* fixing broken links
* website updates
* PR review changes
* fixing bad links
* route to privacy policy doc
* updated footer layout, higher resolution CC license
* updated footer layout, styles and color twitter logo
* change papercups widget color
* 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
* Fleet's core is MIT-licensed. This helps avoid any confusion
* Removing other instance of creative commons license text
Co-authored-by: eashaw <caglc@live.com>
* 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>
* handling redirect
* clean up redirect/notFound flow
* dynamic query titles and description
* dynamic docs titles
* Remove locals from queries and docs, updated comment and variable names
* handling FAQ page titles
* update comment, title in meta, and adjust get started title
* remove unneeded meta tag
* handbook titles
* cleaning up conditionals
* update comments
* removed added meta tags, change meta variable names
* passing in meta description if provided, update conditionals and comments
* Update FAQ.md
* Docs image replacement
https://github.com/fleetdm/fleet/pull/2071 (removing hardcoded widths on images) undoes what we previously did for making smaller images look good at <990px breakpoints.
Only current examples of these smaller images are on this page in the docs, although there are a couple of instances in the handbook. So I propose that we only crop images that will work at full container width sizes.
With that in mind I have replaced one of the affected images on this page.
* Update homepage.ejs
Updated homepage verbiage.
* Revert "Merge branch 'mike-j-thomas-patch-1' of https://github.com/fleetdm/fleet into mike-j-thomas-patch-1"
This reverts commit 65af0eb8ddfb8cdc298747df0f6f7599d7cee6cc, reversing
changes made to f9d9dbca7db8c270e5f358796b65e8a323936d52.
* Revert "Revert "Merge branch 'mike-j-thomas-patch-1' of https://github.com/fleetdm/fleet into mike-j-thomas-patch-1""
This reverts commit a75be66d25afc6521e827f4d9b29a6f74bbd1300.
* fix typo
Co-authored-by: eashaw <caglc@live.com>
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.
* 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
* 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
* 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
* 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.
* added title to locals in routes
* using title and description if they are passed into the locals
* fix error being thrown if there is no description
* descriptions
* fixed error, updated descriptions
* update twitter card title
* updated descriptions again
* updated twitter title
* remove hardcoded width on images
* fix inconsistent image padding on fleet ui docs page
* Broken link fix
Fixed a couple of broken links to help this PR pass the automated tests.
Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
* 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
* 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
* 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
* Update footer links on fleetdm.com
Made footer links and labels consistent with the masthead main navigation
Added fleetdm.com/apply under "Jobs" label.
* Update layout.ejs
Re-ordered footer nav.
* 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
* Rename core->free and basic->premium
* Fix lint js
* Comment out portion of test that seems to timeout
* Rename tier to premium if basic is still loaded
* 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
* adjusted isUnsupportedBrowser to include all versions of internet explorer and changed unsupported browser message for ie11
* removed ie11 from supported browsers docs page
* Website - updated redirects and top nav
Updated Get Started and Pricing redirects.
I also propose that Get Started should be a simple link to the Get Started guide, rather than a drop down.
Contribute and Hall of fame confuse the getting started process, and so I think these should reside in the footer nav.
* Update pricing.ejs
Updated link and FREE tier button label for consistency.
* Update routes.js
Added '/install': '/get-started', to convenience.
* Update routes.js
Removed 'GET /install': { action: 'view-get-started' }, from webpages.
* updated-testimonials
Updated the testimonial section on homepage.
* testimonial position swap
Swapped the order of testimonials for a more balanced layout.
* added logo image
* Update website/views/pages/homepage.ejs
This link change was missed this morning.
Background - we don't want to send existing users from the docs to the pricing page, so until we are able to deploy the new Get Started page, we are temporarily sending this link to the install guide on GitHub.
* 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>
* Move usage analytics action for the sake of convention
* followup to ed4a500e159ac118018f8adb7279abdd59be6c24 to fix policy mapping
* Add stub of webhook handler for GitHub bot (at this point, a mostly-verbatim copy paste of sailsbot -- will work backwards from this to what we actually need in Fleet)
* Everyone can follow the same rules. Except bots. And Noah.
* same as 5c97f47effaf72f15f5628c83b50f80781d46acd
* replace a separate, explicit check for "sailsbot"
* Comment out stuff Fleet is not using for the foreseeable future
* use Fleet's green label color (could switch to "+" prefix as well, just would require tweaking)
* Make sails run wipe-staging just be sails run wipe.
* Add instructions to README
* use latest postgresql adapter + update wipe script (will probably change this to mysql at some point for consistency)
* Update README.md
-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
* /sandbox/queries becomes /queries, etc
* Publish fleetdm.com/queries
Expose query library routes the rest of the way, move remediation data sanitization to the point of entry, and update query library to match (pairing w/ @gillespi314)
* Fix accidental commit of sailsrc (again)
* 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
* 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
* 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
* 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)
* Added cursor:unset
* removed !important rule from cursor
* Update layout.less
Looks like there's a class already set up for the dropdown menu button. Updated the property there.
* 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
@gillespi314 btw you did this exactly right, I just realized when I tested this out (after realizing I had it configured wrong in prod) that I should have recommended an error instead of a warning
* 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
* 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
* website-add-jobs-link
Add jobs link to the footer.
Also fixed up some padding issues in the footer at tablet and mobile breakpoints.
* Update layout.less
* Update website styling
* Convert ellipse margin from rem to px
* Adjust padding to match neighboring card element
* Fix linting errors
* Remove unneeded div
- Add new `2-Orbit-osquery/` directory to the top-level `docs/` directory.
- Rename `2-Deployment/` -> `3-Deployment/` to accommodate new Orbit directory.
- Rename `3-Contribution/` -> `4-Contribution/` to accommodate new Orbit directory.
- Add FAQ section to Orbit documentation.
* 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>
* option 1 (this is the quickest fix)
* option 2: This shows how to handle it inline
* whoops, fix prev commit (I forgot to pull out of the "if")
* closes https://github.com/fleetdm/fleet/issues/0 -- this remove headerClass altogether in favor of using existing "page" local, eliminating the need for a headerClass view local -- see https://github.com/fleetdm/fleet/issues/0#issuecomment-827752563 for explanation
* one further simplification that avoids `page` getting unintentionally used elsewhere in other .ejs files (also isHomepage is easier to cmd+f and find in code)
* 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>
- unhandledPromiseRejection errors caused test failures on Node 15.
Instead verbose log these for later followup.
- Fix uses of Nock in tests
- Fix some warnings in tests
- Upgrade some test dependencies
- 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!
* 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>
