Markdown syntax: avoid a table here because it cannot handle pipes in cells

[trentm]

GitHub Flavored Markdown tables cannot cope with literal | (vertical bars) in cells data. They get interpreted as cell delimiters. That is a problem for the regexes in https://github.com/elastic/apm/blob/master/specs/agents/configuration.md#configuration-value-types

The regexes below are incomplete when rendered:

Type	Description (if needed)
...	...
Duration	... Validating regex: `^(-)?(\d+)(ms
Size	... Validating regex: `^(\d+)(b

Option 1

Per https://stackoverflow.com/questions/49809122/vertical-bar-symbol-within-a-markdown-table one workaround is using | and <code>...</code> like so:

| Type | Description (if needed) |
|------|-------------------------|
| ...  | ... |
| Duration | ... Validating regex: <code>^(-)?(\d+)(ms&#124;s&#124;m)$</code> |
| Size     | ... Validating regex: <code>^(\d+)(b&#124;kb&#124;mb&#124;gb)$</code> |

Rendered:

Type	Description (if needed)
...	...
Duration	... Validating regex: ^(-)?(\d+)(ms|s|m)$
Size	... Validating regex: ^(\d+)(b|kb|mb|gb)$

The downside is that this regex is obscure for those reading the raw .md file in their editor.

Option 2

Use a list instead of a table.
Rendered: https://github.com/trentm/apm/blob/no-table-no-cry/specs/agents/configuration.md#configuration-value-types

[apmmachine]

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2021-08-24T16:45:42.241+0000

• Duration: 3 min 15 sec

• Commit: 2bf4a56

Trends 🧪

[felixbarny]

Either of the two options LGTM

[basepi]

I like the list, as shown in the current diff. Markdown is about source readability in addition to rendered readability.