Brimcap Settings -> Packet Captures #3054
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.