skywalking-java/docs
Wu Sheng 4cd4d247d8 Finish initial documents of overview, project goals and probe-introduction in concepts and designs. 2018-07-09 16:48:14 -07:00
..
en Finish initial documents of overview, project goals and probe-introduction in concepts and designs. 2018-07-09 16:48:14 -07:00
README.md Finish initial documents of overview, project goals and probe-introduction in concepts and designs. 2018-07-09 16:48:14 -07:00
ROADMAP.md New Change logs for next release (#1109) 2018-05-07 15:05:27 +08:00
Screenshots.md Update 5.0.0-beta2 screen snapshot (#1414) 2018-06-30 20:23:44 +08:00

README.md

Welcome

SkyWalking 6 documents and codes are still on building, Status: WIP. Of course, we welcome everyone to join us.

From here you can learn all about SkyWalkings architecture, how to deploy and use SkyWalking, even develop something based on SkyWalking.

  • Concepts and Designs. Concepts and designs explain 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.
  • Setup. Setup contains guides for installing SkyWalking in different scenarios. As a platform, it provides several ways to provide observability, including monitoring and alarm of course.
  • Guides. Guides are for PPMC, committer or new contributor. At here, you can know how to develop, release and what is ongoing of the community.
  • Protocols. Protocols show the communication ways between agents/probes and backend. Anyone, interested in uplink telemetry data, definitely should read this.
  • FAQs. Include a manifest, including already known setup problems, secondary developments experiments. When you are facing a problem, check here first.

In addition, you might find these links interesting:

  • The latest and old releases are all available in Apache SkyWalking release page. The change logs are here.
  • You can find the speaking schedules at Conf, online videos and articles about SkyWalking in Community resource catalog. Also, if you have some related to us, welcome to submit a pull request to add.
  • Were always looking for help improving our documentation and codes, so please dont hesitate to file an issue if you see some problem. Or better yet, submit your own contributions to help make them better.