Commit graph

52 commits

Author SHA1 Message Date
Mike Thomas
2171544ad1
Docs quick reference optimization (#21331)
This PR closes https://github.com/fleetdm/fleet/issues/21108

@noahtalerman, I double-checked all redirects, and they are working.
Clicking through the URLs in [this
spreadsheet](https://docs.google.com/spreadsheets/d/1djVynIMuJK4pT5ziJW12CluVqcaoxxnCLaBO3VXfAt4/edit?usp=sharing)
is a pretty quick way to go through them all. Note that "Audit logs" and
"Understanding host vitals" redirect to the contributor docs on GitHub,
so they will throw a 404 until this is merged.

Some new guides benefitted from a name change, so they make more sense
as stand-alone guides, and also so that we don't have to mess around
with more redirects later. Those name changes followed [this
convention](https://fleetdm.com/handbook/company/communications#headings-and-titles),
which was recently documented in the handbook.

Have fun!

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
2024-08-16 15:30:31 -05:00
Lucas Manuel Rodriguez
68ea52a764
Update docs: minimum Aurora version supported (#21130)
From https://github.com/fleetdm/fleet/pull/20225#discussion_r1702942048
2024-08-07 19:01:39 -03:00
Mike Thomas
e488a26dc7
Update tutorials-and-guides.md (#21078)
I have updated the list of tutorials and guides in the docs.

Although the brief stated the cut down the list to only the top 10,
@nonpunctual and I whittled the list down to curate the top 20 guides
that we believe are relevant to users who are deploying and setting up
Fleet. We listed them in order of operation as much as possible.

Closes https://github.com/fleetdm/confidential/issues/7343
2024-08-07 07:56:13 +09:00
Eric
1517b285ec
Docs: Add fleetdm.com/guides link to tutorials-and-guides docs page. (#21026)
Related to: https://github.com/fleetdm/confidential/issues/7343

Changes:
- Added a fleetdm.com/guides link to the tutorials and guides docs page.
2024-08-02 18:35:23 -05:00
Grant Bilstad
ad9e93020e
Update FAQ Deploying section (#20669)
Updating FAQ section with new deploy information.
2024-07-23 15:17:47 -06:00
Dante Catalfamo
5e1a3d03ae
MySQL 8.0 Migration (#20225)
#17249
2024-07-22 16:27:36 -04:00
Mike Thomas
c5657016c6
Update FAQ.md (#20492)
Added a comment to let folks know why a bunch of questions are hidden.
Closes https://github.com/fleetdm/confidential/issues/7109

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-07-17 16:26:15 -05:00
Zach Wasserman
b2dec6de57
Fix anchor link for agent uninstall (#19937)
For #19936

# Checklist for submitter

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

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Manual QA for all new/changed functionality
2024-06-25 13:06:03 -07:00
Dave Herder
2db2b4ede1
policies doc glue-up (#19389)
Feedback from prospect-redwine was that this page required more depth on
policies. We have documentation around policies, this PR is to add
linking and to glue the topics together.

---------

Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: JD <spokanemac@users.noreply.github.com>
2024-06-03 10:55:10 -07:00
Mike Thomas
21b1aac24f
Update why-fleet.md (#19064)
Removed the following sections to make way for the [new docs
CTA](https://github.com/fleetdm/fleet/pull/19062):

- What's next
- Try it out
2024-05-17 08:07:17 +09:00
Rachael Shaw
7cfb7721b3
FAQ: Add doc link to "How do I contact Fleet for support?" (#18654)
Add doc link to "How do I contact Fleet for support?"
2024-04-30 15:21:32 -05:00
Rachael Shaw
2e2137129a
Simplify "Is Fleet MIT licensed?" answer (#18653)
Simplify the language in "Is Fleet MIT licensed?"
2024-04-30 15:09:59 -05:00
Rachael Shaw
895d4bc2f7
Use "Fleet's agent (fleetd)" naming in the docs (#18138)
For #16512

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-04-29 11:12:03 -05:00
Rachael Shaw
63d91526d2
A few capitalization fixes in the docs (#18416)
Sentence-casing.
2024-04-18 16:45:55 -05:00
George Karr
b0bb2e6ab5
Update FAQ.md (#17707)
This instructions were inaccurate following these steps only `Fleet
Osquery` was installed not `orbit`

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-30 02:33:41 -05:00
Gabriel Hernandez
32f4465a40
update Orbit docs url (#17077)
updated URL for orbit docs. The previous location forwarded to
https://fleetdm.com/docs/using-fleet/enroll-hosts and did not give info
about Orbit.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-26 17:13:25 +00:00
Luke Heath
e74b7b9201
Add Fleetd Chrome Extension to anatomy docs (#16762) 2024-02-16 09:14:00 -06:00
Eric
5c7574964f
Website: Update confusing/outdated links. (#16522)
Closes: #16451

Changes:
- Updated the "spin up for yourself" link in the FAQ to go to the
deploying docs.
- Updated the custom idp integration card link to go to the IDP
configuration section of the SSO docs page.
2024-02-07 16:56:33 -06:00
RachelElysia
f076769ee2
Documentation: Spelling and grammar fixes (#16403)
---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-06 09:19:42 -05:00
Mike Thomas
17f0a4e28e
Update tutorials-and-guides.md (#16158)
typo fix
2024-01-17 15:32:48 -06:00
Noah Talerman
5f38355169
Merge fleetd doc page to enroll hosts page (#15907)
- Move relevant content from "Fleetd" doc page to "Enroll hosts" page
- Remove "Fleetd" docs page
2024-01-10 14:35:18 -05:00
Eric
a5065554b4
Docs: Uncomment FAQ question (#15639)
https://github.com/fleetdm/confidential/issues/4673

Changes:
- Moved the "How can I uninstall the osquery agent?" question out of the
commented-out block on the FAQ docs page.
2023-12-15 10:06:55 -06:00
Mike McNeil
15dbc1b3af
Update FAQ.md (#14951)
Does this get folks to the right place?  The other link was broken
2023-11-06 12:34:56 +09:00
Mike McNeil
88e7cd243d
Fix fleetdm.com/docs (#14950)
caused by a typo introduced during a live @mike-j-thomas + Mike M
product marketing session on Zoom:
22af47aa92 (r131737251)
2023-11-05 00:47:14 -05:00
Mike McNeil
6d029cf2a4
Docs: Update FAQ.md (#14948) 2023-11-05 00:20:20 -05:00
Mike Thomas
22af47aa92
Update heading position on why-fleet.md (#14884)
I moved the "What's it for?" heading. After seeing it on the site
(rather than Markdown) I feel that placing it between the new paragraphs
disrupts the message.

I also addressed some grammar and formatting issues. Removed some
redundant words and rephrased a couple of sentences to give a more
personable tone.

### Original

<img width="541" alt="image"
src="https://github.com/fleetdm/fleet/assets/78363703/1e67d9f2-4912-43db-846e-1f9b8d5803f6">

### vs this PR

<img width="741" alt="image"
src="https://github.com/fleetdm/fleet/assets/78363703/4a362eec-f871-4612-a46e-1fbdfe72f21e">
2023-11-04 22:50:00 -05:00
Katheryn Satterlee
62d758762a
Fix broken link to configuration documentation (#14292) 2023-11-03 13:26:03 -05:00
Isabell Reedy
95bcc0c80e
Docs: how the product sets the name attribute of the scheduled query (#14307)
@ksatter I haven't included an example of the audit logs because we
already have it elsewhere in the docs, so have just linked.

Reference: #13646 & #13648

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2023-11-02 14:57:42 -05:00
Mike Thomas
5fc79b8e23
Update FAQ.md (#14844)
Fixed heading from h3 to h2.
2023-11-01 21:37:57 -05:00
Mike Thomas
9363bfd302
Update why-fleet.md (#14819)
Changes:

- Added "Why Fleet" section to incorporate Fleet's point of view.
- Updated the "What's it for" section
- Lit up some useful links
- Updated some out-of-date links

.
2023-11-01 21:36:37 -05:00
Mike McNeil
a3399984e1
Docs: Update FAQ.md (#14818) 2023-10-31 04:11:32 -05:00
Mike Thomas
9c6003dc12
FAQ update (#14813)
Closes https://github.com/fleetdm/fleet/issues/14814

Changes:

- moved the FAQs from the pricing page to the FAQs in the docs. The
theory is that these questions are a long way down the page and likely
being missed.
- Added five more questions and answers to the FAQ from questions that
come up during customer calls.
- Commented out existing questions. Some are out of date, and some have
been dumped into the FAQ for lack of a better place to put them. We will
continue to add to this list with stronger content from talking with
users and customers.
- added a link to the FAQ on the pricing page.
2023-10-31 00:32:48 -05:00
Roberto Dip
5dfc72b2a1
allow to use --context in fleetctl mdm run-command (#14665)
for #13712
2023-10-26 19:09:31 -03: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
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
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
Mike McNeil
0604d529df
Handbook: Explai the deal w/ hosting small Fleet instances (#14103) 2023-10-01 18:01:24 -05:00
Dave Herder
b50cbef42c
Update FAQ.md - remove Software Inventory instructions (#14153) 2023-09-27 15:47:57 -07: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
George Karr
845bd6eef1
Update FAQ.md fix typo (#13828)
there is no `--osquery-channel` it's `--osqueryd-channel`
2023-09-13 12:50:51 -05:00
Dave Herder
38c31d536d
Update FAQ.md (#13713)
Added documentation about using fleetctl with context and mdm commands

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-12 15:35:35 -07:00
Andrew Baker
ba25c5ef43
Update FAQ.md (#13529)
# 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-08-25 17:37:49 -04:00
Martin Angers
4045116fac
Add orbit notification and API endpoints to send/receive scripts to hosts (part 2 of ticket) (#13447) 2023-08-23 16:47:47 -04:00
Isabell Reedy
9d99b7fb05
Documentation: Modifying built-in labels with fleetctl or REST API (#13302)
Documenting closed bug: modifying built-in labels with fleetctl or REST
API causes UI errors (#12479)
2023-08-22 20:47:56 -07:00
Mo Zhu
cc14de012d
4.35 upgrade notes (#13392)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-21 13:30:56 -07:00
Eric
ba6dc0b524
Docs: Update tutorials and guides page (#13379)
Closes: #13126
2023-08-18 14:04:33 -05:00
Noah Talerman
a36cb76733
MDM docs: Add end user migration workflow (#13261)
- Add instructions for setting up end user migration workflow
- Break out a separate section to default migration workflow for
automatically enrolled (DEP hosts)
- Break out separate end user instructions for manually enrolled hosts,
automatically enrolled hosts - default migration workflow, and
automatically enrolled hosts - end user migration workflow.
2023-08-15 22:32:46 -04:00
Rachael Shaw
c5ce89f546
Docs: Update FAQ section about the "Packs" UI (#13194)
Update FAQ answer to better align with [more recent content about
packs](https://fleetdm.com/handbook/company/why-this-way#why-does-fleet-support-query-packs).
2023-08-09 11:57:00 -07:00
Martin Angers
37ba43d404
Add fleetctl upgrade-packs command to migrate 2017 packs to queries (#13078) 2023-08-08 08:21:57 -04:00
Eric
3a9d80b6a3
Docs: Update content on tutorials and guides documentation page (#13131)
Changes:
- Added links to guides to the tutorials and guides page.
2023-08-03 16:57:59 -05:00