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: translate chinese doc of faq.md and monitoring.md into english (#1796) #1815

Merged
merged 8 commits into from
May 24, 2022

Conversation

jmoldyvan
Copy link
Contributor

@jmoldyvan jmoldyvan commented May 13, 2022

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 13, 2022
@jmoldyvan jmoldyvan changed the title docs: translate the Chinese doc of faq.md into English (#1796) docs: translate the Chinese doc of faq.md into english (#1796) May 13, 2022
@jmoldyvan jmoldyvan changed the title docs: translate the Chinese doc of faq.md into english (#1796) docs: translate the chinese doc of faq.md into english (#1796) May 13, 2022
@jmoldyvan jmoldyvan changed the title docs: translate the chinese doc of faq.md into english (#1796) docs: translate chinese doc of faq.md into english (#1796) May 13, 2022
@lumianph lumianph self-requested a review May 16, 2022 14:03
Copy link
Collaborator

@lumianph lumianph left a comment

Choose a reason for hiding this comment

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

@jmoldyvan thank you for your contribution! Are you interested in making more contribution to this project? You may join our slack channel to talk to me :-)
https://join.slack.com/t/openmldb/shared_invite/zt-ozu3llie-K~hn9Ss1GZcFW2~K_L5sMg

docs/en/maintain/faq.md Outdated Show resolved Hide resolved
docs/en/maintain/faq.md Outdated Show resolved Hide resolved
docs/en/maintain/faq.md Outdated Show resolved Hide resolved
docs/en/maintain/faq.md Outdated Show resolved Hide resolved
docs/en/maintain/faq.md Outdated Show resolved Hide resolved
@jmoldyvan
Copy link
Contributor Author

Do you want me to make these changes and resubmit a PR with them?

@lumianph
Copy link
Collaborator

no, don't resubmit a PR, just push another commit to this PR to address those comments.

@jmoldyvan
Copy link
Contributor Author

I also committed:

docs: translate the Chinese doc of monitoring.md into English #1794

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
-make a new faq.md file in the docs/en/maintain folder for monitoring
-add monitoring to index rst
close #1796
close docs: translate the Chinese doc of monitoring.md into English #1794

What is the current behavior? (You can also link to an open issue here)
-an overview of monitoring procedures

What is the new behavior (if this is a feature change)?
-translation from chinese monitoring.md
-added new file to docs/en/maintain/monitoring.md
-add monitoring to indexrst

@lumianph lumianph changed the title docs: translate chinese doc of faq.md into english (#1796) docs: translate chinese doc of faq.md and monitoring.md into english (#1796) May 23, 2022
Copy link
Collaborator

@lumianph lumianph left a comment

Choose a reason for hiding this comment

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

thank you for the contribution! Please help address the comments.
BTW, if you have another translated doc, please submit another PR

docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved
docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved

The default startup script `bin/start.sh` enables server status, no additional configuration is required.

3. Note: Make sure to select the binding IP addresses of OpenMLDB components, OpenMLDB exporter as well as prometheus and grafana to ensure that grafana can access prometheus, and that prometheus, OpenMLDB exporter, and OpenMLDB components can access each other.
Copy link
Collaborator

@lumianph lumianph May 23, 2022

Choose a reason for hiding this comment

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

"components, OpenMLDB"
remove the extra spaces between "components," and "OpenMLDB" (it seems a tab)

docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved
docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved
docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved
docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved
docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved
- BRPC server process related information
- Corresponding to the RPC method related indicators defined by the BRPC server, such as the RPC request `count`, `error_count`, `qps` and `response_time`

pass
Copy link
Collaborator

Choose a reason for hiding this comment

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

Metrics and help information can be shown through the following command (Note that the metrics exposed by different components will vary):

docs/en/maintain/monitoring.md Outdated Show resolved Hide resolved
@lumianph lumianph merged commit 6f993f3 into 4paradigm:main May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants