Commit Graph

1249 Commits

Author SHA1 Message Date
eashaw
5dc6859969
Fix broken markdown link in handbook (#2650) 2021-10-28 10:24:23 -05:00
Mike Thomas
739a1d8f8d
Updated product section of handbook (#2680)
* Updated product section of handbook

• Changed section heading Fleet EE to "UI design".
• Added sub-section "Design conventions" under UI design.
• Re-ordered content. I felt that QA and release process was of more importance than UI design.

* Update README.md
2021-10-26 14:17:17 +09:00
Luke Heath
99673eb148
Fix broken links to docs (#2561) 2021-10-22 12:39:20 -05:00
eashaw
4d2b098f39
remove second growth link (#2634) 2021-10-22 13:55:44 +09:00
Renee Jackson
56aee3b582
add_criteria (#2556)
* add_criteria

adds agreed upon criteria for
1. version support and troubleshooting
2. freeze period definition
3. Some adjustment to the Manual QA section based on the creation of Release QA ticket templates and smoke tests.

* Update handbook/product.md

Co-authored-by: eashaw <eashaw@sailsjs.com>

Co-authored-by: eashaw <eashaw@sailsjs.com>
2021-10-18 19:22:34 -03:00
eashaw
01d38150c8
Add first draft of values to Fleet handbook (#2498)
* Update company.md

* updated h5 styles, add values section
2021-10-13 13:54:48 +09: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
Mike Thomas
b8a2da21b2
Update README.md (#2301) 2021-10-01 15:34:38 +09:00
Mike Thomas
0a258a5fd4
Added new nav item to handbook land page (#2302)
Added anchor link for Promoting blog posts on social media to handbook land page.
2021-09-30 16:14:05 -05:00
Mike Thomas
e3ff9e4274
Handbook: Blog post publishing process (#2299)
* Update growth.md

Added a section for Fleet blog post authors about how to promote their blog posts to our social media.

Some thoughts. Including an assignee is not very future proof, in case roles change etc. Maybe best to leave that out, and we can add an assignee when we see the issue in Growth meetings.

HackerNews reserved for release posts only. Added that based on recent recommendation, due to HackerNew's strict policies. Are we happy with that, or should promoting on HackerNews be treated case-by-case?

* Update growth.md

* Update growth.md

* Update growth.md

* Update growth.md
2021-09-30 12:13:03 +09:00
Mike Thomas
145a6aa62b
H5 >> H4 heading fix (#2254)
Changed the H5 headings under Fleet EE to H4 to match.
2021-09-28 16:01:37 -05:00
Renee Jackson
4cf8a145be
Update product.md (#2257)
add --tag documentation
2021-09-28 13:28:28 -03: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
Renee Jackson
e5452f4e4d
Update manual qa document (#2124)
* Pack location

Future-proofing instructions for ease of onboards by adding location information.

* Label queries are immutable (addition)

Previous document made it seem users should be able to edit label queries.

* removal of all non-preview tasks

Non-preview tasks will be moved to /docs/3-Contributing/2-Testing.md. Additional changes include clarifications to the testing steps.

* update link

* Update manual-qa.md
2021-09-23 11:32:02 -03:00
Renee Jackson
ca27bd9d5c
fix broken links by adding missing 0 (#2187)
* fix broken links by adding missing 0

* fix broken links take 2

gather links missed in first pass
2021-09-22 13:28:25 -03:00
Mike McNeil
14e46cf7fa
Stub growth handbook (#2096) 2021-09-17 10:29:31 -05:00
Mike McNeil
d85756a1ec
Delete why-fleet.md (#2120)
will come back to this in https://github.com/orgs/fleetdm/projects/21#column-15983311
2021-09-16 22:33:43 -05:00
gillespi314
20d02c3f23
Update manual-qa.md 2021-09-13 15:32:33 -05:00
gillespi314
5e89c0efcf
Update manual-qa.md
Fix fleetctl pack flow instructions
2021-09-13 14:37:54 -05:00
gillespi314
e99a596469
Update manual-qa.md
Fix fleetctl commang syntax
2021-09-13 14:27:49 -05:00
Mike McNeil
c98d0b3a46
Kick off the customer success handbook section (#1896)
* Kick off the customer success handbook section

* say it in fewer words
2021-09-06 19:08:49 -05:00
noahtalerman
333dfd800f
Update release process documentation in the Handbook (#1922)
- Add documentation for writing the release blogpost
- Remove old documentation that no longer applies
2021-09-02 18:28:39 -04:00
Mike Thomas
0adbe0028e
Handbook - How to add a link to Fleet docs (#1856)
* Handbook - Adding links to Fleet docs

Instructions for how to add, and fix links in the Fleet docs.

* Update handbook/README.md

* Update handbook/README.md

typo fix.

* Update handbook/README.md

Added paragraph about linking to other docs pages using relative paths.

* Update handbook/README.md
2021-08-31 10:09:37 +09:00
noahtalerman
63df5881c0
Temporarily comment out failing e2e tests and add coverage to manual QA (#1859)
- Commented out the following e2e tests because they're consistently failing in the GitHub CI:
  - Delete a host from the **Host details** page
  - Query a host from the **Host details** page
  - As a global maintainer, delete a host
- Add coverage for the commented out tests in the manual QA doc
2021-08-30 15:34:28 -04:00
Mike Thomas
44b66a8f27
Handbook - Fleet grammar guidelines (#1852)
* Update README.md

Made a start at adding Fleet's style and grammar guidelines to the handbook.

* Update README.md
2021-08-30 14:12:43 -05:00
noahtalerman
731fb599a1
Update sources (links) to check when on call in Support process document (#1833)
- Add item and link to all "Reported bugs" (GitHub issues with the "bug" and ":reproduce" label). This way, the individual on call can navigate to a list of bugs that need reproduction. 
- Add a link to the open pull requests. This way, the individual on call can identify any PRs that have been opened by the community.
2021-08-27 14:45:41 -04:00
Mike McNeil
b804f2e569
avoid confusion with the other kind of HR benefits (#1747) 2021-08-19 19:21:57 -05:00
Mike Thomas
6abd5d1353
Add cross-browser check process to handbook (#1713)
* Add cross-browser check process to handbook

Documented website cross-browser compatibility testing process in handbook.

* Update handbook/README.md

Co-authored-by: Zach Wasserman <zach@fleetdm.com>

Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-08-19 13:01:45 +09:00
Mike Thomas
e738bae9bb
Updated to handbook (#1711)
* Updated to handbook

Added "Communicating design changes to Engineering" section to the handbook.

* Review changes

Blockquote for note. Header for unplanned changes.
2021-08-18 19:51:01 -05:00
Tomas Touceda
989e638cc0
Make creating dirs and files more secure by checking permissions (#1566)
* Add safe mkdirall and open

* Use secure as much as possible and merge gomodules for orbit to fleet

* Improve openfile and mkdirall to check for permissiveness instead of equality

* Don't shift

* Fix links

* Address review comments
2021-08-11 11:02:22 -03:00
noahtalerman
da7925e1d7
Remove changes files. Update release process. Update support process (#1492)
- Remove changes files that were collected during the 4.1.0 release cycle
- Add removing changes files step to release process documentation
- Update support process docs to reflect the change to discussing the last on-call rotation at 🍽️  Daily standup meeting
2021-07-27 17:06:16 -04:00
noahtalerman
15ef1e3d6e
Update support process documentation with instructions for customer feature requests (#1444) 2021-07-22 09:38:25 -04:00
Mike Thomas
c140263134
Delete old markdown queries (#1382) 2021-07-14 09:25:41 -05:00
Mike McNeil
e19a4e2cf5
Add tips for moderating comments diplomatically 2021-07-09 11:53:14 -05:00
noahtalerman
6c03415dae
Update documentation structure (#1230)
- Remove `2-Orbit-osquery` directory
- Rename `3-Deployment` directory to `2-Deploying`
- Rename `4-Contribution` directory to `3-Contributing`
2021-06-28 11:15:22 -04:00
Zach Wasserman
b00df0929e
Fix URLs in documentation (#1218)
Fix URLs not caught in previous PR CI run.
2021-06-25 19:23:45 -07:00
Zach Wasserman
5e26af701b Merge branch 'main' into teams 2021-06-25 18:48:20 -07:00
noahtalerman
946982918a
In support process docs, add instruction on adding milestones to feature request issues (#1214) 2021-06-25 17:56:31 -04:00
noahtalerman
7aa380b0f0
Add testing fleetctl to the manual QA doc and update example config files (#1213)
- Update enroll secret config file with updated fields for Fleet 4.0.0
- Remove agent options config file. In Fleet 4.0.0, agent options are part of the organization settings configuration
2021-06-25 17:56:00 -04:00
noahtalerman
ab68767aec
Remove roundup and add retro. Add link to internal FAQ (#1197)
- Remove instructions for 🐄 Roundup. Starting next week, this meeting will be replaced with an "On-call retro"
- Add link to internal FAQ google doc
2021-06-24 16:58:45 -04:00
noahtalerman
e02b88d010
Update links to documentation so that they use main branch (#1151)
* Update to main branch

* Update link to releasing Fleet
2021-06-21 16:40:15 -05:00
noahtalerman
17a6c21224
Restructure documentation in preparation for docs living on fleetdm.com (#1143)
* Remove Orbit top level folder and rename folders to Deploying and Contributing

* Update link in doc README
2021-06-18 15:58:21 -05:00
noahtalerman
133bbb235b
Add reference to FAQ files in Support process doc (#1109) 2021-06-16 12:00:33 -04:00
Mike McNeil
675f520b94
handbook: considerations when closing issues (#1106) 2021-06-16 09:08:40 -05:00
noahtalerman
dca4cf0790
Add tips for asking follow up questions in support process documentation (#1091)
- Update /handbook/support-process.md
- Add github.com/issues to ignored links in markdown link check
2021-06-15 14:51:45 -04:00
RachelElysia
edf1c47298
Add #oncall-chatter and Github Triage link 2021-06-14 09:58:27 -04:00
Mike McNeil
436464c953
Minor text fixes™
inspired by https://www.theatlantic.com/family/archive/2018/06/mr-rogers-neighborhood-talking-to-kids/562352/
2021-06-12 04:01:35 -05:00
Mike McNeil
61f3264dd7
On meetings 2021-06-11 19:20:09 -05:00
noahtalerman
ab8925a005
Replace 24 hours with 1 business day (#1020)
- Replace use of "24 hours" with "1 business day" in handbook/support-process.md
2021-06-08 15:55:23 -04:00
noahtalerman
da404d8db0
Add support process to /handbook (#894)
* Add community spin document to handbook

* Remove the before Hacker news and Quora

* Add updated support process document

* Remove reference to engineering standup because it doesn't exist

* Spell fix

* Tweaks to roundup templates
2021-06-08 10:56:41 -05:00
Mike Thomas
35993ab13b
Update README.md (#914)
* Update README.md

Added "How to export images" to website section.

* Update README.md

* Update README.md

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-06-01 11:50:13 -05:00
Mike McNeil
a2eb7f3f9c
(guiltily fixes markdown typo) 2021-05-26 21:16:18 -05:00
noahtalerman
a32c277780
Add Release process document to /handbook (#874)
* Add document

* Spell fix in README

* minor word trimming and added a comma or two.  This looks great!

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-05-26 21:07:00 -05:00
noahtalerman
adbcfc6407
Add instructions for resolving failed website deploy action to /handbook (#801) 2021-05-18 18:47:18 -04:00
noahtalerman
d7a4eb6b69
Add manual QA documentation to handbook (#770)
- Add a living "Manual QA" document to Fleet's handbook.
- The goal of this document is to provide a public location to capture Fleet's manual QA process.
2021-05-17 19:19:24 -04:00
Mike Thomas
08b659ce40
Update README.md - merging to Fleet website (#755)
Update handbook to include information about when to merge to Fleet website.
2021-05-14 13:52:22 -04:00
noahtalerman
7d9ca2cee7
Convert standard query library to YAML format (#749)
- Create `/configuration-files/` directory inside of `/1-Using-Fleet` directory. This directory contains example Fleet configuration files in yaml format. Replaces the `/examples` directory.
- Create `/standard-query-library/` directory inside of `/1-Using-Fleet` directory. This directory contains the new `standard-query-library.yml`. This file will act as the source of community contributions to the standard query library.
- Edit references to `/examples` directory
2021-05-14 13:38:33 -04:00
Mike Thomas
724278bd17
Query library crashes (#745)
* query-library-crashes

Daily addition to the query library.

* name change

changed the name to "Get crashes".

* Resolving conflicts in filenames

Resolving conflicts in filenames and deleting old version.
2021-05-11 01:06:44 +09:00
Mike Thomas
fa3c4e7446
query-library-crashes (#743)
Daily addition to the query library.
2021-05-10 22:57:40 +09:00
Mike Thomas
eaf576fda2
query-library-get-system-uptime (#736) 2021-05-07 21:22:03 +09:00
Mike Thomas
8e1742805a
Daily query 2021-4-27 (#683)
Get startup items
2021-04-27 15:03:54 +09:00
Mike Thomas
468dd28130
Create get-os-version.md (#670)
Add "Get OS version" to query handbook
2021-04-26 16:12:57 -04:00
Zach Wasserman
e8669818eb
Initial backend software inventory implementation (#678)
- Maintain software inventory with detail queries.
- Associated database migrations.
- Feature flagged off by default (see documentation for details to turn on).
- Documentation.
- New test helper for slice element comparisons skipping ID.
2021-04-26 08:44:22 -07:00
Mike Thomas
1f6123fac1
daily-query-library (#680)
Get mounts
2021-04-26 13:55:31 +09:00
Mike Thomas
bb488607b4
Create get-authorized-keys (#658)
- Add "Get authorized keys" query to `handbook/queries`
- Edit "Get installed ___ software" queries for all platforms to prepare for adding software inventory to the host details API endpoint
2021-04-20 11:45:20 -07:00
Mike Thomas
871ba3940d
Add count-apple-applications to query handbook (#653)
- Add "Count apple applications" to query handbook
- Add supported platforms to query index in `/handbook/queries` README
2021-04-16 16:50:20 -07:00
noahtalerman
1d1b26ee89
Prepare queries for Software inventory (#634)
This PR includes changes to the "Get installed ___ software" queries in the query handbook (4 total. 1 for each OS supported by osquery). 

- Add `type` column to all queries.
- Add `architecture and `install_time` column to Linux query.
- Add `architecture` column to FreeBSD query.
- Remove `opera_extensions` clause because osquery doesn't have an `opera_extensions` table.
2021-04-12 13:01:31 -07:00
noahtalerman
df5fa7f515
Add Detect high severity vulnerable versions of OpenSSL to query handbook (#630)
- Adds Detect Linux hosts with high severity vulnerable versions of OpenSSL to query handbook
  - Includes query to retrieve OpenSSL version
  - Includes query to retrieve OpenSSL version
2021-04-09 17:28:17 -07:00
Mike Thomas
5a06a47e9e
Query library - Get USB devices (#610)
Add Get USB devices query to query handbook
2021-04-07 16:35:58 -07:00
Mike Thomas
a5c77b0a04
Update and rename find-hosts-with-the-firewall-disabled.md to detect-… (#594)
- Update and rename find-hosts-with-the-firewall-disabled.md to detect-hosts-with-the-firewall-disabled.md
2021-04-05 18:40:05 -07:00
Mike Thomas
d0ca7cd808
Update and rename platform_info_snapshot.md to get-platform-info.md (#595)
- Update and rename platform_info_snapshot.md to get-platform-info.md
2021-04-05 18:39:42 -07:00
noahtalerman
114dd94770
Update query library README and add contributor template (#592)
- Update the `/handbook/queries` README with description, contributors section, and additional links
- Add template for contributors
2021-04-05 14:18:19 -07:00
Mike Thomas
5a2fcd279f
Create get-wifi-status.md (#588)
Add "Get wifi status" query to query handbook
2021-04-05 10:36:29 -07:00
Mike Thomas
cb0b2915b8
Create get-system-logins-and-logouts.md (#558)
Add Get system logins and logouts to /handbook/queries
2021-03-30 12:37:46 -07:00
Mike Thomas
49fd64daef
Create platform_info_snapshot.md (#551)
Add Platform info snapshot to /handbook/queries.
2021-03-30 12:31:25 -07:00
Mike Thomas
29b67181e9
Create get-installed-homebrew-packages.md (#557)
Add Get installed homebrew packages to /handbook/queries.
2021-03-30 12:29:57 -07:00
Mike Thomas
549f17f90e
Create get-macos-disk-free-space-percentage.md (#547)
Add "Get macOS disk free space percentage" query to `/handbook/queries`
2021-03-26 15:10:43 -07:00
Mike Thomas
fab88510af
Fix typo in handbook (#544) 2021-03-25 18:42:30 -05:00
Mike Thomas
a045794cd9
Create get-installed-safari-extensions.md (#537)
Add Get installed safari extensions query to handbook.
2021-03-25 09:19:21 -07:00
Mike Thomas
49ebafa859
Add expense policy to Fleet handbook (#524)
* Add expense policy to Fleet handbook

* Removed stray "."

* capitalization, + added a couple of other culture points that stand out

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-03-23 09:02:23 -05:00
Mike Thomas
38e8505a88
Create get-installed-chrome-extensions (#491)
Add "Get installed chrome extensions" query to the handbook.
2021-03-19 09:15:43 -04:00
headmin
49565ff1db
Fix minor issues in /handbook/queries queries (#485)
- Fix syntax for installed software queries
- Fix missing `version` column in `yum_packages` table for Get installed Linux software query
2021-03-17 10:44:56 -04:00
Mike McNeil
7d2a9ca7d2
Rename get-installed-window-software.md to get-installed-windows-software.md 2021-03-16 16:29:06 -05:00
noahtalerman
e07dcc9131
Add queries for windows, linux, and freebsd. Rename firewall query file. Edit macOS query (#479)
- Add 3 queries to the handbook:
  - Get installed FreeBSD software
  - Get installed Windows software
  - Get installed Linux software
 - Fix misspelling of firewall query file
 - Add `UNION` to installed macOS software
2021-03-16 10:50:54 -04:00
Marnin
595bf9acac
Add a semicolon to the query (#476)
- Fixes missing semicolon in "Find hosts with firewall disabled" query.
2021-03-15 09:54:20 -04:00
Mike McNeil
f22aae4f00
typofix + conform to Apple's brand style preferences
They like it like "macOS" (https://www.computerworld.com/article/3082696/apple-rebrands-os-x-as-macos-taps-upgrade-as-sierra.html), with a lowercase "m"
2021-03-12 18:02:21 -06:00
noahtalerman
650db555fd
Add 6 queries to the handbook (#459)
This PR includes 6 potentially useful queries.
2021-03-12 12:34:26 -08:00
Mike McNeil
40b284dfbf
Handbook: History of Fleet, etc (#453)
* added the history of Fleet

* add acknowledgements and a high-level overview of the company

* shout out to jason
2021-03-12 14:32:50 -06:00
Mike McNeil
3c26418298
Create README.md 2021-03-12 13:16:24 -06:00
Mike McNeil
b93a6de08b
fewer words 2021-03-11 19:44:40 -06:00
Mike McNeil
6e5bcf62f6
Update get-installed-macos-software.md 2021-03-11 19:03:13 -06:00
Mike McNeil
babe77ec7f
Rename get-all-macos-software.md to get-installed-macos-software.md 2021-03-11 19:00:03 -06:00
Mike McNeil
b31ba1d157
Update get-all-macos-software.md 2021-03-11 18:59:28 -06:00
Mike McNeil
a7059c5778
Update get-all-macos-software.md 2021-03-11 18:58:44 -06:00
Mike McNeil
de528c93f1
Create get-all-macos-software.md 2021-03-11 18:55:14 -06:00
Mike McNeil
9b812aec2c
incorporate feedback 2021-02-05 13:11:47 -06:00
noahtalerman
8a6fedb913
Add benefits to public handbook (#244)
Write up benefits in markdown and add to public handbook.
2021-02-01 08:23:25 -08:00
Mike McNeil
b1960ab971
Handbook (#66)
* kick things off

* terser
2020-11-30 14:48:14 -06:00