Skip to content

Refine CodeTrans README #1960

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 8 commits into from
May 20, 2025
Merged

Conversation

letonghan
Copy link
Collaborator

Description

Refine CodeTrans README
Remove GMC part, add Tracing/Monitoring part for common use.

Issues

Fixes #1903

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Others (enhancement, documentation, validation, etc.)

Dependencies

None

Tests

None

Remove GMC part, add Tracing/Monitoring part for common use.

Issue: opea-project#1903

Signed-off-by: letonghan <letong.han@intel.com>
@Copilot Copilot AI review requested due to automatic review settings May 15, 2025 02:16
@letonghan letonghan requested a review from Spycsh as a code owner May 15, 2025 02:16
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refines the CodeTrans README by removing the outdated GMC section and adding new sections for monitoring and tracing OPEA services. The changes include:

  • Removal of the GMC link from the deployment options table in README.md.
  • Addition of detailed monitoring instructions using Prometheus/Grafana and tracing instructions with OpenTelemetry/Jaeger in README_miscellaneous.md.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

File Description
CodeTrans/README_miscellaneous.md Added sections for monitoring with Prometheus/Grafana and tracing with Jaeger.
CodeTrans/README.md Removed the obsolete GMC section from the deployment table.

Copy link

github-actions bot commented May 15, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

@letonghan letonghan requested review from mkbhanda and lvliang-intel and removed request for Spycsh May 15, 2025 02:20
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

Look goods, may need update the links in deploy table as the links point to one folders, thus in doc , click it will no response.
image

letonghan and others added 6 commits May 16, 2025 10:58
Co-authored-by: Ying Hu <ying.hu@intel.com>
Co-authored-by: Ying Hu <ying.hu@intel.com>
Signed-off-by: letonghan <letong.han@intel.com>
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@lvliang-intel lvliang-intel merged commit 0890e94 into opea-project:main May 20, 2025
11 checks passed
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.

CodeTrans README improvements
4 participants