data/docs.yml

- type: Quick Start
  buttonText: showcase
  list:
    - name: SkyWalking Showcase
      icon: skywalking
      description: A demo music application to showcase features of Apache SkyWalking in action.
      user: apache
      repo: skywalking-showcase
      repoUrl: https://github.com/apache/skywalking-showcase.git
      docs:
        - version: Next
          versionName: showcase for v9
          link: /docs/skywalking-showcase/next/readme/

    - name: SkyWalking Website
      icon: skywalking-website
      description: This is the repository including all source codes of http://skywalking.apache.org
      user: apache
      repo: skywalking-website

- type: SkyWalking Servers
  description:
  list:
    - name:
      descriptionItem: SkyWalking servers include the Observability Analysis Platform(OAP) server and native UI server. SkyWalking primary docs introduce concepts, designs, setup, and corresponding APIs referred to telemetry data reports and queries.
  
    - name: SkyWalking
      icon: skywalking
      description: SkyWalking primary repository and docs.
      user: apache
      repo: skywalking
      repoUrl: https://github.com/apache/skywalking.git
      extraContributors:
        - login: Adrian Cole
        - login: github-actions[bot]
        - login: dependabot[bot]
      docs:
        - version: Next
          link: /docs/main/next/readme/
        - version: v9.5.0
          link: /docs/main/v9.5.0/readme/
          commitId: 727a722c735d7823cb3109c676086df99ab6b180
        - version: v9.4.0
          link: /docs/main/v9.4.0/readme/
          commitId: 520d531fff8d2ba9687ff8b9086b7e27033a82bb
        - version: v9.3.0
          link: /docs/main/v9.3.0/readme/
          commitId: 7ad04062b20ecf2bdb0afc4ba8c6ce353e5ae4d8
        - version: v9.2.0
          link: /docs/main/v9.2.0/readme/
          commitId: cb8845a1dd8a0efaa8a6c8e6cb3b7c378729a401
        - version: v9.1.0
          link: /docs/main/v9.1.0/readme/
          commitId: 33402ce87d4ac8f378f92ab36544b6af18ff0bc6
        - version: v9.0.0
          link: /docs/main/v9.0.0/readme/
          commitId: 89644fe68f0c4a7777fa011b56ba2d2a0d369e9f

    - name: Booster UI
      icon: rocketbot-ui
      description: The native UI for SkyWalking v9
      user: apache
      repo: skywalking-booster-ui

- type: Grafana Plugins
  description:
  list:
    - name:
      descriptionItem: Metrics visualization on Grafana is supported through PromQL. Please refer to the primary docs for more details. 
  
    - name: Plugin for Service Topology
      icon: skywalking
      description: SkyWalking Grafana Plugins provide extensions to visualize topology on Grafana.
      user: apache
      repo: skywalking-grafana-plugins
      docs:
        - version: Next
          link: https://github.com/apache/skywalking-grafana-plugins

