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

Brimcap Settings -> Packet Captures #3054

Merged
merged 2 commits into from
Apr 23, 2024
Merged

Brimcap Settings -> Packet Captures #3054

merged 2 commits into from
Apr 23, 2024

Conversation

philrz
Copy link
Contributor

@philrz philrz commented Apr 22, 2024

In thinking about documenting some recent enhancements, I'm sensing that we can improve on the title of the section of settings currently called Brimcap Settings. Thinking about it through the eyes of a new Zui user, "Brimcap" is the name of a tool that delivers a subset of functionality surfaced in Zui, but that's effectively an implementation detail and not something we'd expect a new Zui user to know right out of the gate, nor do I think educating users about "What is Brimcap?" should be a cost of entry. Instead I imagine a new user that's heard of Zui for the pcap-centric use cases would benefit more from a section title that mentions them by name, so that's what I'm proposing here. Once they land in that section, I feel no shame about calling out Brimcap, e.g., for the Brimcap YAML Config File setting, because they certainly do need to go off and learn "What is Brimcap?" if they want to start making use of that setting (hence the"docs" link).

After I initially proposed "pcap Settings", @jameskerr countered with the better idea of saying "Packet Captures" so we can lead with a capital letter and drop the redundant use of the word "Settings", so that's what I've done here.

image

@philrz philrz requested a review from jameskerr April 22, 2024 16:25
@philrz philrz self-assigned this Apr 22, 2024
@jameskerr
Copy link
Member

jameskerr commented Apr 22, 2024

I think we can drop the word "settings" since the title of the modal says that. I would prefer the first letter to be a capital inline with the other sections. All caps is a bit much though.

"Pcaps" or "Packets" or "Packet Captures" would work for me.

@philrz philrz changed the title Brimcap Settings -> pcap Settings Brimcap Settings -> Packet Captures Apr 22, 2024
@philrz
Copy link
Contributor Author

philrz commented Apr 22, 2024

@jameskerr: Thanks for the good counter-proposals. I've pushed a commit to go with "Packet Captures".

Copy link
Member

@jameskerr jameskerr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better. Thanks!

@philrz philrz merged commit 54183c6 into main Apr 23, 2024
3 checks passed
@philrz philrz deleted the pcap-settings branch April 23, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants