Convert tables of connector properties to definition lists [DBZ-3120]
- Dominant language
- HTML
- Stars
- 6
- Forks
- 8
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 1
Description
Migrated from [DBZ-3120](https://issues.redhat.com/browse/DBZ-3120)
The documentation for the Debezium connectors uses long tables to present information about configuration properties. Presenting information in long tables presents navigation challenges for users who rely on screen readers to consume the content.
To improve accessibility, convert the existing tables into [definition, or _description_ lists|https://docs.asciidoctor.org/asciidoc/latest/lists/description/].
Contributor guide
Research direction
Search the Debezium connector documentation for the long tables that describe configuration properties. Read the linked Asciidoctor description-list guidance before changing the documentation. Done means the existing property tables are converted to definition lists and remain understandable to users of screen readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100