-
Notifications
You must be signed in to change notification settings - Fork 2
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
chore: add docs #8
Merged
Conversation
This file contains 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
medcl
reviewed
Jan 15, 2025
medcl
reviewed
Jan 15, 2025
medcl
reviewed
Jan 15, 2025
medcl
reviewed
Jan 15, 2025
medcl
reviewed
Jan 22, 2025
docs/content.en/docs/configuration/processors/es_cluster_health.md
Outdated
Show resolved
Hide resolved
medcl
requested changes
Jan 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fix the path.
medcl
approved these changes
Jan 22, 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.
What does this PR do
add docs
Rationale for this change
This pull request includes several changes aimed at improving the documentation for the INFINI Agent. The most important changes involve the addition of configuration examples and parameter descriptions for various processors, as well as updates to the
Makefile
and configuration files to support the new documentation structure.Documentation improvements:
Added configuration examples and parameter descriptions for processors such as
es_cluster_health
,es_cluster_stats
,es_index_stats
,es_logs_processor
,es_node_stats
, andlogs_processor
(docs/content.en/docs/configuration/processors/es_cluster_health.md
,docs/content.en/docs/configuration/processors/es_cluster_stats.md
,docs/content.en/docs/configuration/processors/es_index_stats.md
,docs/content.en/docs/configuration/processors/es_logs_processor.md
,docs/content.en/docs/configuration/processors/es_node_stats.md
,docs/content.en/docs/configuration/processors/logs_processor.md
). [1] [2] [3] [4] [5] [6]Updated the
Makefile
to include targets for building and serving the documentation, as well as initializing the theme and configuring the environment (docs/Makefile
).Configuration updates:
Added a new
config.yaml
file with detailed configuration settings for the documentation site, including theme settings, multilingual support, and menu configurations (docs/config.yaml
).Updated the
.gitignore
file to exclude generated files and backup configurations (docs/.gitignore
).Content structuring:
docs/content.en/docs/getting-started/_index.md
,docs/content.en/docs/release-notes/_index.md
). [1] [2]Standards checklist