-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Updated configuration reference #20347
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ilyam8
reviewed
May 27, 2025
ilyam8
reviewed
May 27, 2025
let's scratch it then, it is llm friendly as is, just thought of how we
could enhance this :)
…On Tue, May 27, 2025 at 12:52 PM Fotis Voutsas ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In src/health/REFERENCE.md
<#20347 (comment)>:
> +<!-- DOCUMENT_METADATA
+title: Netdata Health Alert Configuration Guide
+type: comprehensive_guide
+topics: monitoring, alerts, configuration, troubleshooting, expressions, variables
+audience: system_administrators, devops_engineers, monitoring_specialists
+complexity: beginner_to_advanced
+last_updated: 2024
+-->
@kanelatechnical <https://github.com/kanelatechnical> how is this
rendering on Learn, are these tags supported (and the following block)?
Metadata on Docusaurus is like this
<https://github.com/netdata/learn/blob/master/docs/alerts-%26-notifications/alert-configuration-reference.mdx?plain=1#L1-L8>,
I doubt this metadata will be used in any way, and it will mess up the
ingest script.
Currently we handle metadata automatically, so if we want to have a static
version too it will need changes to the ingest script.
I would not like defining stuff like titles here, as they could conflict
with the titles of the map (google sheets) TSV file.
cc @ilyam8 <https://github.com/ilyam8>
------------------------------
In src/health/REFERENCE.md
<#20347 (comment)>:
> +<!-- DOCUMENT_METADATA
+title: Netdata Health Alert Configuration Guide
+type: comprehensive_guide
+topics: monitoring, alerts, configuration, troubleshooting, expressions, variables
+audience: system_administrators, devops_engineers, monitoring_specialists
+complexity: beginner_to_advanced
+last_updated: 2024
+-->
-You can use health alerts in conjunction with any of Netdata's [collectors](/src/collectors/README.md) (see
-the [supported collector list](/src/collectors/COLLECTORS.md)) to monitor the health of your systems, containers, and
-applications in real time.
+<!-- CONTENT_STRUCTURE
+sections: 7
+quick_start: yes
+examples: 7
+decision_trees: 3
+reference_tables: 15+
+code_samples: 50+
+-->
@kanelatechnical <https://github.com/kanelatechnical> this is a big thing
to keep up to date, and not to forget in the future, imagine every file
will have these.
I am also not sure if this will work with ingest, or if there would be
breaking side-effects.
Given these points I'd say we don't use these, if the content is proper
and concise, the LLM will not have issues understanding it anyways.
—
Reply to this email directly, view it on GitHub
<#20347 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BQS5LW562PPPUXN343FZUZ33AQYUNAVCNFSM6AAAAAB55SFKPSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDQNRZGY2TKOBTHE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
ilyam8
approved these changes
May 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added metadata to enhance llm friendliness, added visuals, improved language and structure, enhanced readability, enhanced searchability.