You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2019/10/06 07:34:10 UTC
[skywalking] branch master updated: Reorganize the doc,
and provide catalog (#3563)
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new af51e23 Reorganize the doc, and provide catalog (#3563)
af51e23 is described below
commit af51e23b72e69cc746020618dcc9ca8b5ec06043
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Sun Oct 6 15:34:03 2019 +0800
Reorganize the doc, and provide catalog (#3563)
---
docs/README.md | 57 ++++++++++++++++++++++++
docs/en/concepts-and-designs/manual-sdk.md | 4 +-
docs/en/concepts-and-designs/ui-overview.md | 4 --
docs/en/setup/service-agent/java-agent/README.md | 2 +-
4 files changed, 60 insertions(+), 7 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index a3575ff..9419513 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -24,6 +24,63 @@ if you see some problem.
Or better yet, submit your own contributions through pull request to help make them better.
___
+# Document Catalog
+If you have been familiar with SkyWalking, you could use this catalog to find the document chapter directly.
+
+* [Concepts and Designs](en/concepts-and-designs/README.md)
+ * What is SkyWalking?
+ * [Overview and Core concepts](en/concepts-and-designs/overview.md). Provides a high-level description and introduction, including the problems the project solves.
+ * [Project Goals](en/concepts-and-designs/project-goals.md). Provides the goals, which SkyWalking is trying to focus and provide features about them.
+ * Probe
+ * [Introduction](en/concepts-and-designs/probe-introduction.md). Lead readers to understand what the probe is, how many different probes existed and why need them.
+ * [Service auto instrument agent](en/concepts-and-designs/service-agent.md). Introduce what the auto instrument agents do and which languages does SkyWalking already support.
+ * [Manual instrument SDK](en/concepts-and-designs/manual-sdk.md). Introduce the role of the manual instrument SDKs in SkyWalking ecosystem.
+ * [Service Mesh probe](en/concepts-and-designs/service-mesh-probe.md). Introduce why and how SkyWalking receive telemetry data from Service mesh and proxy probe.
+ * Backend
+ * [Overview](en/concepts-and-designs/backend-overview.md). Provides a high level introduction about the OAP backend.
+ * [Observability Analysis Language](en/concepts-and-designs/oal.md). Introduces the core languages, which is designed for aggregation behaviour definition.
+ * [Query in OAP](en/protocols/README.md#query-protocol). A set of query protocol provided, based on the Observability Analysis Language metrics definition.
+ * UI
+ * [Overview](en/concepts-and-designs/ui-overview.md). A simple brief about SkyWalking UI.
+* [Setup](en/setup/README.md).
+ * Backend, UI and Java agent are Apache official release, you could find them at [Apache SkyWalking DOWNLOAD page](http://skywalking.apache.org/downloads/).
+ * Language agents in Service
+ * [Java agent](en/setup/service-agent/java-agent/README.md). Introduce how to install java agent to your service, without change any codes.
+ * [Supported middleware, framework and library](en/setup/service-agent/java-agent/Supported-list.md).
+ * [Agent Configuration Properties](en/setup/service-agent/java-agent/README.md#table-of-agent-configuration-properties).
+ * [Optional plugins](en/setup/service-agent/java-agent/README.md#optional-plugins).
+ * [Bootstrap/JVM class plugin](en/setup/service-agent/java-agent/README.md#bootstrap-class-plugins).
+ * [Advanced features](en/setup/service-agent/java-agent/README.md#advanced-features).
+ * [Plugin development guide](en/setup/service-agent/java-agent/README.md#plugin-development-guide).
+ * [Agent plugin tests and performance tests](en/setup/service-agent/java-agent/README.md#test).
+ * [Other language agents](en/setup/README.md#language-agents-in-service) includes .NetCore, PHP, NodeJS, Go, which are maintained by volunteers.
+ * Service Mesh
+ * [SkyWalking on Istio](en/setup/istio/README.md). Introduce how to use Istio Mixer bypass Adapter to work with SkyWalking.
+ * Use [ALS(access log service)](https://www.envoyproxy.io/docs/envoy/latest/api-v2/service/accesslog/v2/als.proto) to observe service mesh, without Mixer. Follow [document](en/setup/envoy/als_setting.md) to open it.
+ * [Backend and UI setup document](en/setup/backend/backend-ui-setup.md).
+ * [Backend setup document](en/setup/backend/backend-setup.md).
+ * [Overriding settings](en/setup/backend/backend-setting-override.md) in application.yml is supported。
+ * [IP and port setting](en/setup/backend/backend-ip-port.md). Introduce how IP and port set and be used.
+ * [Backend init mode startup](en/setup/backend/backend-init-mode.md). How to init the environment and exit graciously. Read this before you try to initial a new cluster.
+ * [Cluster management](en/setup/backend/backend-cluster.md). Guide you to set backend server in cluster mode.
+ * [Deploy in kubernetes](en/setup/backend/backend-k8s.md). Guide you to build and use SkyWalking image, and deploy in k8s.
+ * [Choose storage](en/setup/backend/backend-storage.md). As we know, in default quick start, backend is running with H2 DB. But clearly, it doesn't fit the product env. In here, you could find what other choices do you have. Choose the one you like, we are also welcome anyone to contribute new storage implementor,
+ * [Set receivers](en/setup/backend/backend-receivers.md). You could choose receivers by your requirements, most receivers are harmless, at least our default receivers are. You would set and active all receivers provided.
+ * Do [trace sampling](en/setup/backend/trace-sampling.md) at backend. This sample keep the metrics accurate, only don't save some of traces in storage based on rate.
+ * Follow [slow DB statement threshold](en/setup/backend/slow-db-statement.md) config document to understand that, how to detect the Slow database statements(including SQL statements) in your system.
+ * Official [OAL scripts](en/guides/backend-oal-scripts.md). As you known from our [OAL introduction](en/concepts-and-designs/oal.md), most of backend analysis capabilities based on the scripts. Here is the description of official scripts, which helps you to understand which metrics data are in process, also could be used in alarm.
+ * [Alarm](en/setup/backend/backend-alarm.md). Alarm provides a time-series based check mechanism. You could set alarm rules targeting the analysis oal metrics objects.
+ * [Advanced deployment options](en/setup/backend/advanced-deployment.md). If you want to deploy backend in very large scale and support high payload, you may need this.
+ * [Metrics exporter](en/setup/backend/metrics-exporter.md). Use metrics data exporter to forward metrics data to 3rd party system.
+ * [Time To Live (TTL)](en/setup/backend/ttl.md). Metrics and trace are time series data, they would be saved forever, you could set the expired time for each dimension.
+ * [Dynamic Configuration](en/setup/backend/dynamic-config.md). Make configuration of OAP changed dynamic, from remote service or 3rd party configuration management system.
+ * [Uninstrumented Gateways](en/setup/backend/uninstrumented-gateways.md). Configure gateways/proxies that are not supported by SkyWalking agent plugins, to reflect the delegation in topology graph.
+ * [UI setup document](en/setup/backend/ui-setup.md).
+* [Protocols](en/protocols/README.md). Protocols show the communication ways between agents/probes and backend. Anyone, interested in uplink telemetry data, definitely should read this.
+* [FAQs](en/FAQ/README.md). Include a manifest, including already known setup problems, secondary developments experiments. When you are facing a problem, check here first.
+
+
+___
### Users from 5.x
SkyWalking 5.x is still supported by the community. For the user plans to upgrade from 5.x to 6.x, you should know there are some definitions of concepts changed.
diff --git a/docs/en/concepts-and-designs/manual-sdk.md b/docs/en/concepts-and-designs/manual-sdk.md
index fea15b2..215aff7 100644
--- a/docs/en/concepts-and-designs/manual-sdk.md
+++ b/docs/en/concepts-and-designs/manual-sdk.md
@@ -1,8 +1,8 @@
# Manual instrument SDK
-We haven't provided any manual instrument SDK yet.
+We have manual instrument SDK contributed from the community.
+- [Go2Sky](https://github.com/SkyAPM/go2sky). Go SDK follows SkyWalking format.
Welcome to consider contributing in following languages:
-- Go
- Python
- C++
diff --git a/docs/en/concepts-and-designs/ui-overview.md b/docs/en/concepts-and-designs/ui-overview.md
index c9fd956..72bef4d 100644
--- a/docs/en/concepts-and-designs/ui-overview.md
+++ b/docs/en/concepts-and-designs/ui-overview.md
@@ -3,10 +3,6 @@ SkyWalking native UI provides the default visualization solution.
It provides observability related graphs
about overview, service, service instance, endpoint, trace and alarm,
including topology, dependency graph, heatmap, etc.
-
-For most open source users, this UI solution should be good enough to use.
-And you have other open source options in visualization.
-See [UI setup](../setup/backend/ui-setup.md).
Also, we have already known, many of our users have integrated SkyWalking
into their products.
diff --git a/docs/en/setup/service-agent/java-agent/README.md b/docs/en/setup/service-agent/java-agent/README.md
index dcdfba5..e558614 100755
--- a/docs/en/setup/service-agent/java-agent/README.md
+++ b/docs/en/setup/service-agent/java-agent/README.md
@@ -32,7 +32,7 @@ The agent release dist is included in Apache [official release](http://skywalkin
- Start your application.
-## Supported middlewares, frameworks and libraries
+## Supported middleware, framework and library
SkyWalking agent has supported various middlewares, frameworks and libraries.
Read [supported list](Supported-list.md) to get them and supported version.
If the plugin is in **Optional²** catalog, go to [optional plugins](#optional-plugins) section to learn how to active it.