Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-22 00:18:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 106
fleet/docs/1-Using-Fleet
History
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
..
configuration-files Prepare for Fleet 4.2.0 (#1645) 2021-08-11 17:14:32 -07:00
standard-query-library Add correct query (#1669) 2021-08-13 15:00:46 -04:00
tutorials Update "Ask questions about your devices" walkthrough and update API docs (#1670) 2021-08-13 15:01:53 -04:00
1-Fleet-UI.md Put live documentation on fleetdm.com (#1380) 2021-08-17 19:55:13 -05:00
2-fleetctl-CLI.md issue 1313 -- add file destination for convert command (#1672) 2021-08-13 20:42:58 -04:00
3-REST-API.md Align API docs and frontend interfaces with API GET responses (#1602) 2021-08-16 10:30:19 -04:00
4-Adding-hosts.md Update examples in documentation to use FleetDM where possible (#1310) 2021-07-06 12:14:20 -04:00
5-Osquery-logs.md Add information about use of differential queries in Lambda documentation (#1195) 2021-06-25 10:23:35 -04:00
6-Monitoring-Fleet.md Restructure documentation in preparation for docs living on fleetdm.com (#1143) 2021-06-18 15:58:21 -05:00
7-Security-best-practices.md Update documentation structure (#1230) 2021-06-28 11:15:22 -04:00
8-Updating-Fleet.md Fix broken links to binaries in docs (#1277) 2021-07-03 11:36:27 -05:00
9-Permissions.md Move configuration examples out of fleetctl-CLI documentation (#1253) 2021-06-29 13:59:54 -04:00
10-Teams.md Make creating dirs and files more secure by checking permissions (#1566) 2021-08-11 11:02:22 -03:00
11-Usage-statistics.md Move configuration examples out of fleetctl-CLI documentation (#1253) 2021-06-29 13:59:54 -04:00
12-Supported-browsers.md Update 12-Supported-browsers.md (#1653) 2021-08-11 20:26:29 -05:00
13-Vulnerability-Processing.md Issue 1632 software inventory config (#1636) 2021-08-11 15:57:53 -03:00
FAQ.md Update FAQs based on lessons learned (#1495) 2021-07-28 19:30:03 -03:00
README.md revert 39d55bf66a 2021-07-22 02:23:42 -05:00

README.md

Using Fleet

Fleet UI

Provides documentation about running and scheduling queries from within the Fleet UI

fleetctl CLI

Includes resources for setting up and configuring Fleet via the fleetctl CLI

REST API

Provides resources for working with Fleet's API and includes example code for endpoints

Adding hosts

Provides resources for enrolling your hosts to Fleet

Osquery logs

Includes documentation on the plugin options for working with osquery logs

Monitoring Fleet

Provides documentation for load balancer health checks and working with Fleet server metrics and performance

Security best practices

Includes resources for ways to mitigate against the OWASP top 10 issues

Updating Fleet

Includes a guide for how to update and run new versions of Fleet

FAQ

Includes commonly asked questions and answers about using Fleet from the Fleet community