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 2021/02/18 00:51:54 UTC
[skywalking] branch master updated: Add latest doc menu.yml (#6391)
This is an automated email from the ASF dual-hosted git repository.
wusheng 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 3c980c2 Add latest doc menu.yml (#6391)
3c980c2 is described below
commit 3c980c2609031a3093c40564950b7aa37f5dc5ea
Author: Juntao Zhang <jt...@163.com>
AuthorDate: Thu Feb 18 08:51:38 2021 +0800
Add latest doc menu.yml (#6391)
---
docs/README.md | 80 -------------------------
docs/menu.yml | 182 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 182 insertions(+), 80 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 9430ae6..e9e6d52 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -30,83 +30,3 @@ We're always looking for help improving our documentation and codes, so please d
if you see any problem.
Or better yet, submit your own contributions through pull request to help make them better.
-___
-# Document Catalog
-If you are already 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 on and provide features about.
- * Probe
- * [Introduction](en/concepts-and-designs/probe-introduction.md). Lead readers to understand what the probe is, how many different probes exists and why we need them.
- * [Service auto instrument agent](en/concepts-and-designs/service-agent.md). Introduces what the auto instrument agents do and which languages does SkyWalking already support.
- * [Manual instrument SDK](en/concepts-and-designs/manual-sdk.md). Introduces the role of the manual instrument SDKs in SkyWalking ecosystem.
- * [Service Mesh probe](en/concepts-and-designs/service-mesh-probe.md). Introduces 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 are 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.
- * CLI (Command Line Interface)
- * SkyWalking CLI provides a command line interface to interact with SkyWalking backend (via GraphQL), for more information, [click here](https://github.com/apache/skywalking-cli).
-* [Setup](en/setup/README.md).
- * Backend, UI, Java agent, and CLI are Apache official release, you could find them at [Apache SkyWalking DOWNLOAD page](http://skywalking.apache.org/downloads/).
- * Language agents in Service
- * All available [agents](en/setup/README.md#language-agents-in-service) for different languages.
- * [Java agent](en/setup/service-agent/java-agent/README.md). Introduces how to install the java agent to your service, without changing any code.
- * [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 reporters](en/setup/service-agent/java-agent/README.md#advanced-reporters).
- * [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 Nginx LUA, Python, .NetCore, PHP, NodeJS, Go.
- * Browser performance monitoring
- * Track the performance of the browser, such as latency of redirect, dns, ttfb. For more information, [click here](https://github.com/apache/skywalking-client-js).
- * Service Mesh
- * [Observe Istio Control Plane](en/setup/istio/README.md). Introduces how to use SkyWalking to observe the Istio control plane.
- * [Observe Service Mesh](en/setup/envoy/als_setting.md). Introduces how to use SkyWalking and [Envoy Access Log Service (ALS)](https://www.envoyproxy.io/docs/envoy/latest/api-v2/service/accesslog/v2/als.proto) to observe service mesh.
- * Proxy
- * [Envoy Proxy](https://www.envoyproxy.io/)
- * [Send Envoy metrics to SkyWalking with / without Istio](en/setup/envoy/metrics_service_setting.md).
- * [Backend, UI and CLI setup document](en/setup/backend/backend-ui-setup.md).
- * [Backend setup document](en/setup/backend/backend-setup.md).
- * [Configuration Vocabulary](en/setup/backend/configuration-vocabulary.md). Configuration Vocabulary lists all available configurations provided by `application.yml`.
- * [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). Introduces how IP and port set can 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 start a new cluster.
- * [Cluster management](en/setup/backend/backend-cluster.md). Guide about backend server cluster mode.
- * [Deploy in kubernetes](en/setup/backend/backend-k8s.md). Guides 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 also welcome anyone to contribute new storage implementors.
- * [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.
- * [Open fetchers](en/setup/backend/backend-fetcher.md). You could open different fetchers to read metrics from the target applications. These ones work like receivers, but in pulling mode, typically like Prometheus.
- * Do [trace sampling](en/setup/backend/trace-sampling.md) at backend. Trace sampling allows you to keep your metrics accurate, whilst only keeping some traces in storage based on rate.
- * Follow [slow DB statement threshold](en/setup/backend/slow-db-statement.md) config document to understand how to detect 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 loads, you may need this.
- * [Metrics exporter](en/setup/backend/metrics-exporter.md). Use metrics data exporter to forward metrics data to 3rd party systems.
- * [Time To Live (TTL)](en/setup/backend/ttl.md). Metrics and traces 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.
- * [Apdex threshold](en/setup/backend/apdex-threshold.md). Configure the thresholds for different services if Apdex calculation is activated in the OAL.
- * [Service Grouping](en/setup/backend/service-auto-grouping.md). An automatic grouping mechanism for all services based on name.
- * [Group Parameterized Endpoints](en/setup/backend/endpoint-grouping-rules.md). Configure the grouping rules for parameterized endpoints, to improve the meaning of the metrics.
- * [OpenTelemetry Metrics Analysis](backend-receivers.md#opentelemetry-receiver). Activate built-in configurations to convert the metrics forwarded from OpenTelemetry collector. And learn how to write your own conversion rules.
- * [Meter Analysis](en/setup/backend/backend-meter.md). Set up the backend analysis rules, when use [SkyWalking Meter System Toolkit](en/setup/service-agent/java-agent/README.md#advanced-features) or meter plugins.
- * [Spring Sleuth Metrics Analysis](en/setup/backend/spring-sleuth-setup.md). Configure the agent and backend to receiver metrics from micrometer.
- * [UI setup document](en/setup/backend/ui-setup.md).
- * [CLI setup document](https://github.com/apache/skywalking-cli).
-* [UI Introduction](en/ui/README.md). Introduce the UI usage and features.
-* [Contributing Guides](en/guides/README.md). Guides are for PMC member, committer or new contributor. At here, you can find how to start contributing.
- * [Contact us](en/guides/README.md#contact-us). Guide users about how to contact the official committer team or communicate with the project community.
- * [Process to become official Apache SkyWalking Committer](en/guides/asf/committer.md). How to become an official committer or PMC member.
- * [Compiling Guide](en/guides/How-to-build.md). Follow this to compile the whole project from the source code.
- * [Agent plugin development guide](en/guides/Java-Plugin-Development-Guide.md). Guide developers to write their plugin, and follow [plugin test requirements](en/guides/Plugin-test.md) when you push the plugin to the upstream.
-* [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.
-* [FAQs](en/FAQ/README.md). A manifest of already known setup problems, secondary developments experiments. When you are facing a problem, check here first.
-
-
diff --git a/docs/menu.yml b/docs/menu.yml
new file mode 100644
index 0000000..126f192
--- /dev/null
+++ b/docs/menu.yml
@@ -0,0 +1,182 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+catalog:
+ - name: "Welcome"
+ path: "/readme"
+ - name: "Concepts and Designs"
+ path: "/en/concepts-and-designs/readme"
+ catalog:
+ - name: "What is SkyWalking?"
+ catalog:
+ - name: "Overview and Core concepts"
+ path: "/en/concepts-and-designs/overview"
+ - name: "Project Goals"
+ path: "/en/concepts-and-designs/project-goals"
+ - name: "Probe"
+ catalog:
+ - name: "Introduction"
+ path: "/en/concepts-and-designs/probe-introduction"
+ - name: "Service auto instrument agent"
+ path: "/en/concepts-and-designs/service-agent"
+ - name: "Manual instrument SDK"
+ path: "/en/concepts-and-designs/manual-sdk"
+ - name: "Service Mesh probe"
+ path: "/en/concepts-and-designs/service-mesh-probe"
+ - name: "Backend"
+ catalog:
+ - name: "Overview"
+ path: "/en/concepts-and-designs/backend-overview"
+ - name: "Observability Analysis Language"
+ path: "/en/concepts-and-designs/oal"
+ - name: "Query in OAP"
+ path: "/en/protocols/readme#query-protocol"
+ - name: "UI"
+ catalog:
+ - name: "Overview"
+ path: "/en/concepts-and-designs/ui-overview"
+
+ - name: "Setup"
+ path: "/en/setup/readme"
+ catalog:
+ - name: "Language agents in Service"
+ catalog:
+ - name: "Agents"
+ path: "/en/setup/readme#language-agents-in-service"
+ - name: "Java agent"
+ path: "/en/setup/service-agent/java-agent/readme"
+ catalog:
+ - name: "Supported middleware, framework and library"
+ path: "/en/setup/service-agent/java-agent/Supported-list"
+ - name: "Agent Configuration Properties"
+ path: "/en/setup/service-agent/java-agent/readme#table-of-agent-configuration-properties"
+ - name: "Optional plugins"
+ path: "/en/setup/service-agent/java-agent/readme#optional-plugins"
+ - name: "Bootstrap/JVM class plugin"
+ path: "/en/setup/service-agent/java-agent/readme#bootstrap-class-plugins"
+ - name: "Advanced reporters"
+ path: "/en/setup/service-agent/java-agent/readme#advanced-reporters"
+
+ - name: "Plugin development guide"
+ path: "/en/setup/service-agent/java-agent/readme#plugin-development-guide"
+ - name: "Agent plugin tests and performance tests"
+ path: "/en/setup/service-agent/java-agent/readme#plugin-development-guide"
+
+ - name: "Other language agents"
+ path: "/en/setup/readme#language-agents-in-service"
+ - name: "Service Mesh"
+ catalog:
+ - name: "Observe Istio Control Plane"
+ path: "/en/setup/istio/readme"
+ - name: "Observe Service Mesh"
+ path: "/en/setup/envoy/als_setting"
+ - name: "Proxy"
+ catalog:
+ - name: "Envoy Proxy"
+ path: "https://www.envoyproxy.io/"
+ catalog:
+ - name: "Send Envoy metrics to SkyWalking with / without Istio"
+ path: "/en/setup/envoy/metrics_service_setting"
+ - name: "Backend, UI and CLI setup document"
+ path: "/en/setup/backend/backend-ui-setup"
+ catalog:
+ - name: "Backend setup document"
+ path: "/en/setup/backend/backend-setup"
+ catalog:
+ - name: "Configuration Vocabulary"
+ path: "/en/setup/backend/configuration-vocabulary"
+ - name: "Overriding settings"
+ path: "/en/setup/backend/backend-setting-override"
+
+ - name: "IP and port setting"
+ path: "/en/setup/backend/backend-ip-port"
+
+ - name: "Backend init mode startup"
+ path: "/en/setup/backend/backend-init-mode"
+
+ - name: "Cluster management"
+ path: "/en/setup/backend/backend-cluster"
+
+ - name: "Deploy in kubernetes"
+ path: "/en/setup/backend/backend-k8s"
+ - name: "Choose storage"
+ path: "/en/setup/backend/backend-storage"
+ - name: "Set receivers"
+ path: "/en/setup/backend/backend-receivers"
+ - name: "Open fetchers"
+ path: "/en/setup/backend/backend-fetcher"
+ - name: "Trace sampling"
+ path: "/en/setup/backend/trace-sampling"
+ - name: "Slow DB statement threshold"
+ path: "/en/setup/backend/slow-db-statement"
+ - name: "OAL scripts"
+ path: "/en/guides/backend-oal-scripts"
+ - name: "Alarm"
+ path: "/en/setup/backend/backend-alarm"
+ - name: "Advanced deployment options"
+ path: "/en/setup/backend/advanced-deployment"
+ - name: "Metrics exporter"
+ path: "/en/setup/backend/metrics-exporter"
+ - name: "Time To Live (TTL)"
+ path: "/en/setup/backend/ttl"
+ - name: "Dynamic Configuration"
+ path: "/en/setup/backend/dynamic-config"
+ - name: "Uninstrumented Gateways"
+ path: "/en/setup/backend/uninstrumented-gateways"
+ - name: "Apdex threshold"
+ path: "/en/setup/backend/apdex-threshold"
+ - name: "Service Grouping"
+ path: "/en/setup/backend/service-auto-grouping"
+ - name: "Group Parameterized Endpoints"
+ path: "/en/setup/backend/endpoint-grouping-rules"
+ - name: "OpenTelemetry Metrics Analysis"
+ path: "/backend-receivers.md#opentelemetry-receiver"
+ - name: "Meter Analysis"
+ path: "/en/setup/backend/backend-meter"
+ - name: "Spring Sleuth Metrics Analysis"
+ path: "/en/setup/backend/spring-sleuth-setup"
+ - name: "UI setup document"
+ path: "/en/setup/backend/ui-setup"
+
+ - name: "CLI setup document"
+ path: "https://github.com/apache/skywalking-cli"
+
+ - name: "UI Introduction"
+ path: "/en/ui/readme"
+
+ - name: "Contributing Guides"
+ path: "/en/guides/readme"
+ catalog:
+ - name: "Contact us"
+ path: "/en/guides/readme#contact-us"
+ - name: "Process to become official Apache SkyWalking Committer"
+ path: "/en/guides/asf/committer"
+ - name: "Compiling Guide"
+ path: "/en/guides/How-to-build"
+ - name: "Agent plugin development guide"
+ path: "/en/guides/Java-Plugin-Development-Guide"
+
+ - name: "Protocols"
+ path: "/en/protocols/readme"
+
+ - name: "FAQs"
+ path: "/en/FAQ/readme"
+
+
+
+
+