fleet icon indicating copy to clipboard operation
fleet copied to clipboard

Request: Update get started guides

Open Drew-P-drawers opened this issue 1 year ago • 7 comments

GOAL:

As a visitor to Fleet's website, I'd like to check out the tutorials and guides page in the docs and see a list that's a bit easier to understand at first glance so that I can feel confident diving into Fleet.

CONTEXT:

Currently when you visit the page, there's an extremely long list of guides. We previously ranked them on what we thought would be the most important guides from top to bottom. image.png

I'm proposing that we break up the list to something like: image.png

Drew-P-drawers avatar Jan 22 '25 16:01 Drew-P-drawers

Thanks, @Drew-P-drawers. I know what you mean. I'll run this past CS team because I think this list was curated by order of operation regarding onboarding new users. cc @zayhanlon

mike-j-thomas avatar Jan 22 '25 23:01 mike-j-thomas

@Drew-P-drawers for some reason i can't see the images you've attached for what your proposed layout is - can you add again?

zayhanlon avatar Jan 22 '25 23:01 zayhanlon

@Drew-P-drawers for some reason i can't see the images you've attached for what your proposed layout is - can you add again?

Might need to view on Zenhub, I'll try to attach to the regular github issue real quick

Drew-P-drawers avatar Jan 22 '25 23:01 Drew-P-drawers

Image Image

Drew-P-drawers avatar Jan 22 '25 23:01 Drew-P-drawers

Also, the image I provided just served a visual purpose. I might've messed up the order as I was just inspecting the page 😅 @zayhanlon @mike-j-thomas

Realistically, we could just make the comments on the page h3 tags.

Deploying Fleet

Highest level organizational unit (Change this to "Getting familiar" or "Understanding Fleet")

Controls

Installing software

Admin

Drew-P-drawers avatar Jan 22 '25 23:01 Drew-P-drawers

Here's the code from the docs page:

# Tutorials and guides

A collection of guides to help you with Fleet.

