diff --git a/README.md b/README.md index 045cdea0400a..b35e534efe5e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Apache SkyWalking Sky Walking logo -**SkyWalking**: an APM(application performance monitor) system, especially designed for +**SkyWalking**: an APM (Application Performance Monitoring) system, especially designed for microservices, cloud native and container-based architectures. [![GitHub stars](https://img.shields.io/github/stars/apache/skywalking.svg?style=for-the-badge&label=Stars&logo=github)](https://github.com/apache/skywalking) @@ -12,15 +12,15 @@ microservices, cloud native and container-based architectures. [![Maven Central](https://img.shields.io/maven-central/v/org.apache.skywalking/apache-skywalking-apm.svg)](http://skywalking.apache.org/downloads/) # Abstract -**SkyWalking** is an open source APM system, including monitoring, tracing, diagnosing capabilities for distributed system -in Cloud Native architecture. +**SkyWalking** is an open-source APM system that provides monitoring, tracing and diagnosing capabilities for distributed systems in Cloud Native architectures. + * Distributed Tracing * End-to-end distributed tracing. Service topology analysis, service-centric observability and APIs dashboards. * Agents for your stack * Java, .Net Core, PHP, NodeJS, Golang, LUA, Rust, C++, Client JavaScript and Python agents with active development and maintenance. * eBPF early adoption - * Rover agent works as metrics collector and profiler powered by eBPF to diagnose CPU and network performance. + * Rover agent works as a monitor and profiler powered by eBPF to diagnose CPU and network performance. * Scaling * 100+ billion telemetry data could be collected and analyzed from one SkyWalking cluster. * Mature Telemetry Ecosystems Supported @@ -36,10 +36,13 @@ in Cloud Native architecture. +# Live Demo +- Find the [SkyWalking live demo with native UI and Grafana](https://skywalking.apache.org/#demo), and [screenshots](https://skywalking.apache.org/#arch) on our website. +- Follow the [showcase](https://skywalking.apache.org/docs/skywalking-showcase/next/readme/) to set up a preview deployment quickly. + # Documentation - [Official documentation](https://skywalking.apache.org/docs/#SkyWalking) - # Downloads Please head to the [releases page](https://skywalking.apache.org/downloads/) to download a release of Apache SkyWalking. @@ -50,19 +53,16 @@ Follow this [document](docs/en/guides/How-to-build.md). This project adheres to the Contributor Covenant [code of conduct](https://www.apache.org/foundation/policies/conduct). By participating, you are expected to uphold this code. Please follow the [REPORTING GUIDELINES](https://www.apache.org/foundation/policies/conduct#reporting-guidelines) to report unacceptable behavior. -# Live Demo -- Find the [live demo](https://skywalking.apache.org/#demo) and [screenshots](https://skywalking.apache.org/#arch) on our website. -- Follow the [showcase](https://skywalking.apache.org/docs/skywalking-showcase/next/readme/) to set up preview deployment quickly. - # Contact Us * Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list. * Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in. * For Chinese speaker, send `[CN] Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in. * Twitter, [ASFSkyWalking](https://twitter.com/AsfSkyWalking) * [bilibili B站 视频](https://space.bilibili.com/390683219) - +* [掘金](https://juejin.cn/user/13673577331607/posts) + # Our Users -Hundreds of companies and organizations use SkyWalking for research, production, and commercial product. +Hundreds of companies and organizations use SkyWalking for research, production, and commercial purposes. Visit our [website](http://skywalking.apache.org/users/) to find the user page. # License diff --git a/docs/README.md b/docs/README.md index 20b6c88213b6..2117d57c44ac 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,23 +2,18 @@ **This is the official documentation of SkyWalking 9. Welcome to the SkyWalking community!** -Here you can learn all you need to know about **SkyWalking**’s architecture, understand how to deploy and use -SkyWalking, and contribute to the project based on SkyWalking's contributing guidelines. +Here you can learn all you need to know about **SkyWalking**'s architecture, understand how to deploy and use SkyWalking, and contribute to the project based on SkyWalking's contributing guidelines. - **Concepts and Designs**. You'll find the core logic behind SkyWalking. You may start from here if you want to understand what is going on under our cool features and visualization. -- **Setup**. A guide to installing SkyWalking for different use cases. It is an observability platform that supports - multiple observability modes. +- **Setup**. A guide to install SkyWalking for different use cases. It is an observability platform that supports multiple observability modes. -- **Contributing Guides**. If you are a PMC member, a committer, or a new contributor, learn how to start contributing - with these guides! +- **Contributing Guides**. If you are a PMC member, a committer, or a new contributor, learn how to start contributing with these guides! -- **Protocols**. The protocols show how agents/probes and the backend communicate with one another. Anyone interested in - uplink telemetry data should definitely read this. +- **Protocols**. The protocols show how agents/probes and the backend communicate with one another. Anyone interested in uplinking telemetry data should definitely read this. -- **FAQs**. A manifest of known issues with setup and secondary developments processes. Should you encounter any - problems, check here first. +- **FAQs**. A manifest of known issues with setup and secondary developments processes. Should you encounter any problems, check here first. You might also find these links interesting: @@ -26,13 +21,9 @@ You might also find these links interesting: at [Apache SkyWalking release page](https://skywalking.apache.org/downloads/). The change logs can be found [here](https://github.com/apache/skywalking/tree/master/changes). -- [SkyWalking WIKI](https://cwiki.apache.org/confluence/display/SKYWALKING/Home) hosts the context of some changes and - events. +- [SkyWalking WIKI](https://cwiki.apache.org/confluence/display/SKYWALKING/Home) hosts the context of some changes and events. -- You can find the conference schedules, video recordings, and articles about SkyWalking in - the [community resource catalog](https://github.com/OpenSkywalking/Community). +- You can find the conference schedules, video recordings, and articles about SkyWalking in the [community resource catalog](https://github.com/OpenSkywalking/Community). -We're always looking for help to improve our documentation and codes, so please don’t hesitate -to [file an issue](https://github.com/apache/skywalking/issues/new) if you see any problems. Or better yet, directly -contribute by submitting a pull request to help us get better! +We're always looking for help to improve our documentation and codes, so please don’t hesitate to [file an issue](https://github.com/apache/skywalking/issues/new) if you see any problems. Or better yet, directly contribute by submitting a pull request to help us get better!