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.

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

[Request] Update screenshots for new "Add Fleet Server" button #1979

Closed
kpollich opened this issue Jul 6, 2022 · 4 comments
Closed

[Request] Update screenshots for new "Add Fleet Server" button #1979

kpollich opened this issue Jul 6, 2022 · 4 comments
Assignees
Labels
8.5-candidate Team:Docs Label for the Observability docs team Team:Fleet Label for the Fleet team

Comments

@kpollich
Copy link
Member

kpollich commented Jul 6, 2022

Description

In elastic/kibana#135747, we separated the "Add Agent" flow from the "Add Fleet Server" flow to fix various issues around consistency, UX, and maintainability in Fleet UI.

image

As a result, we have some out of date screenshots in our Fleet/Agent documentation.

I looked through the docs and I've listed the screenshots I found that should be updated below. I'm not sure that is exhaustive, but hopefully it's helpful to start.

I don't know if this is necessarily worth taking on, or what our "standards" are around updating screenshots when UIs are changed like this. The impact of the "Add Fleet Server" button is fairly limited, and it might not even be worth taking this on if there's not much value in updating these screenshots. I figured I'd open an issue either way, but we could easily decide to just close this out if 1:1 accuracy between the live UI and the docs screenshots isn't a high priority in cases like this.

Screenshots to update

Collaboration

  • The docs team will lead producing the content

Contact Person: @kpollich

Suggested Target Release

N/A

Stakeholders

@elastic/fleet

@kpollich kpollich added the Team:Docs Label for the Observability docs team label Jul 6, 2022
@dedemorton
Copy link
Contributor

@kpollich I'm on the fence about this.

It can be time consuming to redo these screen captures, especially if the UI changes are backported (it means we have to redo the screen captures for two different versions). For most of the screens, there is some setup required to populate the screen with meaningful data, so this basically means setting everything up in two different versions and taking all the screen captures.

On the other hand, I think stale screen captures undermine the user's confidence in the docs.

In general, I think we should redo screens for every new release (8.4, 8.5, etc) but not for backported UI changes unless they are significant and likely to confuse users. I also think we should consider removing some of the screens to make the documentation easier to maintain over time. Are there any that you would remove?

@elastic/obs-docs What do you think?

@dedemorton dedemorton self-assigned this Jul 13, 2022
@dedemorton dedemorton added the Team:Fleet Label for the Fleet team label Jul 19, 2022
@dedemorton
Copy link
Contributor

We were not able to contain this work for 8.4 so I am adding as an 8.5 candidate.

@dedemorton dedemorton removed their assignment Sep 28, 2022
@jen-huang
Copy link
Contributor

@dedemorton, I'm going to close this button as we have work coming up (elastic/kibana#137785) that will remove this button again, so no sense in putting the work in here 😇

@jen-huang jen-huang closed this as not planned Won't fix, can't repro, duplicate, stale Sep 29, 2022
@dedemorton
Copy link
Contributor

@jen-huang Sounds good, but please do open a docs issue when you remove the button because we have some task-oriented docs in flight that (I think) talk about that button.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.5-candidate Team:Docs Label for the Observability docs team Team:Fleet Label for the Fleet team
Projects
None yet
Development

No branches or pull requests

3 participants