Commit Graph

20 Commits

Author SHA1 Message Date
Eric
52da2a3108
change relative links in documentation (#8441) 2022-10-26 18:26:49 -05:00
Frank Sievertsen
a2c47cf4f4
add host_display_name to live query rows (#8251) 2022-10-17 15:52:25 +02:00
Andrew Baker
b23a63952d
Embed FleetCLI video in docs page (#7482) 2022-08-31 14:09:20 -04:00
Mo Zhu
b188e272dc
slight change in meaning (#6751) 2022-07-19 17:46:20 -04:00
Mo Zhu
51e505c3f6
Update API-Only User doc (#6725)
* more details on api-only user doc

* Update fleetctl-CLI.md

* Apply suggestions from code review

Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>

* Update docs/Using-Fleet/fleetctl-CLI.md

* Update docs/Using-Fleet/fleetctl-CLI.md

Co-authored-by: Kelvin Oghenerhoro Omereshone <kelvin@fleetdm.com>
Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
2022-07-19 15:46:52 -05:00
Kelvin Oghenerhoro Omereshone
2514b610b4
Use v1 for osquery endpoints (#6137)
- Update docs to use `v1` in the osquery endpoints. Ex: /api/v1/osquery/config.
- Update the Fleet UI's (Hosts > Add hosts > Advanced) flagfile.txt to use `v1` in the osquery endpoints.
2022-07-13 14:34:44 -04:00
Kelvin Oghenerhoro Omereshone
31c3937d7f
Update Fleetctl docs and fix typo (#6473)
- Use consistent "osquery installer" and "Fleet UI" language
2022-07-06 10:02:55 -04:00
Desmi-Dizney
77ee213407
Editor pass - Update docs to include how to get the API token of an api-only user (#6445)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/6381
2022-07-05 09:20:15 -04:00
Kelvin Oghenerhoro Omereshone
acdb9a9c0b
docs: update doc to include how to get the API token (#6381) 2022-06-29 15:07:07 -04:00
Desmi-Dizney
a45a2f4608
Editor pass - add documentation for debug tools (#5811)
* Editor pass -  add documentation for debug tools

Editor pass for:
-  https://github.com/fleetdm/fleet/pull/5737

* Update fleetctl-CLI.md
2022-05-20 13:01:54 -05:00
Roberto Dip
a6a97f31cf
add documentation for debug tools (#5737)
This adds documentation about our debugging endpoints and a brief excerpt about the fleetctl debug command with instructions to generate the archive so we have a place with instructions to which we can direct people.

It also adds the .prof file extension to profiling files, which hopefully clarifies that they are meant to be used by go tool pprof.
2022-05-17 10:00:47 -03:00
Kelvin Oghenerhoro Omereshone
25ce199f34
Normalize sql statements throughout the docs (#5487)
* feat: normalize SQL statements in API-for-contributors.md

* feat: normalize SQL statements in Adding-hosts.md

* feat: normalize SQL statements in fleetctl-CLI.md

* feat: normalize SQL statements in REST-API.md

* feat: normalize SQL statements in Vulnerability-Processing.md

* feat: normaize SQL statemetns in Using Fleet ReadMe

* feat: normalize SQL statements in tools/api README

* fix: revert adding hosts page
2022-05-03 15:47:31 +01:00
Katheryn Satterlee
a4a831fc92
Move password reset instructions for API-only user (#5392)
* Move password reset instructions for API-only user

Moved instructions for resetting the password of a new API-only user to FAQ as it is no longer necessary as of `4.13.0`

* Fix link to reset password instructions

Linked to a previous commit with password reset instructions for API-only users (only necessary on legacy versions).
2022-05-02 13:33:12 -05:00
Katheryn Satterlee
8bb6b5a9c7
Add note for v 4.13 to fleetctl docs (#5274)
Co-authored-by: Kelvin Oghenerhoro Omereshone <kelvin@fleetdm.com>
2022-04-21 15:28:01 -05:00
Michal Nicpon
cc249e0ff1
revert api v1 to latest in documentation (#5149)
* revert api v1 to latest in documentation

* Update fleetctl doc page

Co-authored-by: Noah Talerman <noahtal@umich.edu>
2022-04-14 16:33:52 -05:00
Martavis Parker
a8d7b5478b
Updated API routes to use current format for frontend use (#5018)
* removed global api routes; using 'latest' instead of v1 for api routes

* lint fixes

* updated docs and tests

* lint fixes

* route fix

* fixed routes breaking packs queries

* revert test change
2022-04-11 13:04:38 -07:00
Martin Angers
90b15071a4
Introduce API version 2022-04, deprecate use of /global in paths (#4731) 2022-04-05 11:35:53 -04:00
Katheryn Satterlee
d3454bcfce
Weekly community-driven documentation update for week ending March 25th (#4818)
* Weekly community-driven docs update for week ending March 25th

* Update Configuration.md

* Update FAQ.md

All edits are recorded by line:
192 added “-“ to “auto-updates”
194 added “-“ to “auto-updates”; deleted “,” after “(easy)”; replaced “reccomend” with “recommend”
209 added “,” after “work”
211 replaced “am I seeing” with “do I see”
225 replaced “The best way to maintain historical data currently would be to use the [REST API](./REST-API.md) or the [`fleetctl` CLI](./fleetctl-CLI.md) to manually retrieve and save the data you need on your schedule. “ with “Currently, Fleet only stores the current state of your hosts (when they last communicated with Fleet). The best way at the moment to maintain historical data would be to use the [REST API](./REST-API.md) or the [`fleetctl` CLI](./fleetctl-CLI.md) to retrieve it manually. Then save the data you need to your schedule.”

* Update FAQ.md

All edits are recorded by line:
194 deleted ”either” after “disabled”

* Update fleetctl-CLI.md

All edits are recorded by line:
28 deleted “of the” after “many”; replaced “User Interface” with “UI(User Interface)”; replace “, and to” with “. You can even”
43 capitalized “Fleet”
63 replaced “info” with “information”

* Additional context for help menu and add table

Tweaked wording around using the help command and moved available commands in to a table. @DominusKelvin @Desmi-Dizney

* Update Configuration.md

space

* Final grammar revision

Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
2022-03-31 10:34:58 -05:00
Katheryn Satterlee
a1eba3d5b9
Kathy 4533 4020 documentation updates (#4646)
* Add instructions for creating and using an API-only user with fleetctl

* Update fleetctl-CLI.md

* Update example responses for policies and teams

* Update fleetctl-CLI.md

This was a super clean edit!
All edits are recorded by line:
199 replaced “passing” with “picking”; added “,” after “email”
253 replaced “:” with “.”

* Update fleetctl-CLI.md

Line 253 I changed "." to ":"

* Change  `Create a new context for your standard user (optional)` > 'Switching users'

* Update fleetctl-CLI.md

All edits are recorded by line:
195 replaced “are” with “is”
207 replaced “will be able to” with “can”; replaced “needs to be” with “is”
249 replaced “has been” with “is”

* Update API-only user creation instructions

Added additional context to the user creation command and fixed some grammar issues.

Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
2022-03-30 11:38:38 -05:00
eashaw
0af5e161d0
Remove numbers from documentation filenames in Fleet repo (#4313)
* Renaming files and a lot of find and replace

* pageRank meta tags, sorting by page rank

* reranking

* removing numbers

* revert changing links that are locked to a commit

* update metatag name, uncomment github contributers

* Update basic-documentation.page.js

* revert link change

* more explicit errors, change pageOrderInSection numbers, updated sort

* Update build-static-content.js

* update comment

* update handbook link

* handbook entry

* update sort

* update changelog doc links to use fleetdm.com

* move standard query library back to old location, update links/references to location

* revert unintentional link changes

* Update handbook/community.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>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-02-23 12:17:55 -06:00