docs(vrl): Automatically generate VRL function documentation

[thomasqueirozb]

Summary

Last part of the automatic doc generation RFC vectordotdev/vrl#1544

A lot of my verification for the changes done in this were via a very handy website diff viewer (https://pianomister.github.io/). I suggest setting the display to iPad and zooming out to 90%. Use this link to get see the differences between the current website and the deployed branch.

Many many issues were fixed. The following are (very likely incomplete) lists of the most notable fixes and changes:

"breaking" difference

• exists argument is no longer type path and is now type any. There is no way to indicate path arguments in the type system currently.

Parameter type fixes

fn	parameter	old	fixed
validate_json_schema	value	any	string
validate_json_schema	schema_definition	any	string
chunks	param	<array | string>	string
parse_timestamp	value	string	<timestamp | string>
uuid_from_friendly_id	value	timestamp	string
parse_regex	numeric_groups	regex	boolean
parse_regex_all	numeric_groups	regex	boolean
ip_ntoa	param	string	integer
truncate	limit	<integer | float>	integer

Parameters with incorrect names

fn	old	fixed
ip_cidr_contains	ip	value
ip_to_ipv6	ip	value
ipv6_to_ipv4	ip	value
ip_subnet	ip	value
sieve	pattern	permitted_characters
exists	path	field

Other fixes

• decode_lz4: buf_size's default value
• aggregate_vector_metric -> aggregate_vector_metrics (title)
• format_number: grouping_separator incorrect default
• strip_ansi_codes: removed invalid example
• truncate: ellipsis parameter removed
• parse_xml: trim parameter was missing
• Added many parameter defaults. (e.g. decode_lz4, encode_lz4, encode_json, encode_key_value, encode_logfmt)

Vector configuration

NA

How did you test this PR?

make generate-docs && cd website && make serve

Change Type

• Bug fix
• New feature
• Non-functional (chore, refactoring, docs)
• Performance

Is this a breaking change?

• Yes
• No

Does this PR include user facing changes?

• Yes. Please add a changelog fragment based on our guidelines.
• No. A maintainer will apply the no-changelog label to this PR.

References

• Related: feat(rfc): automatic documentation generation vrl#1544

[github-actions]

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview