Getting Started
About This Site ¶
Before you continue exploring, please take a few minutes to get yourself familiar with the site.
Navigator ¶
Below are the key items and explanations on the left side bar:
- Standards: All the guidelines are under this directory.
- Knowledge Base: You will know how to apply some good cases in our project.
- Appendix: Contents that may be helpful with your reading.
What can you find here ¶
Standard Rules ¶
Guidelines for Monitoring & Alerting team, areas are including but not limited to:
- Documentation
- Code Style
- Development Process
- Software Best Practice
- Release Pipeline
- ...
It can be used as develop manual or audit reference.
Interested with upcoming Guidelines? Find it here!
Team and Product Information ¶
Introduction of Monitoring & Alerting team, and products we developed, such as MCT (Monitoring Console Tool), EMS (Event Management System), UAS (Unified Alert Service), GSS (Global Service Status)...
Some Conventions ¶
Here are some conventions may help you better understand this guide.
Rule Level ¶
We defined three levels:
- Mandatory: Rules that need to strictly follow.
- Recommend: Rules that we strongly suggest to follow.
- Reference: Rules for reference, suggest to follow, and no big impact if not following.
Symbols ¶
: Describe recommended coding and implementation approaches.
: Describe precautions, error cases or anti-pattern.