- type: Agents
  description:
  list:
    - name: Java Agent
      icon: java-agent
      description: The Java Agent for Apache SkyWalking, which provides the native tracing/metrics/logging/event/profiling abilities for Java projects.
      user: apache
      repo: skywalking-java
      repoUrl: https://github.com/apache/skywalking-java.git
      docs:
        - version: Next
          link: /docs/skywalking-java/next/readme/
        - version: v8.16.0
          link: /docs/skywalking-java/v8.16.0/readme/
          commitId: fbcdf29fcc677ed702b0c40e862cc36b8410e9cb
        - version: v8.15.0
          link: /docs/skywalking-java/v8.15.0/readme/
          commitId: 24858574474e0656e13c592a2c38d83b0637c7f5
        - version: v8.14.0
          link: /docs/skywalking-java/v8.14.0/readme/
          commitId: 0b522563b2a5c742a71ec47189097363cc6c2c27
        - version: v8.13.0
          link: /docs/skywalking-java/v8.13.0/readme/
          commitId: 0109480bc00b6ad6d49a87758b23ae0df9b086b3
        - version: v8.12.0
          link: /docs/skywalking-java/v8.12.0/readme/
          commitId: 5719d47a612569001a131b9b98a0ed7e6a88a1a9
        - version: v8.11.0
          link: /docs/skywalking-java/v8.11.0/readme/
          commitId: 1b4af0a47fbcc28abac1dc496c2b3483d943f8dc
        - version: v8.10.0
          link: /docs/skywalking-java/v8.10.0/readme/
          commitId: bc729c3788aa47c7eb0c0f4b29370ece68f52f86
        - version: v8.9.0
          link: /docs/skywalking-java/v8.9.0/readme/
          commitId: 8b49c1d935fa22e73f8b7395527ef069f5476b6a
        - version: v8.8.0
          link: /docs/skywalking-java/v8.8.0/readme/
          commitId: 3bc0d47ff579616c593af562ef245dc1675521e0

    - name: Python Agent
      icon: python-agent
      description: The Python Agent for Apache SkyWalking, which provides the native tracing/metrics/logging/profiling abilities for Python projects.
      user: apache
      repo: skywalking-python
      repoUrl: https://github.com/apache/skywalking-python.git
      docs:
        - version: Next
          link: /docs/skywalking-python/next/readme/
        - version: v1.0.1
          link: /docs/skywalking-python/next/readme/
          commitId: 4717e1b66da9fd9025ef8e7f5f9bab1c4b1e409e

    - name: NodeJS Agent
      icon: nodejs-agent
      description: The NodeJS Agent for Apache SkyWalking, which provides the native tracing abilities for NodeJS projects.
      user: apache
      repo: skywalking-nodejs
      docs:
        - version: v0.6.0
          link: https://github.com/apache/skywalking-nodejs/tree/v0.6.0

    - name: Go Agent
      icon: skywalking-go
      description: The Go Agent for Apache SkyWalking, which provides the native tracing/metrics/logging abilities for Golang projects.
      user: apache
      repo: skywalking-go
      repoUrl: https://github.com/apache/skywalking-go.git
      docs:
        - version: Next
          link: /docs/skywalking-go/next/readme/
        - version: v0.2.0
          link: /docs/skywalking-go/v0.2.0/readme/
          commitId: 637845b76c9949a495a14ecf0e7e2f0e385701c8

    - name: Rust Agent
      icon: sw-rust
      description: The Rust Agent for Apache SkyWalking, which provides the native tracing/metrics/logging abilities for Rust projects.
      user: apache
      repo: skywalking-rust
      docs:
        - version: Next
          link: https://github.com/apache/skywalking-rust
        - version: v0.8.0
          link: https://github.com/apache/skywalking-rust/tree/v0.8.0

    - name: PHP Agent
      icon: php-agent
      description: The PHP Agent for Apache SkyWalking, which provides the native tracing abilities for PHP projects.
      user: apache
      repo: skywalking-php
      repoUrl: https://github.com/apache/skywalking-php.git
      docs:
        - version: Next
          link: /docs/skywalking-php/next/readme/
        - version: v0.5.0
          link: /docs/skywalking-php/v0.5.0/readme/
          commitId: 87412676f1e31ccd0a462bd181b522086e9bacc2

    - name: Client JavaScript
      icon: js-agent
      description: Apache SkyWalking Client-side JavaScript exception and tracing library.
      user: apache
      repo: skywalking-client-js
      docs:
        - version: v0.10.0
          link: https://github.com/apache/skywalking-client-js/tree/v0.10.0

    - name: Nginx LUA Agent
      icon: nginx-lua-agent
      description: SkyWalking Nginx Agent provides the native tracing capability for Nginx powered by Nginx LUA module.
      user: apache
      repo: skywalking-nginx-lua
      docs:
        - version: v0.6.0
          link: https://github.com/apache/skywalking-nginx-lua/tree/v0.6.0

    - name: Kong Agent
      icon: kong-agent
      description: SkyWalking Kong Agent provides the native tracing capability.
      user: apache
      repo: skywalking-kong
      docs:
        - version: v0.2.0
          link: https://github.com/apache/skywalking-kong/tree/v0.2.0

    - name: SkyWalking Satellite
      icon: skywalking-satellite
      description: A lightweight collector/sidecar could be deployed closing to the target monitored system, to collect metrics, traces, and logs.
      user: apache
      repo: skywalking-satellite
      repoUrl: https://github.com/apache/skywalking-satellite.git
      docs:
        - version: Next
          link: /docs/skywalking-satellite/next/readme/
        - version: v1.2.0
          link: /docs/skywalking-satellite/v1.2.0/readme/
          commitId: 38a86a5408c30b805bce2b5c79b7e8000e917a68

    - name: Kubernetes Event Exporter
      icon: kubernetes
      description: Watch, filter, and send Kubernetes events into Apache SkyWalking.
      user: apache
      repo: skywalking-kubernetes-event-exporter
      docs:
        - version: Next
          link: https://github.com/apache/skywalking-kubernetes-event-exporter/tree/main#configurations
        - version: 1.0.0
          link: https://github.com/apache/skywalking-kubernetes-event-exporter/tree/1.0.0#configurations

    - name: SkyWalking Rover
      icon: skywalking
      description: Metrics collector and profiler powered by eBPF to diagnose CPU and network performance.
      user: apache
      repo: skywalking-rover
      repoUrl: https://github.com/apache/skywalking-rover.git
      docs:
        - version: Next
          link: /docs/skywalking-rover/next/readme/
        - version: v0.5.0
          link: /docs/skywalking-rover/v0.5.0/readme/
          commitId: 9da447851549b20d12e762d8e180be47f7b7b986

