Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use "Fleet's agent (fleetd)" naming in the docs and product #16512

Closed
7 tasks
noahtalerman opened this issue Jan 31, 2024 · 5 comments
Closed
7 tasks

Use "Fleet's agent (fleetd)" naming in the docs and product #16512

noahtalerman opened this issue Jan 31, 2024 · 5 comments
Assignees
@rachaelshaw
Labels
:improve documentation Involves writing improvements or additions to documentation :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature

Comments

@noahtalerman
Copy link
Member

noahtalerman commented Jan 31, 2024 •
edited by rachaelshaw

Goal

User story
As a Fleet user,
I want to see the "Fleet's agent (fleetd)" used to describe Fleet's agent in the documentation and product
so that I'm not confused by other names such as "Fleet's osquery installer," "Orbit," "osquery agent".

Changes

Product

Engineering

  • Database schema migrations: TODO
  • Load testing: TODO

ℹ️  Please read this issue carefully and understand it. Pay special attention to UI wireframes, especially "dev notes".

Context

  • Requestor(s): _________________________

QA

Risk assessment

  • Requires load testing: TODO
  • Risk level: Low / High TODO
  • Risk description: TODO

Manual testing steps

  1. Step 1
  2. Step 2
  3. Step 3

Testing notes

Confirmation

  1. Engineer (@____): Added comment to user story confirming successful completion of QA.
  2. QA (@____): Added comment to user story confirming successful completion of QA.
@noahtalerman noahtalerman added the ~feature fest Will be reviewed at next Feature Fest label Jan 31, 2024
@noahtalerman noahtalerman mentioned this issue Jan 31, 2024
Closed
11 tasks
@noahtalerman noahtalerman added the :improve documentation Involves writing improvements or additions to documentation label Feb 15, 2024
@noahtalerman
Copy link
Member Author

Kathy: This can apply to the output and name of the package when running fleetctl package.

Rachael: We updated some error messages but may need to revisit the fleetctl package output.

@noahtalerman noahtalerman added :product Product Design department (shows up on 🦢 Drafting board) :improve documentation Involves writing improvements or additions to documentation story A user story defining an entire feature and removed :improve documentation Involves writing improvements or additions to documentation ~feature fest Will be reviewed at next Feature Fest labels Feb 16, 2024
@noahtalerman noahtalerman changed the title Use consistent name for Fleet's agent in docs and product Use "Fleet's agent (fleetd)" naming in the docs and product Feb 19, 2024
@noahtalerman
Copy link
Member Author

Original issue description from @noahtalerman:

Problem

In the docs and the Fleet product we call Fleet's agent by a lot of different names:

  • Fleet's osquery installer
  • fleetd
  • fleetd install
  • osquery agent

As a user it's confusing that the agent if called so many different things.

Take a pass through the docs and dialog when running fleetctl package.

Potential solutions

Use "fleetd agent." We use this most internally and users/customers are adopting it

@noahtalerman noahtalerman added ~feature fest Will be reviewed at next Feature Fest and removed :product Product Design department (shows up on 🦢 Drafting board) labels Mar 28, 2024
@noahtalerman
Copy link
Member Author

Heads up, we didn't get to this estimated in the last design sprint.

Bringing it back to feature fest.

@noahtalerman noahtalerman added :product Product Design department (shows up on 🦢 Drafting board) and removed ~feature fest Will be reviewed at next Feature Fest labels Mar 29, 2024
This was referenced Apr 8, 2024
Merged
Merged
@noahtalerman
Copy link
Member Author

Noah: We won't bring this one through an engineering sprint. We'll merge the PRs to the frontend and docs.

This was referenced Apr 24, 2024
Closed
Merged
rachaelshaw added a commit that referenced this issue Apr 25, 2024
@rachaelshaw
Use "Fleet's agent (fleetd)" naming in the CLI (#18528)
0ccc7f6 
For #16512
rachaelshaw added a commit that referenced this issue Apr 25, 2024
@rachaelshaw @noahtalerman
Use "Fleet's agent (fleetd)" naming in the UI (#18238)
2c9978e 
For #16512

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
@rachaelshaw rachaelshaw mentioned this issue Apr 25, 2024
Merged
rachaelshaw added a commit that referenced this issue Apr 26, 2024
@rachaelshaw
Update fleetctl package usage description (#18545)
8bcdd93 
Slight verbiage change requested by @noahtalerman re: #16512
rachaelshaw added a commit that referenced this issue Apr 29, 2024
@rachaelshaw @eashaw
Use "Fleet's agent (fleetd)" naming in the docs (#18138)
895d4bc 
For #16512

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
@fleet-release
Copy link
Contributor

Unified in name,
Fleet's agent guides, no strain,
Docs clear, no more pain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rachaelshaw rachaelshaw

Labels
:improve documentation Involves writing improvements or additions to documentation :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rachaelshaw @noahtalerman @fleet-release