[Logs]: update field reference #18177

cmackenzie1 · 2024-11-14T17:29:42Z

Summary

This also switches the files from .mdx back to .md since using MDX causes us to have to escape all the [, { and < characters during generation.

Screenshots (optional)

Documentation checklist

The documentation style guide has been adhered to.

This also switches the files from `.mdx` back to `.md` since using MDX causes us to have to escape all the `[`, `{` and `<` characters during generation.

hyperlint-ai

20 files reviewed, 6 total issue(s) found.

hyperlint-ai · 2024-11-14T17:30:24Z

src/content/docs/logs/reference/log-fields/zone/spectrum_events.md


-Transport protocol used by client; <em>tcp</em> | <em>udp</em> | <em>unix</em>.
+Transport protocol used by client; <em>tcp</em> \| <em>udp</em> \| <em>unix</em>.


Suggested change

Transport protocol used by client; tcp \| udp \| unix.

Transport protocol used by client; tcp \| UDP \| UNIX.

Issues:

Style Guide - (Terms-error) Use 'UDP' instead of 'udp'.

Style Guide - (Terms-error) Use 'UNIX' instead of 'unix'.

Fix Explanation:

The terms 'UDP' and 'UNIX' should be capitalized according to standard style guides for technical documentation. This change ensures consistency and adheres to the style guide requirements.

hyperlint-ai · 2024-11-14T17:30:24Z

src/content/docs/logs/reference/log-fields/zone/spectrum_events.md


-Transport protocol used by origin; <em>tcp</em> | <em>udp</em> | <em>unix</em>.
+Transport protocol used by origin; <em>tcp</em> \| <em>udp</em> \| <em>unix</em>.


Suggested change

Transport protocol used by origin; tcp \| udp \| unix.

Transport protocol used by origin; tcp \| UDP \| UNIX.

Issues:

Style Guide - (Terms-error) Use 'UDP' instead of 'udp'.

Style Guide - (Terms-error) Use 'UNIX' instead of 'unix'.

Fix Explanation:

The terms 'UDP' and 'UNIX' should be capitalized to adhere to standard style guidelines. This change ensures consistency and clarity in the documentation.

hyperlint-ai · 2024-11-14T17:30:24Z

src/content/docs/logs/reference/log-fields/account/dlp_forensic_copies.md

+
+Type: `string`
+
+Phase of the HTTP request this forensic copy was captured from (i.e. "request" or "response").


Suggested change

Phase of the HTTP request this forensic copy was captured from (i.e. "request" or "response").

Phase of the HTTP request from which this forensic copy was captured (that is, "request" or "response").

Issues:

Style Guide - (cloudflare.LatinTerms-warning) Use 'that is' instead of 'i.e.', but consider rewriting the sentence.

Fix Explanation:

The use of 'i.e.' is discouraged in some style guides in favor of 'that is' for clarity. Additionally, I rephrased the sentence slightly to improve readability by moving 'from' earlier in the sentence. This makes the sentence more direct and clear.

hyperlint-ai · 2024-11-14T17:30:24Z

src/content/docs/logs/reference/log-fields/account/zero_trust_network_sessions.md


-The type of destination to which the network session was routed. <br />Possible values are <em>INTERNET</em> | <em>MAGIC</em> | <em>CFD\_TUNNEL</em> | <em>WARP</em>.
+The type of destination to which the network session was routed. <br />Possible values are <em>INTERNET</em> \| <em>MAGIC</em> \| <em>CFD_TUNNEL</em> \| <em>WARP</em>.


Suggested change

The type of destination to which the network session was routed. Possible values are INTERNET \| MAGIC \| CFD_TUNNEL \| WARP.

The type of destination to which the network session was routed. Possible values are Internet \| MAGIC \| CFD_TUNNEL \| WARP.

Issues:

Style Guide - (Terms-error) Use 'Internet' instead of 'INTERNET'.

Fix Explanation:

The term 'INTERNET' should be replaced with 'Internet' to comply with the style guide and improve readability. The rest of the line remains unchanged as it is correct.

hyperlint-ai · 2024-11-14T17:30:24Z

src/content/docs/logs/reference/log-fields/account/magic_ids_detections.md


-The layer 4 protocol of the packet which triggered the detection. Possible values are <em>tcp</em> | <em>udp</em> | <em>any</em>. Variant <em>any</em> means a detection occurred at a lower layer (such as IP).
+The layer 4 protocol of the packet which triggered the detection. Possible values are <em>tcp</em> \| <em>udp</em> \| <em>any</em>. Variant <em>any</em> means a detection occurred at a lower layer (such as IP).


Suggested change

The layer 4 protocol of the packet which triggered the detection. Possible values are tcp \| udp \| any. Variant any means a detection occurred at a lower layer (such as IP).

The layer 4 protocol of the packet which triggered the detection. Possible values are tcp \| UDP \| any. Variant any means a detection occurred at a lower layer (such as IP).

Issues:

Style Guide - (Terms-error) Use 'UDP' instead of 'udp'.

Fix Explanation:

The style guide specifies that protocol names should be in uppercase, so 'udp' should be changed to 'UDP'. This is a straightforward style correction.

hyperlint-ai · 2024-11-14T17:30:24Z

src/content/docs/logs/reference/log-fields/account/workers_trace_events.md


-The outcome of the worker script invocation. <br />Possible values are <em>ok</em> | <em>exception</em>.
+The outcome of the worker script invocation. <br />Possible values are <em>ok</em> \| <em>exception</em>.


Suggested change

The outcome of the worker script invocation. Possible values are ok \| exception.

The outcome of the Worker script invocation. Possible values are ok \| exception.

Issues:

Style Guide - (Terms-error) Use 'Worker' instead of 'worker'.

Fix Explanation:

The term 'Worker' should be capitalized according to the style guide. This change ensures consistency and adherence to the specified guidelines.

soheiokamoto · 2024-11-14T18:18:31Z

Just fyi, when you create a PR based on the branch in this repo directly, it would create a preview, which is quite helpful when reviewing, but when it's based on a forked repo, it won't.

angelampcosta · 2024-11-15T11:43:20Z

Since these pages are generated I think we can disregard hyperlint suggestions. If we think they are relevant we can later address them in the source files.

angelampcosta · 2024-11-15T11:44:24Z

@KianNH if you don't have any concerns with this update, for me it's ok to merge.

[Logs]: update field reference

e4b8047

This also switches the files from `.mdx` back to `.md` since using MDX causes us to have to escape all the `[`, `{` and `<` characters during generation.

cmackenzie1 requested review from bharatnc, jherre, soheiokamoto, victor-perov, angelampcosta and a team as code owners November 14, 2024 17:29

hyperlint-ai bot reviewed Nov 14, 2024

View reviewed changes

github-actions bot assigned angelampcosta, bharatnc, jherre, soheiokamoto and victor-perov Nov 14, 2024

github-actions bot added size/xl product:logs Related to Logs labels Nov 14, 2024

angelampcosta requested a review from KianNH November 14, 2024 17:41

angelampcosta approved these changes Nov 15, 2024

View reviewed changes

KianNH approved these changes Nov 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Logs]: update field reference #18177

[Logs]: update field reference #18177

cmackenzie1 commented Nov 14, 2024

hyperlint-ai bot left a comment

hyperlint-ai bot Nov 14, 2024

hyperlint-ai bot Nov 14, 2024

hyperlint-ai bot Nov 14, 2024

hyperlint-ai bot Nov 14, 2024

hyperlint-ai bot Nov 14, 2024

hyperlint-ai bot Nov 14, 2024

soheiokamoto commented Nov 14, 2024

angelampcosta commented Nov 15, 2024

angelampcosta commented Nov 15, 2024


		Transport protocol used by client; <em>tcp</em> \| <em>udp</em> \| <em>unix</em>.
		Transport protocol used by client; <em>tcp</em> \\| <em>udp</em> \\| <em>unix</em>.


		Transport protocol used by origin; <em>tcp</em> \| <em>udp</em> \| <em>unix</em>.
		Transport protocol used by origin; <em>tcp</em> \\| <em>udp</em> \\| <em>unix</em>.


		Type: `string`

		Phase of the HTTP request this forensic copy was captured from (i.e. "request" or "response").

	Phase of the HTTP request this forensic copy was captured from (i.e. "request" or "response").
	Phase of the HTTP request from which this forensic copy was captured (that is, "request" or "response").


		The type of destination to which the network session was routed. <br />Possible values are <em>INTERNET</em> \| <em>MAGIC</em> \| <em>CFD\_TUNNEL</em> \| <em>WARP</em>.
		The type of destination to which the network session was routed. <br />Possible values are <em>INTERNET</em> \\| <em>MAGIC</em> \\| <em>CFD_TUNNEL</em> \\| <em>WARP</em>.


		The layer 4 protocol of the packet which triggered the detection. Possible values are <em>tcp</em> \| <em>udp</em> \| <em>any</em>. Variant <em>any</em> means a detection occurred at a lower layer (such as IP).
		The layer 4 protocol of the packet which triggered the detection. Possible values are <em>tcp</em> \\| <em>udp</em> \\| <em>any</em>. Variant <em>any</em> means a detection occurred at a lower layer (such as IP).


		The outcome of the worker script invocation. <br />Possible values are <em>ok</em> \| <em>exception</em>.
		The outcome of the worker script invocation. <br />Possible values are <em>ok</em> \\| <em>exception</em>.

[Logs]: update field reference #18177

Are you sure you want to change the base?

[Logs]: update field reference #18177

Conversation

cmackenzie1 commented Nov 14, 2024

Summary

Screenshots (optional)

Documentation checklist

hyperlint-ai bot left a comment

Choose a reason for hiding this comment

hyperlint-ai bot Nov 14, 2024

Choose a reason for hiding this comment

hyperlint-ai bot Nov 14, 2024

Choose a reason for hiding this comment

hyperlint-ai bot Nov 14, 2024

Choose a reason for hiding this comment

hyperlint-ai bot Nov 14, 2024

Choose a reason for hiding this comment

hyperlint-ai bot Nov 14, 2024

Choose a reason for hiding this comment

hyperlint-ai bot Nov 14, 2024

Choose a reason for hiding this comment

soheiokamoto commented Nov 14, 2024

angelampcosta commented Nov 15, 2024

angelampcosta commented Nov 15, 2024