Reconstruction doc menu for v9 (#8780)
This commit is contained in:
吴晟 Wu Sheng
GitHub
parent
d08faefe5f
commit
eb5f755918
|
|
@ -167,6 +167,7 @@ NOTICE, this sharding concept is NOT just for splitting data into different data
|
|||
|
||||
#### Documentation
|
||||
|
||||
* Reconstruction doc menu for v9.
|
||||
* Update backend-alarm.md doc, support op "=" to "==".
|
||||
* Update backend-meter.md doc .
|
||||
* Add <STAM: Enhancing Topology Auto Detection For A Highly Distributed and Large-Scale Application System> paper.
|
||||
|
|
|
|||
|
|
@ -34,4 +34,3 @@ It is very important to end users that SkyWalking has the ability to accept and
|
|||
## What is next?
|
||||
- See [probe Introduction](probe-introduction.md) to learn about SkyWalking's probe groups.
|
||||
- From [backend overview](backend-overview.md), you can understand what the backend does after it receives probe data.
|
||||
- If you want to customize the UI, start with the [UI overview](ui-overview.md) document.
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
# Visualization
|
||||
The SkyWalking native UI provides a default solution for visualization.
|
||||
It provides observability related graphs
|
||||
on overview, service, service instance, endpoint, trace, and alarm,
|
||||
such as topology maps, dependency graphs, heatmaps, etc.
|
||||
|
||||
We know that many of our users have integrated SkyWalking
|
||||
into their own products.
|
||||
If you would like to do that too, please refer to the [SkyWalking query protocol](../protocols/README.md#query-protocol).
|
||||
|
||||
|
|
@ -5,7 +5,7 @@ There are many ways you can contribute to the SkyWalking community.
|
|||
- Download our [releases](http://skywalking.apache.org/downloads/), try to monitor your applications, and provide feedback to us.
|
||||
- Read our source codes. For details, reach out to us.
|
||||
- If you find any bugs, [submit an issue](https://github.com/apache/skywalking/issues). You can also try to fix it.
|
||||
- Find [help wanted issues](https://github.com/apache/skywalking/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). This is a good place for you to start.
|
||||
- Find [`good first issue` issues](https://github.com/apache/skywalking/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). This is a good place for you to start.
|
||||
- Submit an issue or start a discussion at [GitHub issue](https://github.com/apache/skywalking/issues/new).
|
||||
- See all mail list discussions at [website list review](https://lists.apache.org/list.html?dev@skywalking.apache.org).
|
||||
If you are already a SkyWalking committer, you can log in and use the mail list in the browser mode. Otherwise, subscribe following the step below.
|
||||
|
|
@ -13,11 +13,10 @@ If you are already a SkyWalking committer, you can log in and use the mail list
|
|||
Mail to `dev-subscribe@skywalking.apache.org`, and follow the instructions in the reply to subscribe to the mail list.
|
||||
|
||||
## Contact Us
|
||||
All of the following channels are open to the community.
|
||||
* Submit an [issue](https://github.com/apache/skywalking/issues)
|
||||
All the following channels are open to the community.
|
||||
* Submit an [issue](https://github.com/apache/skywalking/issues) for an issue or feature proposal.
|
||||
* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`. Follow the instructions in the reply to subscribe to the mail list.
|
||||
* [Gitter](https://gitter.im/openskywalking/Lobby)
|
||||
* QQ Group: 392443393
|
||||
* Submit a [discussion](https://github.com/apache/skywalking/issues) to ask questions.
|
||||
|
||||
## Become an official Apache SkyWalking Committer
|
||||
The PMC assesses the contributions of every contributor, including their code contributions. It also promotes, votes on, and invites new committers and PMC members according to the Apache guides.
|
||||
|
|
@ -38,7 +37,7 @@ and leaves them for `maven-failsafe-plugin` to run, which is bound to the `verif
|
|||
Therefore, to run the UTs, try `./mvnw clean test`, which only runs the UTs but not the ITs.
|
||||
|
||||
If you would like to run the ITs, please set the property `skipITs` to false
|
||||
as well as the the profiles of the modules whose ITs you want to run.
|
||||
as well as the profiles of the modules whose ITs you want to run.
|
||||
E.g. if you would like to run the ITs in `oap-server`, try `./mvnw -Pbackend clean verify -DskipITs=false`,
|
||||
and if you would like to run all the ITs, simply run `./mvnw clean verify -DskipITs=false`.
|
||||
|
||||
|
|
@ -115,16 +114,6 @@ storage implementor in addition to the official one.
|
|||
hasn't yet provided, add a new receiver.
|
||||
You would most likely have to add a new source and scope. To learn how to do this, read the document.
|
||||
|
||||
### UI developer
|
||||
Our UI consists of static pages and the web container.
|
||||
|
||||
- [RocketBot UI](https://github.com/apache/skywalking-rocketbot-ui) is SkyWalking's primary UI since the 6.1 release.
|
||||
It is built with vue + typescript. Learn more at the rocketbot repository.
|
||||
- **Web container** source codes are in the `apm-webapp` module. This is a simple zuul proxy which hosts
|
||||
static resources and sends GraphQL query requests to the backend.
|
||||
- [Legacy UI repository](https://github.com/apache/skywalking-ui) is retained, but not included
|
||||
in SkyWalking releases since 6.0.0-GA.
|
||||
|
||||
### OAP backend dependency management
|
||||
> This section is only applicable to dependencies of the backend module.
|
||||
|
||||
|
|
|
|||
114
docs/menu.yml
114
docs/menu.yml
|
|
@ -50,8 +50,6 @@ catalog:
|
|||
path: "/en/concepts-and-designs/lal"
|
||||
- name: "Query in OAP"
|
||||
path: "/en/protocols/readme#query-protocol"
|
||||
- name: "UI"
|
||||
path: "/en/concepts-and-designs/ui-overview"
|
||||
- name: "CLI"
|
||||
path: "https://github.com/apache/skywalking-cli"
|
||||
- name: "Event"
|
||||
|
|
@ -59,12 +57,6 @@ catalog:
|
|||
|
||||
- name: "Setup"
|
||||
catalog:
|
||||
- name: "Server Agents"
|
||||
path: "/en/setup/service-agent/server-agents"
|
||||
- name: "Browser Agent"
|
||||
path: "/en/setup/service-agent/browser-agent"
|
||||
- name: "Compatibility"
|
||||
path: "/en/setup/service-agent/agent-compatibility"
|
||||
- name: "Backend"
|
||||
catalog:
|
||||
- name: "Quick Start"
|
||||
|
|
@ -79,34 +71,34 @@ catalog:
|
|||
path: "/en/setup/backend/configuration-vocabulary"
|
||||
- name: "Advanced Setup"
|
||||
catalog:
|
||||
- name: "Service Grouping"
|
||||
path: "/en/setup/backend/service-auto-grouping"
|
||||
- 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: "Choose Storage"
|
||||
path: "/en/setup/backend/backend-storage"
|
||||
- name: "Setup External Communication Channels"
|
||||
path: "/en/setup/backend/backend-expose"
|
||||
- name: "Kafka Fetcher"
|
||||
path: "/en/setup/backend/Kafka-fetcher"
|
||||
- name: "Advanced Deployment Options"
|
||||
path: "/en/setup/backend/advanced-deployment"
|
||||
- name: "Data Lifecycle. Time To Live (TTL)"
|
||||
path: "/en/setup/backend/ttl"
|
||||
- name: "Group Parameterized Endpoints"
|
||||
path: "/en/setup/backend/endpoint-grouping-rules"
|
||||
- name: "Dynamical Logging"
|
||||
path: "/en/setup/backend/dynamical-logging"
|
||||
- name: "Security(SSL/TLS/mTLS)"
|
||||
path: "/en/setup/backend/grpc-security"
|
||||
- name: "Setup Native Load Balancer"
|
||||
path: "/en/setup/backend/backend-load-balancer"
|
||||
- name: "Service Grouping"
|
||||
path: "/en/setup/backend/service-auto-grouping"
|
||||
- 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: "Choose Storage"
|
||||
path: "/en/setup/backend/backend-storage"
|
||||
- name: "Setup External Communication Channels"
|
||||
path: "/en/setup/backend/backend-expose"
|
||||
- name: "Kafka Fetcher"
|
||||
path: "/en/setup/backend/Kafka-fetcher"
|
||||
- name: "Advanced Deployment Options"
|
||||
path: "/en/setup/backend/advanced-deployment"
|
||||
- name: "Data Lifecycle. Time To Live (TTL)"
|
||||
path: "/en/setup/backend/ttl"
|
||||
- name: "Group Parameterized Endpoints"
|
||||
path: "/en/setup/backend/endpoint-grouping-rules"
|
||||
- name: "Dynamical Logging"
|
||||
path: "/en/setup/backend/dynamical-logging"
|
||||
- name: "Security(SSL/TLS/mTLS)"
|
||||
path: "/en/setup/backend/grpc-security"
|
||||
- name: "Setup Native Load Balancer"
|
||||
path: "/en/setup/backend/backend-load-balancer"
|
||||
- name: "Tracing"
|
||||
catalog:
|
||||
- name: "Trace Sampling"
|
||||
|
|
@ -141,34 +133,44 @@ catalog:
|
|||
catalog:
|
||||
- name: "Log Collecting And Analysis"
|
||||
path: "/en/setup/backend/log-analyzer"
|
||||
- name: "Self Observability"
|
||||
catalog:
|
||||
- name: "Backend Telemetry"
|
||||
path: "/en/setup/backend/backend-telemetry"
|
||||
- name: "Health Check"
|
||||
path: "/en/setup/backend/backend-health-check"
|
||||
- name: "Extension"
|
||||
catalog:
|
||||
- name: "Metrics Exporter"
|
||||
path: "/en/setup/backend/metrics-exporter"
|
||||
- name: "Dynamic Configuration"
|
||||
path: "/en/setup/backend/dynamic-config"
|
||||
- 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: "Send Envoy Metrics to SkyWalking with / without Istio"
|
||||
path: "/en/setup/envoy/metrics_service_setting"
|
||||
- name: "Infrastructure Monitoring"
|
||||
catalog:
|
||||
- name: "VMs Monitoring"
|
||||
path: "/en/setup/backend/backend-vm-monitoring"
|
||||
- name: "K8s Monitoring"
|
||||
path: "/en/setup/backend/backend-k8s-monitoring"
|
||||
- name: "UI Setup"
|
||||
path: "/en/setup/backend/ui-setup"
|
||||
- name: "Official Dashboards"
|
||||
catalog:
|
||||
- name: "General Service"
|
||||
catalog:
|
||||
- name: "Server Agents"
|
||||
path: "/en/setup/service-agent/server-agents"
|
||||
- name: "Compatibility"
|
||||
path: "/en/setup/service-agent/agent-compatibility"
|
||||
- name: "Service Mesh"
|
||||
catalog:
|
||||
- name: "Observe Service Mesh"
|
||||
path: "/en/setup/envoy/als_setting"
|
||||
- name: "Observe Control Plane (Istio)"
|
||||
path: "/en/setup/istio/readme"
|
||||
- name: "Observe Data Plane (Envoy)"
|
||||
path: "/en/setup/envoy/metrics_service_setting"
|
||||
- name: "Kubernetes Monitoring"
|
||||
path: "/en/setup/backend/backend-k8s-monitoring"
|
||||
- name: "Infrastructure Monitoring"
|
||||
catalog:
|
||||
- name: "Linux Monitoring"
|
||||
path: "/en/setup/backend/backend-vm-monitoring"
|
||||
- name: "Browser Monitoring"
|
||||
path: "/en/setup/service-agent/browser-agent"
|
||||
- name: "Self Observability"
|
||||
catalog:
|
||||
- name: "OAP Telemetry"
|
||||
path: "/en/setup/backend/backend-telemetry"
|
||||
- name: "Health Check"
|
||||
path: "/en/setup/backend/backend-health-check"
|
||||
- name: "CLI Setup"
|
||||
path: "https://github.com/apache/skywalking-cli"
|
||||
- name: "UI Introduction"
|
||||
|
|
|
|||
Loading…
Reference in New Issue