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

docs: add Chinese Traditional documentation and comparisons #6482

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

appleboy
Copy link

@appleboy appleboy commented Nov 19, 2024

Summary

  • Update README.md to include links to both Chinese Traditional and Chinese Simplified versions
  • Add a new README.zh-tw.md file with comprehensive documentation in Chinese Traditional, covering features like application performance monitoring, log management, distributed tracing, metrics and dashboards, alerts, and exception monitoring
  • Include comparisons of SigNoz with other tools like Prometheus, Jaeger, Elastic, and Loki in the README.zh-tw.md file
  • Provide instructions for getting started with SigNoz, including creating a cloud account, self-hosted deployment using Docker, and Kubernetes deployment using Helm
  • Highlight the benefits of choosing SigNoz and supported programming languages for instrumentation in the README.zh-tw.md file
  • Add information about contributing to the project, project maintainers, and community engagement in the README.zh-tw.md file

Related Issues / PR's

Screenshots

NA

Affected Areas and Manually Tested Areas


Important

Add Chinese Traditional documentation in README.zh-tw.md and update README.md with links to Chinese versions.

  • Documentation:
    • Add README.zh-tw.md with comprehensive Chinese Traditional documentation.
    • Update README.md to include links to Chinese Traditional and Chinese Simplified versions.
  • Content:
    • README.zh-tw.md covers features like application performance monitoring, log management, distributed tracing, metrics and dashboards, alerts, and exception monitoring.
    • Includes comparisons with Prometheus, Jaeger, Elastic, and Loki.
    • Provides instructions for getting started with SigNoz, including cloud account creation, Docker deployment, and Kubernetes deployment using Helm.
    • Highlights benefits of SigNoz and supported programming languages for instrumentation.
    • Adds information about contributing, project maintainers, and community engagement.

This description was created by Ellipsis for 3d63e67. It will automatically update as commits are pushed.

- Update README.md to include links to both Chinese Traditional and Chinese Simplified versions
- Add a new README.zh-tw.md file with comprehensive documentation in Chinese Traditional, covering features like application performance monitoring, log management, distributed tracing, metrics and dashboards, alerts, and exception monitoring
- Include comparisons of SigNoz with other tools like Prometheus, Jaeger, Elastic, and Loki in the README.zh-tw.md file
- Provide instructions for getting started with SigNoz, including creating a cloud account, self-hosted deployment using Docker, and Kubernetes deployment using Helm
- Highlight the benefits of choosing SigNoz and supported programming languages for instrumentation in the README.zh-tw.md file
- Add information about contributing to the project, project maintainers, and community engagement in the README.zh-tw.md file

Signed-off-by: appleboy <appleboy.tw@gmail.com>
Copy link

welcome bot commented Nov 19, 2024

Welcome to the SigNoz community! Thank you for your first pull request and making this project better. 🤗

@CLAassistant
Copy link

CLAassistant commented Nov 19, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ Changes requested. Reviewed everything up to 3d63e67 in 28 seconds

More details
  • Looked at 274 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. README.md:20
  • Draft comment:
    Consider renaming "ReadMe in Chinese Traditional" to "README in Chinese Traditional" for consistency with other language links.
  • Reason this comment was not posted:
    Confidence changes required: 10%
    The PR adds a new README in Chinese Traditional, which is a good addition for localization. However, there is a minor inconsistency in the naming of the Chinese Simplified README link in the main README file. It should be consistent with the naming convention used for other languages.

Workflow ID: wflow_4AEDaAClnhv4jAr8


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

README.zh-tw.md Show resolved Hide resolved
appleboy and others added 2 commits November 19, 2024 23:43
- Update links in Chinese README to include English and Traditional Chinese README links
- Update links in Traditional Chinese README to include English and Simplified Chinese README links

Signed-off-by: appleboy <appleboy.tw@gmail.com>
@prashant-shahi prashant-shahi changed the base branch from develop to main December 19, 2024 11:26
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.

3 participants