Commit Graph

108 Commits

Author SHA1 Message Date
Mike McNeil
3803a38972
4 continents, 7 tzs (#2944)
* 4 continents, 7 tzs

* eof crlf
2021-11-16 18:13:15 -06:00
Zach Wasserman
fd6c4f1e08
Update oncall process (#2970) 2021-11-16 13:10:09 -08:00
Noah Talerman
8c0c00884f
Fix broken link in "Osquery logs" documentation (#2906)
- Fix a broken link in the summary of the "Osquery logs" documentation
- Update instructions for linking to a specific section within a page in the Fleet documentation in product handbook
2021-11-12 17:40:32 -05:00
Mike McNeil
6cfab22c02
Update customer-first.md (#2900) 2021-11-11 21:15:10 -06:00
Mike McNeil
8830806b2b
Update product.md (#2844) 2021-11-08 20:45:44 -06:00
Noah Talerman
bb600c030b
Add feature flag guidelines to Fleet's public handbook (#2823)
- Add outline for when a feature is placed behind a feature flag in the Fleet product
- Add items to consider when deciding if feature flags should be leveraged
2021-11-08 10:15:56 -05:00
Mike Thomas
40de2cd266
Update customer info on DRIs table (#2811)
Rather than call out a specific customer here, do you think we should use dummy text e.g., acme.fleetdm.com?
2021-11-05 01:08:55 -05:00
eashaw
40527af670
Add DRI section to the Fleet handbook (#2800)
* table styles for handbook

* Update product.md

* Update product.md

* Update product.md

* update readme links

* move dri section, update readme links

* Update product.md

* requested changes

* moved dri section to people, updated readme links, moved table of product DRIs

* Update handbook/product.md

* Update handbook/product.md

* Update README.md

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-11-05 12:11:44 +09:00
Renee Jackson
d003046b21
update product.md to include Quality objectives (#2784)
* update product.md to include Quality objectives

Targeting defect reduction and customer service as high priority objectives

* Update handbook/product.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* switch maintainer metatag

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2021-11-04 15:23:37 -03:00
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