Commit Graph

20 Commits

Author SHA1 Message Date
Rachael Shaw
9190975ada
Document behavior for hosts/report endpoint when filtered by policy_id but not policy_response (#14127)
Documents behavior reported in
https://github.com/fleetdm/fleet/issues/13998
2023-09-26 16:46:38 -05:00
George Karr
68ac65f461
Add example errors to api docs for login (#13941) 2023-09-26 10:33:35 -05:00
Lucas Manuel Rodriguez
de4d76d09b
Documentation changes for #13926 (#14060)
Documentation changes for #13926.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-26 11:49:45 -03:00
Roberto Dip
e18b6bd52b
add missing docs for org_info (#13972)
As the title says, this adds missing docs for a feature we shipped a
while ago.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-22 19:15:37 -03:00
Eric
1b25187453
Docs: add syntax highlighting keywords to code blocks (#13963)
Closes: #13691

Changes: 
- Added keywords for syntax highlighting to code blocks in documentation
Markdown files.

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2023-09-22 16:57:40 -05:00
Rachael Shaw
433212dfed
Docs: Add vulnerability description to software api 2023-09-22 14:07:31 -06:00
Noah Talerman
6026130a8e
Update API docs: add get host by device token (#13761)
- Add get host by device token
- Remove this API route from the contributor docs
2023-09-12 17:13:09 -04:00
Martin Angers
55148df9db
Update docs for the patch /config behavior of integrations (#13758)
Companion docs-only PR for https://github.com/fleetdm/fleet/pull/13743
2023-09-06 16:09:57 -04:00
Roberto Dip
3e61342e73
add docs for scripts results API (#13720)
sibling PR https://github.com/fleetdm/fleet/pull/13701

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-06 11:47:25 -03:00
Tim Lee
055f8847fd
Fix policies api doc (#13721) 2023-09-05 15:37:43 -06:00
Martin Angers
cbc3f32e9d
Adjust response payload, messages and validations for /scripts/run/* endpoints. (#13607) 2023-08-31 09:08:50 -05:00
Rachael Shaw
34474b2e1d
Docs: Move parameters tables for count policies REST API docs (#13610)
Moved "Parameters" section above "Example" for consistent order across
the page
2023-08-30 17:35:26 -05:00
Tim Lee
222b8f9f5c
paginate the policies API (#13459) 2023-08-30 16:30:17 -06:00
Sabrina Coy
9fe298700f
Update rest-api.md (#13545)
Removed superfluous "an" from line 3926.
2023-08-28 15:38:23 -04:00
Roberto Dip
71c06f69f0
add links to RFC spec in docs (#13506) 2023-08-25 13:17:18 -03:00
Roberto Dip
4be557bb57
allow padded strings in mdm/apple/enqueue endpoint (#13502)
for #11384
2023-08-24 15:17:05 -03:00
Martin Angers
de32faefdb
Add /scripts/run and scripts/run/sync API endpoints to run scripts (part 1) (#13417) 2023-08-21 14:47:19 -04:00
Mo Zhu
0098baa4cc
confirm that some packages may not have installed paths because we're… (#13105)
https://fleetdm.slack.com/archives/C01EZVBHFHU/p1689371170727919
2023-08-02 16:35:37 -07:00
Mo Zhu
388d6511db
Updated REST API docs to reflect combined schedule and queries (#11742)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Lucas Rodriguez <lucas@fleetdm.com>
2023-07-31 16:05:16 -07:00
Eric
8fb22579ea
Reorganize Fleet documentation (#12871)
Closes: #12611

Changes:
- Added three new documentation sections `/docs/get-started/`,
`/docs/configuration` and `/docs/rest api/`
- Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and
`/docs/deploying` » `/docs/deploy/`
- Moved `/docs/using-fleet/process-events.md` to `/articles` and updated
the meta tags to change it into a guide.
- Added support for a new meta tag: `navSection`. This meta tag is used
to organize pages in the sidebar navigation on fleetdm.com/docs
- Moved `docs/using-fleet/application-security.md` and
`docs/using-fleet/security-audits.md` to the security handbook.
- Moved `docs/deploying/load-testing.md` and
`docs/deploying/debugging.md` to the engineering handbook.
- Moved the following files/folders:
- `docs/using-fleet/configuration-files/` »
`docs/configuration/configuration-files/`
- `docs/deploying/configuration.md` »
`docs/configuration/fleet-server-configuration.md`
    -  `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md`
- `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md`
- Updated filenames:
- `docs/using-fleet/permissions.md` »
`docs/using-fleet/manage-access.md`
- `docs/using-fleet/adding-hosts.md` »
`docs/using-fleet/enroll-hosts.md`
    -  `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md`
- `docs/using-fleet/fleet-ctl-agent-updates.md` »
`docs/using-fleet/update-agents.md`
- `docs/using-fleet/chromeos.md` »
`docs/using-fleet/enroll-chromebooks.md`
- Updated the generated markdown in `server/fleet/gen_activity_doc.go`
and `server/service/osquery_utils/gen_queries_doc.go`
- Updated the navigation sidebar and mobile dropdown links on docs pages
to group pages by their `navSection` meta tag.
- Updated fleetdm.com/docs not to show pages in the `docs/contributing/`
folder in the sidebar navigation
- Added redirects for docs pages that have moved.

.

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-07-27 17:40:01 -05:00