Commit graph

1518 commits

Author SHA1 Message Date
Pratham
9ec2efb979
docs/MDM-Windows-setup: fixup environment variable (#14593)
The correct variable to use seems to be `FLEET_DEV_MDM_ENABLED`,
`FLEET_MDM_WINDOWS_ENABLED_AND_CONFIGURED` is not present in the
codebase
2023-10-17 21:43:41 -05:00
Mike Thomas
82534168d9
Updated grammar and typos on FAQ.md (#14587)
I was in this file and got sucked into fixing up a bunch of typos and
grammar issues. (I just had to clear all the Grammarly red marks 😵‍💫)

- Added missing punctuation
- Removed unnecessary punctuation
- Fixed some typos
- Hypenated some compound adjectives 
- Removed some unnecessary hyphens

.
2023-10-16 23:36:23 -05:00
Rachael Shaw
10ed97e570
Docs: API changes for #7766 (#13484)
Draft PR to show API changes for #7766

#13469

---------

Co-authored-by: Lucas Rodriguez <lucas@fleetdm.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-10-16 23:34:32 -05:00
Lucas Amorim
637430f442
Fixing typo on the proxies page (#14576)
Fixing typos - replacing capital case with lower case.

Removed all the checklist because it doesn't apply to changes in the
documentation....
...
...

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com>
2023-10-16 21:03:10 -05:00
Mike Thomas
37cacac1d8
Update to "Can you host Fleet for me?" in FAQ.md (#14585)
I added a link to the license dispenser in the "Can you host Fleet for
me?" section.

# Checklist for submitter
- [x] Manual QA for all new/changed functionality
2023-10-16 17:24:23 -05:00
Noah Talerman
fb64a9ee73
Configuration reference docs: WSTEP cert/key (#14567)
- Inform user that they will have to turn disk encryption on/off again
if they change their WSTEP cert/key pair
2023-10-16 18:08:07 -04:00
Gabriel Hernandez
db580e4eba
update broken link for mdm macOS setup assistant docs (#14530)
fix broken link for mdm macos setup docs
2023-10-16 17:03:48 -05:00
Rachael Shaw
283e694e06
Fix link formatting (#14541)
Fixed markdown syntax for links in a couple places where it was
formatted incorrectly (`(…)[…]` instead of `[…](…)`)

(Fixed one earlier and just searched the docs folder for `)[` to find
these; hopefully this PR nabs the rest.)
2023-10-16 16:52:58 -05:00
Luke Heath
1b428aff94
Fix typo on MDM-Windows-setup.md (#14552)
......
2023-10-16 16:52:28 -05:00
Lucas Manuel Rodriguez
87e2cfca71
Add query report to manage-access.md (#14542)
Adding the permissions docs change for #7766.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-16 14:18:42 -03:00
Rachael Shaw
8f4ae0c50a
Small formatting fix (#14553)
Added some missing backticks where we had a larger-than-intended block
of text highlighted as code.
2023-10-14 17:03:04 -05:00
Tim Lee
148386e956
Docs: Query Report API (#14204) 2023-10-12 14:17:41 -06:00
Rachael Shaw
8bbdadfb42
Fix link formatting in "Get a list of Visual Studio Code extensions" query (#14512)
Fixed link formatting in "Get a list of Visual Studio Code extensions"
query
2023-10-12 14:44:11 -05:00
Noah Talerman
e89a919d06
Docs: Update SCEP configuration (#14234)
- Update configuration docs to clarify this and what the workaround is
if changing the cert/key is necessary (due to compromise)
- Remove words from macOS setup docs
2023-10-12 11:27:49 -04:00
Rachael Shaw
1cc6df9705
REST API docs: Fix some formatting issues (#14480)
Fixed capitalization/formatting for a few inconsistent headings I
noticed.
2023-10-11 17:48:15 -05:00
Rachael Shaw
d8aaa4e9fc
Docs: Update REST API docs for "Run automation for all failing hosts of a policy" endpoint (#13630)
+ Fixed capitalization in title
+ Shortened description, and instead linked to relevant conceptual
documentation to clarify default policy automation behavior
+ Updated parameter descriptions (and listed premium feature last)
2023-10-11 16:49:45 -05:00
Katheryn Satterlee
4c677e9a06
Update Deploy-Fleet-on-CentOS.md (#14263)
Corrected the name of the target archive for download and instructions
for accessing the Fleet binary.

# Checklist for submitter

Docs-only change
2023-10-10 23:15:42 -05:00
Mike Thomas
2e5cafba83
Fixed broken links in fleet-server-configuration.md (#14313)
fixed two broken links:

https://fleetdm.com/docs/deploy/single-sign-on-sso 
https://fleetdm.com/docs/deploy/public-ip
2023-10-11 08:01:50 +09:00
Roberto Dip
9ffa11c25d
Feat: saved scripts (#14409)
For #9537
2023-10-10 19:00:45 -03:00
Marko Lisica
8035fc7511
Normalize ".mobileconfig" and "team ID" in API docs (#14405)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2023-10-10 13:10:24 -05:00
pintomi1989
b42a8b2049
docs: Removal of the "the" (#14382)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2023-10-10 13:07:34 -05:00
Marcos Oviedo
f0d77ab3db
Merging Bitlocker feature branch (#14350)
This relates to #12577

---------

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Roberto Dip <dip.jesusr@gmail.com>
2023-10-06 19:04:33 -03:00
Rachael Shaw
cc547ba02c
Remove list of Windows CIS policies that require a Group Policy template (#14352)
This change is to reduce surface area of the conceptual docs. We already
point users toward how to identify the policies that need a Group Policy
template:

> These items are tagged with the label
`CIS_group_policy_template_required` in the YAML file, and details about
the required Group Policy templates can be found in each item's
`resolution`.

Keeping a duplicate list here is just more surface area to maintain, aka
more content that's likely to get out-of date. (And since it's in a code
block anyway, it's not any easier to read here than by just referencing
the YAML file directly, so the user experience won't suffer from us
removing it.)
2023-10-06 12:42:19 -05:00
Eric
e7ac6d8281
Docs: Update fleetd link on anatomy page. (#14344)
closes: https://github.com/fleetdm/fleet/issues/14338
2023-10-06 11:45:27 -05:00
Rachael Shaw
d029d3f928
Docs: Add version range to "List all software" example response (#13647)
Proposed API changes for https://github.com/fleetdm/fleet/issues/11666

---------

Co-authored-by: Tim Lee <timlee@fleetdm.com>
2023-10-05 13:51:16 -05:00
Roberto Dip
1a6b1038dd
add docs for detail query overrides (#14299)
docs for https://github.com/fleetdm/fleet/pull/14296

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-05 14:23:13 -03:00
Noah Talerman
a40db25281
Scripts docs: Fix typo (#14300)
- Fix incorrect flag
2023-10-04 16:16:18 -04:00
Noah Talerman
9c7079f50c
Windows MDM docs: turn on Windows MDM (#13943)
- Add new "Windows setup" page to "Device Management" section of docs
- Rename "MDM setup"  page to "macOS setup." Update links and add redirect
- Rename existing "macOS setup" page to "macOS setup experience." Update links. Did not add redirect because of conflict with "macOS setup" page
- Remove "MDM" from all MDM doc page titles
2023-10-04 15:39:09 -04:00
Mo Zhu
6c5edd3ddd
Link to usage statistics config from usage statistics page (#14207)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-03 17:34:46 -04:00
Mo Zhu
606e1560e0
document that vscode extension query requires fleetd (#14221) 2023-10-03 11:28:54 -04:00
Katheryn Satterlee
fce53bba9a
Update CIS-Benchmarks.md (#14242)
Add additional information about passing/failing CIS benchmark policies

# Checklist for submitter

Doc-only change
2023-10-02 13:49:58 -04:00
Sabrina Coy
90e7f2043a
Fix broken link in #macos0setuo-assistant (#14233)
Link for Fleet's example ADE profile incorrectly points to a profile
called `setup_assistant.json`. The correct profile is
`automatic_enrollment.json`. Link is corrected in the PR.
2023-10-02 11:59:22 -04:00
Sharon Katz
630466c687
#13886 chrome ext doc (#13902)
Co-authored-by: Mo Zhu <mo@fleetdm.com>
Co-authored-by: Mo Zhu <mozhu888@gmail.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-02 09:24:33 -04:00
Mike McNeil
0604d529df
Handbook: Explai the deal w/ hosting small Fleet instances (#14103) 2023-10-01 18:01:24 -05:00
Mike McNeil
e7dd92105e
Docs: Encourage using page over after (#14115)
Shout out to @tdiderich for pointing out this improvement.
2023-10-01 17:59:30 -05:00
Katheryn Satterlee
8852709d6e
Update messaging for contributor API (#13494)
Added additional information about what differentiates the Contributor
API routes from the public API routes.

# Checklist for submitter

Docs-only change
2023-09-29 17:03:29 -05:00
Eric
9891861e58
Website: Improve support for indented content in Markdown lists, update MDM macOS setup docs page. (#14124)
Closes: #12836 

Changes:
- Updated the `build-static-content` script to not add HTML comments to
Markdown codeblocks, and to not replace HTML comments in generated HTML
pages
- Updated the custom codeblock renderer in the `to-html` helper to add
syntax highlighting classes to Markdown codeblocks.
- Updated the indentation of content in lists on the MDM macOS setup
docs page.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-09-29 13:13:03 -07:00
Lucas Manuel Rodriguez
e1333c113f
[Hackathon] Add query to list VSCode extensions for macOS (#14213)
Co-authored-by: Sharon Katz <121527325+sharon-fdm@users.noreply.github.com>
2023-09-29 15:21:28 -04:00
Dave Herder
5696d4875b
Update Deploy-Fleet-on-Kubernetes.md (#14155)
added clarification on running Helm commands in v2 vs v3

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-29 11:15:44 -07:00
Tyler Diderich
878e16269b
Update Deploy-Fleet-on-CentOS.md (#14198)
Minor docs update
2023-09-29 10:24:08 -05:00
RachelElysia
86daf97425
Fleet CTL: Surface password requirements to console for FleetCTL use, update API only password example (#14171) 2023-09-28 11:21:25 -07:00
Noah Talerman
00e71761c5
Update supported Windows versions (#14188)
- Clarify that Fleet supports Windows 10+ for "Pro" and "Enterprise."
Not "Home"
2023-09-28 12:59:18 -04:00
Dave Herder
4a514311dd
Update rest-api.md (#14129) 2023-09-27 15:53:04 -07:00
Dave Herder
b50cbef42c
Update FAQ.md - remove Software Inventory instructions (#14153) 2023-09-27 15:47:57 -07:00
Mo Zhu
9d2c3f0870
Update Reference-Architectures.md (#14039)
Purpose of this change:
- Right now we don't have a guide for deploying on Azure. We want to
prompt people to ask for it by linking them to the Slack. That is a way
that we can kick off the process of writing a formal document.
2023-09-27 08:19:31 -07:00
Mo Zhu
f65d574955
state that CIS benchmark policy is tagged as level 1 and level 2 (#14156) 2023-09-26 16:12:32 -07:00
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
Isabell Reedy
14d0df0f85
Specify that enroll secrets should be alphanumeric (#14030) 2023-09-26 14:38:35 -04: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