<!--Deploying Fleet-->
- [Deploy Fleet](https://fleetdm.com/docs/deploy)
- [MDM migration](https://fleetdm.com/guides/mdm-migration)
- [macOS MDM setup](https://fleetdm.com/guides/macos-mdm-setup)
- [Windows MDM setup](https://fleetdm.com/guides/windows-mdm-setup)
<!--Highest level organizational unit-->
- [Teams](https://fleetdm.com/guides/teams)
- [Enroll hosts](https://fleetdm.com/guides/enroll-hosts)
- [Enroll BYOD iOS/iPadOS hosts](https://fleetdm.com/guides/enroll-byod-ios-ipados-hosts)
- [Queries](https://fleetdm.com/guides/queries)
- [Labels](https://fleetdm.com/guides/managing-labels-in-fleet)
- [Policies](https://fleetdm.com/securing/what-are-fleet-policies)
<!--Controls-->
- [Enforce OS updates](https://fleetdm.com/guides/enforce-os-updates)
- [Enforce disk encryption](https://fleetdm.com/guides/enforce-disk-encryption)
- [Custom OS settings](https://fleetdm.com/guides/custom-os-settings)
- [Automatically run scripts](https://fleetdm.com/guides/policy-automation-run-script)
<!--Installing software-->
- [Fleet-maintained apps](https://fleetdm.com/guides/install-fleet-maintained-apps-on-macos-hosts)
- [Deploy software](https://fleetdm.com/guides/deploy-software-packages)
- [Automatically install software](https://fleetdm.com/guides/automatic-software-install-in-fleet)
- [Install App Store (VPP) apps](https://fleetdm.com/guides/install-vpp-apps-on-macos-using-fleet)
<!--Admin-->
- [Fleetctl](https://fleetdm.com/guides/fleetctl)
- [Fleetd updates](https://fleetdm.com/guides/fleetd-updates)
- [How to uninstall Fleet's agent (fleetd)](https://fleetdm.com/guides/how-to-uninstall-fleetd)
- [How to configure logging destinations](https://fleetdm.com/guides/how-to-configure-logging-destinations)  


<a style="text-decoration: none;" href="https://fleetdm.com/guides"><animated-arrow-button>See all guides</animated-arrow-button></a>

<meta name="description" value="Links to deployment tutorials and guides for using Fleet.">
<meta name="pageOrderInSection" value="300">

Drew-P-drawers avatar Jan 22 '25 23:01 Drew-P-drawers

@nonpunctual, I found this issue in the "Not yet" pile. We can reshape the user story here to explore what you and @jmwatts discussed regarding tailored get-started journeys for different personas.

Please share more context about that here when you have time so I can look into it as soon as this is prioritized.

mike-j-thomas avatar Apr 11 '25 02:04 mike-j-thomas

@mike-j-thomas

  • The idea discussed with @jmwatts was basically:

what are the entry points for anyone new to the product?

e.g.,

  • A macOS admin
    • that is migratiing from a previous MDM
    • that is deploying Macs in the org for the 1st time
  • A macOS admin with a few Windows / Linux devices
  • A Windows admin
  • A Linux admin
  • Any of the above with mobile devices
  • A pure endpointOps / Orch user alongdside other MDM solutions

I don't know if this list make any sense but this was the idea. The current docs really only allow these use cases to be defined by the negative space around them. What do I mean by this?

Kinds of questions people have after reading our docs for the 1st time with intent to use Fleet:

  • How do I set it up?
    • Can it be self-hosted
    • How do I talk to someone at Fleet to set it up for me?
  • Do I need to install fleetctl on every Host to create or deploy the enrollment package?
    • Does this mean I need to install Docker on every device?
    • Why are the depedency requirements for fleetctl on Windows different than for Mac fleetctl?
    • Why do I have to install wine / wix to create Windows enrollment packages on my Mac?
  • Can I use Apple Business / School Manager with Fleet?
    • How do I install the APNS certificate?
    • How do I create & install the token?
  • Can I use Windows automated deployment / autopilot?
    • Do I need Windows licenses to enroll Windows devices in Fleet?
    • Is there a way for me to install the Windows WSTEP certificate needed for MDM myself?
  • If I enable MDM features, are those on for every Host or can I assign MDM features only to certain platforms / devices?
  • Can I migrate from my current MDM with no user interaction?
    • Is this process manual for my endpoint eng team / help desk?
    • Why can't I migrate easily?
  • Is Fleet really cross-platform?
    • Are all features available for all platforms?
  • How do I make controls for Hosts to secure them?
    • for macOS
    • for Win
    • for Linux
  • Do I need to know SQL to use Fleet to automate things?
  • Can I use scripts without enabling MDM features?
  • Can I install software without enabling MDM features?
  • Which features are premium features?

I could go on. Also, what I might encourage or just pop into a random channel (or we could even have a meeting dedicated to it) is getting more of these questions from people that interact with new customers & prospects (so, Allen, Harrison, Dale, me, all of CS team, all of QA team, anyone in eng who has dealt with a customer, so basically, everyone at Fleet... etc.)

If we had this list of questions, & if we felt it was as exhaustive as possible, we could begin to define these entry points (I don't want to call them personas because that's a marketing thing & might lead us the wrong way for this.) There is currently A LOT of friction at many of these entry points, some more than others.

In my opinion, the goal of this project is to create a choose your own adventure book from the docs we have.

So the analogy is: there is a 3 ring binder & it was opened in the wind & all of its contents are a bit scattered & we are going to put it back in the 3 ring binder with new tabs & pathways through it all.

nonpunctual avatar Apr 11 '25 14:04 nonpunctual

@mike-j-thomas can this / should this be moved to the confidential repo rather than public? @Drew-P-drawers @zayhanlon

nonpunctual avatar Apr 11 '25 14:04 nonpunctual