This is an automated email from the ASF dual-hosted git repository.
yihaochen pushed a commit to branch readme-revamp
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/readme-revamp by this push:
new 6d93acb944 polish doc readme a bit
6d93acb944 is described below
commit 6d93acb944b625a5c9162b3f3214cefceebd5d33
Author: Superskyyy (Back) <supersk...@outlook.com>
AuthorDate: Thu Dec 28 21:33:10 2023 -0500
polish doc readme a bit
---
docs/README.md | 25 ++++++++-----------------
1 file changed, 8 insertions(+), 17 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 20b6c88213..2117d57c44 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!
