fleet icon indicating copy to clipboard operation
fleet copied to clipboard

Update "Learn how to use Fleet" for Fleet Sandbox

Open noahtalerman opened this issue 3 years ago • 7 comments

Addresses:

  • #7044

Changes:

  • Update "Learn how to use Fleet" docs page to walk a Fleet Sandbox user through adding their device and running a query
  • Add a "Get operating system information" query to standard query library for the "Learn how to use Fleet" walkthrough
  • Update Fleet's top level README to point users who want to try Fleet to Fleet Sandbox
  • Update "How to install osquery..." (macOS, Windows, Linux) blog posts to point users who want to try Fleet to Fleet Sandbox
  • Move fleetctl preview questions to "Contributing" FAQ section in docs. This is because fleetctl preview is now a testing tool for Fleet contributors
  • Update "Deploying" docs to point users who want to try Fleet to Fleet Sandbox

noahtalerman avatar Aug 10 '22 14:08 noahtalerman

Hey @Desmi-Dizney I added you as a reviewer. Can you please take an editor pass on this PR? Thanks :)

noahtalerman avatar Aug 10 '22 14:08 noahtalerman

Hey @GuillaumeRoss I added you as a reviewer. Can you please take a look at the query I added to the standard query library.

This query will be referenced in the "Learn how to use Fleet" docs.

noahtalerman avatar Aug 10 '22 14:08 noahtalerman

Hey @DominusKelvin I added you as a reviewer. Can you please take a look at the changes I made to the "How to install osquery..." (macOS, Windows, Linux) guides?

I updated these to point users who want to try Fleet to Fleet Sandbox.

noahtalerman avatar Aug 10 '22 14:08 noahtalerman

Hey @DominusKelvin I added you as a reviewer. Can you please take a look at the changes I made to the "How to install osquery..." (macOS, Windows, Linux) guides?

I updated these to point users who want to try Fleet to Fleet Sandbox.

Hey @DominusKelvin I added you as a reviewer. Can you please take a look at the changes I made to the "How to install osquery..." (macOS, Windows, Linux) guides?

I updated these to point users who want to try Fleet to Fleet Sandbox.

Got it. Approved ✅

DominusKelvin avatar Aug 10 '22 15:08 DominusKelvin

@noahtalerman the query is good - but should it also go in the constants file?

GuillaumeRoss avatar Aug 10 '22 17:08 GuillaumeRoss

the query is good - but should it also go in the constants file?

@GuillaumeRoss ah, I don't think there's a constant files for queries (we don't have a list of query templates in the UI). Is there?

There is a constants file for policies.

I'm adding a query, not a policy, in this PR.

noahtalerman avatar Aug 10 '22 20:08 noahtalerman

It's not clear to me what is the expected journey of the reader through this... Can you elaborate on that?

@zhumo definitely. The expected journey starts on fleetdm.com where a Fleet sandbox user signs up for sandbox. Then, the Fleet user sees the Home page in Fleet sandbox:

Screen Shot 2022-08-12 at 2 41 24 PM

The user clicks "Learn how to use Fleet" and is taken to the "Learn how to use Fleet" page in the docs.

This journey can definitely be improved. The goal of these changes is to unblock Fleet sandbox by making the least amount of changes to "Learn how to use Fleet" and other areas of the docs/articles now that Fleet sandbox is the recommended way to try Fleet.

The changes made to docs/articles other than "Learn how to use Fleet" were the result of the following decision:

fleetctl preview is now a tool used by Fleet contributors to test changes to Fleet. This is because Fleet sandbox is the recommended way to try Fleet.

noahtalerman avatar Aug 12 '22 18:08 noahtalerman

I'll coordinate this getting used in Sandbox once its merged alongside @rfairburn. Just letting you know its on my radar and that I'll need to do stuff to get it out there.

zwinnerman-fleetdm avatar Aug 15 '22 13:08 zwinnerman-fleetdm

Just letting you know its on my radar and that I'll need to do stuff to get it out there.

@zwinnerman-fleetdm can you help me understand what you'll need to do?

This PR should only contain changes to markdown files (articles, docs, and proposals).

noahtalerman avatar Aug 15 '22 19:08 noahtalerman

Just letting you know its on my radar and that I'll need to do stuff to get it out there.

@zwinnerman-fleetdm can you help me understand what you'll need to do?

This PR should only contain changes to markdown files (articles, docs, and proposals).

Oh ok, then I won't need to do anything lol sorry about that.

zwinnerman-fleetdm avatar Aug 15 '22 20:08 zwinnerman-fleetdm

No worries! Sorry for the confusion.

noahtalerman avatar Aug 15 '22 20:08 noahtalerman