- type: Operation
  description:
  list:
    - name: SkyWalking CLI
      icon: skywalking-cli
      description: SkyWalking CLI is a command interaction tool for the SkyWalking user or OPS team.
      user: apache
      repo: skywalking-cli
      docs:
        - version: v0.12.0
          link: https://github.com/apache/skywalking-cli/tree/0.12.0

    - name: Kubernetes Helm
      icon: helm
      description: SkyWalking Kubernetes repository provides ways to install and configure SkyWalking in a Kubernetes cluster. The scripts are written in Helm 3.
      user: apache
      repo: skywalking-kubernetes
      docs:
        - version: v4.5.0
          link: https://github.com/apache/skywalking-kubernetes/tree/v4.5.0

    - name: SkyWalking Cloud on Kubernetes
      icon: kubernetes
      description: A bridge project between Apache SkyWalking and Kubernetes.
      user: apache
      repo: skywalking-swck
      repoUrl: https://github.com/apache/skywalking-swck.git
      docs:
        - version: Next
          link: /docs/skywalking-swck/next/readme/
        - version: v0.8.0
          link: /docs/skywalking-swck/v0.8.0/readme/
          commitId: 502610b1cc71940cb36107ec335bd47aa829a781


- type: Protocol
  description:
  list:
    - name: Data Collect Protocol
      icon: data-collection-protocol
      description: Apache SkyWalking data collect protocol.
      user: apache
      repo: skywalking-data-collect-protocol

    - name: Query Protocol
      icon: skywalking-query
      description: Query Protocol defines the communication protocol in query stage. SkyWalking native UI and CLI use this protocol to fetch data from the backend consistently.
      user: apache
      repo: skywalking-query-protocol

    - name: Go API
      icon: go-api
      description: Apache SkyWalking APIs in Golang
      user: apache
      repo: skywalking-goapi

- type: Database
  list:
    - name:
      descriptionItem: BanyanDB server and clients are incubated under SkyWalking umbrella, which aims to provide better native supports to the SkyWalking APM use cases, including better performance and lower resource costs.
      
    - name: BanyanDB
      icon: banyan-db
      description: An observability database aims to ingest, analyze and store Metrics, Tracing and Logging data.
      user: apache
      repo: skywalking-banyandb
      repoUrl: https://github.com/apache/skywalking-banyandb.git
      docs:
        - version: Next
          link: /docs/skywalking-banyandb/next/readme/
        - version: v0.4.0
          link: /docs/skywalking-banyandb/v0.4.0/readme/
          commitId: df34a83663d66af9687ff484884ceae669c83980
    - name: BanyanDB Java Client
      icon: banyan-db
      description: The client implement for SkyWalking BanyanDB in Java
      user: apache
      repo: skywalking-banyandb-java-client
      docs:
        - version: Next
          link: https://github.com/apache/skywalking-banyandb-java-client/blob/main/README.md
        - version: v0.3.1
          link: https://github.com/apache/skywalking-banyandb-java-client/blob/v0.3.1/README.md
