Skip to content
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
merged 4 commits into from
Jan 22, 2025
Merged

chore: add docs #8

merged 4 commits into from
Jan 22, 2025

Conversation

liukuijun666
Copy link
Contributor

@liukuijun666 liukuijun666 commented Jan 15, 2025

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, and logs_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:

  • Added new sections for "Getting Started" and "Release Notes" to the documentation, providing a structured overview and historical context for the INFINI Agent (docs/content.en/docs/getting-started/_index.md, docs/content.en/docs/release-notes/_index.md). [1] [2]

Standards checklist

  • The PR title is descriptive
  • The commit messages are semantic
  • Necessary tests are added
  • Updated the release notes
  • Necessary documents have been added if this is a new feature
  • Performance tests checked, no obvious performance degradation

@liukuijun666 liukuijun666 requested a review from medcl January 16, 2025 03:28
Copy link
Member

@medcl medcl left a 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 medcl merged commit 40e88c6 into main Jan 22, 2025
6 checks passed
@medcl medcl deleted the docs branch January 22, 2025 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants