Remove misleading table definitions
What does this MR do?
Problem
In the documentation for our markdown tables, the table definitions have misleading tables that - for example - increase the amount of hyphens for each subsequent column. In the cells, the text content also gets longer in each subsequent cell. Some users may infer that the cells are wider because of the increasing amount of hyphens, rather than that it's being computed dynamically from the content of the table body.
Fix
This MR updates the docs with three changes:
- Each table example has exactly 3 hyphens
- Duplicated table example columns with more than 3 hyphens are deleted entirely
- The descriptive text of the table definition is updated to clearly state that 1 hyphen is all that's necessary, and controlling the width of the columns isn't possible.
Screenshots (strongly suggested)
Before | After |
---|---|
Does this MR meet the acceptance criteria?
Conformity
-
I have included a changelog entry, or it's not needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Edited by Thomas Randolph