- type: Support tools for development and testing
  buttonText: tools
  description: SkyWalking native tools to support development and testing.
  list:
    - name: Agent Test Tool
      icon: skywalking-agent-test-tool
      description: SkyWalking Agent Test Tool is a tremendously useful test tools suite in a wide variety of languages of Agent. Includes mock collector and validator.
      user: apache
      repo: skywalking-agent-test-tool

    - name: SkyWalking Eyes
      icon: skywalking-eyes
      description: A full-featured license tool to check and fix license headers and resolve dependencies' licenses.
      user: apache
      repo: skywalking-eyes
      docs:
        - version: v0.4.0
          link: https://github.com/apache/skywalking-eyes/tree/v0.4.0

    - name: SkyWalking Infra E2E
      icon: skywalking-agent-test-tool
      description: An End-to-End Testing framework that aims to help developers to set up, debug, and verify E2E tests with ease.
      user: apache
      repo: skywalking-infra-e2e
      repoUrl: https://github.com/apache/skywalking-infra-e2e.git
      docs:
        - version: Next
          link: /docs/skywalking-infra-e2e/next/readme/
        - version: v1.1.0
          link: /docs/skywalking-infra-e2e/v1.1.0/readme/
          commitId: 996ed8902e941e2883fcf0ac5b3090364942d205

- type: Archived Repositories
  buttonText: Archived
  list:
    - name:
      descriptionItem: All following repositories are archived, which means there are no further activities happening there. 
      

    - name: (Archived) Docker Files
      description: Docker files for Apache SkyWalking(version <= 8.7.0) javaagent, OAP, and UI.
      user: apache
      repo: skywalking-docker

    - name: (Archived) Rocketbot UI
      description: Apache SkyWalking UI for SkyWalking v6/v7/v8
      user: apache
      repo: skywalking-rocketbot-ui

    - name: (Archived) Legacy UI
      description: The web UI for skywalking APM v5
      user: apache
      repo: skywalking-ui

    - name: (Archived) OAL Generator
      description: Observability Analysis Language(OAL) Tool is a code generation tool for SkyWalking. From Nov. 6th 2018, merged into main codebase.
      user: apache
      repo: skywalking-oal-tool

- type: Ecosystem
  list:
    - name:
      descriptionItem: All following repositories are a part of SkyWalking ecosystem, as agent implementations, extensions, or tools. All the source codes and their distributions are not belonging to the Apache Software Foundation.

    - name: SkyAPM-dotnet
      description: SkyAPM-dotnet provides the native support agent in C# and .NETStandard platform, with the helps from Apache SkyWalking committer team.
      user: SkyAPM
      repo: SkyAPM-dotnet

    - name: cpp2sky
      description: Distributed tracing and monitor SDK in CPP for Apache SkyWalking APM.
      user: SkyAPM
      repo: cpp2sky

    - name: SourceMarker
      description: JetBrains-powered plugin. Continuous Feedback for Developers / Feedback-Driven Development Tool.
      user: sourceplusplus
      repo: SourceMarker

    - name: Java Plugin Extensions
      description: Java agent plugin extensions for Apache SkyWalking.
      user: SkyAPM
      repo: java-plugin-extensions

    - name: uranus
      description: A tool helps on locating witness class for Apache SkyWalking plugin.
      user: SkyAPM
      repo: uranus

    - name: (outdated) CN Documentations
      description: The CN translation version of Apache SkyWalking document. This is NOT official docs and has been out-dated for years.
      user: SkyAPM
      repo: document-cn-translation-of-skywalking

- type: Ecosystem Retired Projects
  list:
    - name:
      descriptionItem: All following repositories are a part of SkyWalking ecosystem, but now are retired and archived as read-only.

    - name: (Retired) Transporter Plugins
      description: 3rd-party transporter implementation of Apache SkyWalking. No one is maintaining this.
      user: SkyAPM
      repo: transporter-plugin-for-skywalking
      
    - name: (Retired) Go2Sky
      description: Replaced by https://skywalking.apache.org/docs/#GoAgent auto-instrument agent.
      user: SkyAPM
      repo: go2sky

    - name: (Retired) Go2Sky Plugins
      description: Replaced by https://skywalking.apache.org/docs/#GoAgent auto-instrument agent.
      user: SkyAPM
      repo: go2sky-plugins

    - name: (Retired) SkyAPM PHP Agent
      description: Replaced by https://skywalking.apache.org/docs/#PHPAgent
      user: SkyAPM
      repo: SkyAPM-php-sdk

    - name: (Retired) SkyAPM Node.js
      description: Replaced by https://skywalking.apache.org/docs/#NodeJSAgent
      user: SkyAPM
      repo: SkyAPM-nodejs