kafbat/kafka-ui

Docs: Improve filters documentation

Open

#241 opened on Mar 22, 2024

View on GitHubContributor guide
 (5 comments) (8 reactions) (1 assignee)TypeScript (363 forks)auto 404
good first issuehacktoberfestimpact/documentationstatus/triage/completedtype/chore

Repository metrics

Stars
 (2,554 stars)
PR merge metrics
 (PR metrics pending)

Description

Issue submitter TODO list

  • I've searched for an already existing issues here
  • I'm running a supported version of the application which is listed here and the feature is not present there

Is your proposal related to a problem?

No

Describe the feature you're interested in

Currently, the documentation for the filters is a bit barebones and simplistic. Users like me that are new to the syntax are not able to take full advantage of this feature.

image

I would appreciate it the built in documentation of the UI is extended with some sample documents as well as more examples.

Describe alternatives you've considered

Reading the documentation manually is always an option but the UI should try to be self-documented if possible

Version you're running

2956664

Additional context

No response

Contributor guide

Research direction
Find the frontend component that renders the built in filter documentation. Review the current filter syntax and examples, then extend the documentation with additional sample documents and explanations.
Tech stack
typescript
Domain
frontenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70