You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2022/04/05 07:45:34 UTC
[skywalking] branch doc-fix created (now cd57b886a8)
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a change to branch doc-fix
in repository https://gitbox.apache.org/repos/asf/skywalking.git
at cd57b886a8 Polish doc readme.
This branch includes the following new commits:
new cd57b886a8 Polish doc readme.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[skywalking] 01/01: Polish doc readme.
Posted by wu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch doc-fix
in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit cd57b886a85f8d3a8f2e2ceb1d186f0076265b04
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Tue Apr 5 15:45:19 2022 +0800
Polish doc readme.
---
docs/README.md | 39 +++++++++++++++++++++++----------------
1 file changed, 23 insertions(+), 16 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 40b20d3c0b..20b6c88213 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,31 +1,38 @@
# Welcome
-**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.
-**NOTE: SkyWalking 8 uses brand new tracing APIs which are incompatible with all previous releases.**
-
-- **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.
+**This is the official documentation of SkyWalking 9. Welcome to the SkyWalking community!**
-- **Setup**. A guide to installing SkyWalking for different use cases. It is an observability platform that supports multiple observability modes.
+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.
-- **UI Introduction**. An introduction to the UI components and their features.
+- **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.
-- **Contributing Guides**. If you are a PMC member, a committer, or a new contributor, learn how to start contributing with these guides!
+- **Setup**. A guide to installing SkyWalking for different use cases. It is an observability platform that supports
+ multiple observability modes.
-- **Protocols**. The protocols show how agents/probes and the backend communicate with one another. Anyone interested in uplink telemetry data should definitely read this.
+- **Contributing Guides**. If you are a PMC member, a committer, or a new contributor, learn how to start contributing
+ with these guides!
-- **FAQs**. A manifest of known issues with setup and secondary developments processes. Should you encounter any problems, check here first.
+- **Protocols**. The protocols show how agents/probes and the backend communicate with one another. Anyone interested in
+ uplink 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.
You might also find these links interesting:
-- The latest and old releases are all available 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).
+- The latest and old releases are all available
+ 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!