kazusa
/
skywalking
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refine README.md (#6464)

This commit is contained in:
Wing 2021-02-27 16:16:18 +08:00 committed by GitHub
parent daefd5ebce
commit aacaade596
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/README.md
View File

@ -1,32 +1,31 @@
# Welcome
**Here are SkyWalking 8 official documentation. You're welcome to join us.**
**This is the official documentation of SkyWalking 8. Welcome to the SkyWalking community!**
From here you can learn all about **SkyWalking**’s architecture, how to deploy and use SkyWalking, and develop based on SkyWalking contributions 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.
**NOTICE, SkyWalking 8 uses brand new tracing APIs, it is incompatible with all previous releases.**
**NOTE: SkyWalking 8 uses brand new tracing APIs which are incompatible with all previous releases.**
- [Concepts and Designs](en/concepts-and-designs/README.md). You'll find the the most important core ideas about SkyWalking. You can learn from here if you want to understand what is going on under our cool features and visualization.
- [Concepts and Designs](en/concepts-and-designs/README.md). You'll find the 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](en/setup/README.md). Guides for installing SkyWalking in different scenarios. As a platform, it provides several ways of the observability.
- [Setup](en/setup/README.md). A guide to installing SkyWalking for different use cases. It is an observability platform that supports multiple observability modes.
- [UI Introduction](en/ui/README.md). Introduce the UI usage and features.
- [UI Introduction](en/ui/README.md). An introduction to the UI components and their features.
- [Contributing Guides](en/guides/README.md). Guides are for PMC member, committer or new contributor. Here, you can find how to start contributing.
- [Contributing Guides](en/guides/README.md). If you are a PMC member, a committer, or a new contributor, learn how to start contributing with these guides!
- [Protocols](en/protocols/README.md). Protocols show the communication ways between agents/probes and backend. Anyone interested in uplink telemetry data should definitely read this.
- [Protocols](en/protocols/README.md). The protocols show how agents/probes and the backend communicate with one another. Anyone interested in uplink telemetry data should definitely read this.
- [FAQs](en/FAQ/README.md). A manifest of already known setup problems, secondary developments experiments. When you are facing a problem, check here first.
- [FAQs](en/FAQ/README.md). A manifest of known issues with setup and secondary developments processes. Should you encounter any problems, check here first.
In addition, you might find these links interesting:
You might also find these links interesting:
- The latest and old releases are all available at [Apache SkyWalking release page](http://skywalking.apache.org/downloads/). The change logs are [here](../CHANGES.md).
- The latest and old releases are all available at [Apache SkyWalking release page](http://skywalking.apache.org/downloads/). The change logs can be found [here](../CHANGES.md).
- [SkyWalking WIKI](https://cwiki.apache.org/confluence/display/SKYWALKING/Home) hosts the context of some changes and events.
- You can find the speaking schedules at Conf, online videos and articles about SkyWalking in [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 improving our documentation and codes, so please don’t hesitate to [file an issue](https://github.com/apache/skywalking/issues/new)
if you see any problem.
Or better yet, submit your own contributions through pull request to help make them 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!