This is an automated email from the ASF dual-hosted git repository. wusheng pushed a commit to branch marketplace-docs in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit a24166c1b36b3b641772326ed2bc4bc256d12c12 Author: Wu Sheng <[email protected]> AuthorDate: Mon Jun 10 23:17:39 2024 +0800 Add marketplace docs. --- docs/en/changes/changes.md | 6 +- docs/en/setup/backend/marketplace.md | 7 ++ docs/menu.yml | 198 ++++++++++++++++++----------------- 3 files changed, 111 insertions(+), 100 deletions(-) diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md index a660906415..fa0732a064 100644 --- a/docs/en/changes/changes.md +++ b/docs/en/changes/changes.md @@ -4,15 +4,17 @@ #### OAP Server + * Fix wrong indices in the eBPF Profiling related models. * Support exclude the specific namespaces traffic in the eBPF Access Log receiver. - #### UI #### Documentation -* Update the version description supported by zabbix receiver. +* Update the version description supported by zabbix receiver. +* Move the Official Dashboard docs to marketplace docs. +* Add marketplace introduction docs under `quick start` menu to reduce the confusion of finding feature docs. All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/205?closed=1) diff --git a/docs/en/setup/backend/marketplace.md b/docs/en/setup/backend/marketplace.md new file mode 100644 index 0000000000..056d4522b3 --- /dev/null +++ b/docs/en/setup/backend/marketplace.md @@ -0,0 +1,7 @@ +# Marketplace + +**Marketplace** is the first UI menu on the SkyWalking native UI. It is the place where you can install and manage SkyWalking +native and 3rd-party components. +The native out-of-box features are listed in the marketplace. Follow the `Documentation` guidance to set up required components. +Once the services of those layers are detected by SkyWalking, the relative menu will show up on the left automatically. + diff --git a/docs/menu.yml b/docs/menu.yml index 8c750719f5..18fd50acbb 100644 --- a/docs/menu.yml +++ b/docs/menu.yml @@ -44,6 +44,106 @@ catalog: path: "/en/setup/backend/backend-docker" - name: "Run with Kubernetes" path: "/en/setup/backend/backend-k8s" + - name: "Find out-of-box Features in Marketplace" + path: "/en/setup/backend/marketplace" + - name: "Marketplace" + 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: "Virtual Database" + path: "/en/setup/service-agent/virtual-database" + - name: "Virtual Cache" + path: "/en/setup/service-agent/virtual-cache" + - name: "Virtual MQ" + path: "/en/setup/service-agent/virtual-mq" + - name: "Service Mesh" + catalog: + - name: "Observe Service Mesh through Access Log Service (ALS)" + path: "/en/setup/envoy/als_setting" + - name: "Observe Service Mesh through Zipkin traces" + path: "/en/setup/zipkin/tracing" + - name: "Observe Control Plane (Istio)" + path: "/en/setup/istio/readme" + - name: "Observe Data Plane (Envoy)" + path: "/en/setup/envoy/metrics_service_setting" + - name: "Profile Pod's Network" + path: "/en/setup/backend/backend-k8s-network-monitoring" + - name: "Kubernetes" + catalog: + - name: "Observe Kubernetes" + path: "/en/setup/backend/backend-k8s-monitoring" + - name: "kube-state-metrics + cAdvisor" + path: "/en/setup/backend/backend-k8s-monitoring-metrics-cadvisor" + - name: "Rover" + path: "/en/setup/backend/backend-k8s-monitoring-rover" + - name: "Profile Pod's Network" + path: "/en/setup/backend/backend-k8s-network-monitoring" + - name: "Infrastructure Monitoring" + catalog: + - name: "Linux Monitoring" + path: "/en/setup/backend/backend-vm-monitoring" + - name: "Windows Monitoring" + path: "/en/setup/backend/backend-win-monitoring" + - name: "AWS Cloud Monitoring" + catalog: + - name: "EKS Monitoring" + path: "/en/setup/backend/backend-aws-eks-monitoring" + - name: "S3 Monitoring" + path: "/en/setup/backend/backend-aws-s3-monitoring" + - name: "AWS DynamoDB" + path: "/en/setup/backend/backend-aws-dynamodb-monitoring" + - name: "AWS API Gateway" + path: "/en/setup/backend/backend-aws-api-gateway-monitoring" + - name: "Browser Monitoring" + path: "/en/setup/service-agent/browser-agent" + - name: "Gateway Monitoring" + catalog: + - name: "Nginx Monitoring" + path: "/en/setup/backend/backend-nginx-monitoring" + - name: "APISIX Monitoring" + path: "/en/setup/backend/backend-apisix-monitoring" + - name: "AWS API Gateway" + path: "/en/setup/backend/backend-aws-api-gateway-monitoring" + - name: "Database Monitoring" + catalog: + - name: "MySQL/MariaDB Server" + path: "/en/setup/backend/backend-mysql-monitoring" + - name: "PostgreSQL Server" + path: "/en/setup/backend/backend-postgresql-monitoring" + - name: "AWS DynamoDB" + path: "/en/setup/backend/backend-aws-dynamodb-monitoring" + - name: "Redis" + path: "/en/setup/backend/backend-redis-monitoring" + - name: "Elasticsearch" + path: "/en/setup/backend/backend-elasticsearch-monitoring" + - name: "MongoDB" + path: "/en/setup/backend/backend-mongodb-monitoring" + - name: "BookKeeper" + path: "/en/setup/backend/backend-bookkeeper-monitoring" + - name: "ClickHouse" + path: "/en/setup/backend/backend-clickhouse-monitoring" + - name: "MQ Monitoring" + catalog: + - name: "RabbitMQ" + path: "/en/setup/backend/backend-rabbitmq-monitoring" + - name: "Kafka" + path: "/en/setup/backend/backend-kafka-monitoring" + - name: "Pulsar" + path: "/en/setup/backend/backend-pulsar-monitoring" + - name: "RocketMQ" + path: "/en/setup/backend/backend-rocketmq-monitoring" + - name: "ActiveMQ" + path: "/en/setup/backend/backend-activemq-monitoring" + - name: "Self Observability" + catalog: + - name: "OAP self telemetry" + path: "/en/setup/backend/dashboards-so11y" + - name: "Satellite self telemetry" + path: "/en/setup/backend/dashboards-so11y-satellite" - name: "Configuration Vocabulary" path: "/en/setup/backend/configuration-vocabulary" - name: "Advanced Setup" @@ -174,104 +274,6 @@ catalog: path: "/en/ui/readme" - name: "Grafana UI" path: "/en/setup/backend/ui-grafana" - - 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: "Virtual Database" - path: "/en/setup/service-agent/virtual-database" - - name: "Virtual Cache" - path: "/en/setup/service-agent/virtual-cache" - - name: "Virtual MQ" - path: "/en/setup/service-agent/virtual-mq" - - name: "Service Mesh" - catalog: - - name: "Observe Service Mesh through Access Log Service (ALS)" - path: "/en/setup/envoy/als_setting" - - name: "Observe Service Mesh through Zipkin traces" - path: "/en/setup/zipkin/tracing" - - name: "Observe Control Plane (Istio)" - path: "/en/setup/istio/readme" - - name: "Observe Data Plane (Envoy)" - path: "/en/setup/envoy/metrics_service_setting" - - name: "Profile Pod's Network" - path: "/en/setup/backend/backend-k8s-network-monitoring" - - name: "Kubernetes" - catalog: - - name: "Observe Kubernetes" - path: "/en/setup/backend/backend-k8s-monitoring" - - name: "kube-state-metrics + cAdvisor" - path: "/en/setup/backend/backend-k8s-monitoring-metrics-cadvisor" - - name: "Rover" - path: "/en/setup/backend/backend-k8s-monitoring-rover" - - name: "Profile Pod's Network" - path: "/en/setup/backend/backend-k8s-network-monitoring" - - name: "Infrastructure Monitoring" - catalog: - - name: "Linux Monitoring" - path: "/en/setup/backend/backend-vm-monitoring" - - name: "Windows Monitoring" - path: "/en/setup/backend/backend-win-monitoring" - - name: "AWS Cloud Monitoring" - catalog: - - name: "EKS Monitoring" - path: "/en/setup/backend/backend-aws-eks-monitoring" - - name: "S3 Monitoring" - path: "/en/setup/backend/backend-aws-s3-monitoring" - - name: "AWS DynamoDB" - path: "/en/setup/backend/backend-aws-dynamodb-monitoring" - - name: "AWS API Gateway" - path: "/en/setup/backend/backend-aws-api-gateway-monitoring" - - name: "Browser Monitoring" - path: "/en/setup/service-agent/browser-agent" - - name: "Gateway Monitoring" - catalog: - - name: "Nginx Monitoring" - path: "/en/setup/backend/backend-nginx-monitoring" - - name: "APISIX Monitoring" - path: "/en/setup/backend/backend-apisix-monitoring" - - name: "AWS API Gateway" - path: "/en/setup/backend/backend-aws-api-gateway-monitoring" - - name: "Database Monitoring" - catalog: - - name: "MySQL/MariaDB Server" - path: "/en/setup/backend/backend-mysql-monitoring" - - name: "PostgreSQL Server" - path: "/en/setup/backend/backend-postgresql-monitoring" - - name: "AWS DynamoDB" - path: "/en/setup/backend/backend-aws-dynamodb-monitoring" - - name: "Redis" - path: "/en/setup/backend/backend-redis-monitoring" - - name: "Elasticsearch" - path: "/en/setup/backend/backend-elasticsearch-monitoring" - - name: "MongoDB" - path: "/en/setup/backend/backend-mongodb-monitoring" - - name: "BookKeeper" - path: "/en/setup/backend/backend-bookkeeper-monitoring" - - name: "ClickHouse" - path: "/en/setup/backend/backend-clickhouse-monitoring" - - name: "MQ Monitoring" - catalog: - - name: "RabbitMQ" - path: "/en/setup/backend/backend-rabbitmq-monitoring" - - name: "Kafka" - path: "/en/setup/backend/backend-kafka-monitoring" - - name: "Pulsar" - path: "/en/setup/backend/backend-pulsar-monitoring" - - name: "RocketMQ" - path: "/en/setup/backend/backend-rocketmq-monitoring" - - name: "ActiveMQ" - path: "/en/setup/backend/backend-activemq-monitoring" - - name: "Self Observability" - catalog: - - name: "OAP self telemetry" - path: "/en/setup/backend/dashboards-so11y" - - name: "Satellite self telemetry" - path: "/en/setup/backend/dashboards-so11y-satellite" - name: "CLI Setup" path: "https://github.com/apache/skywalking-cli"; - name: "Mock Data Generator Setup"
