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 2021/11/10 04:58:52 UTC
[skywalking-website] 01/01: Add showcase repo and doc
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch showcase
in repository https://gitbox.apache.org/repos/asf/skywalking-website.git
commit 5b721d028e6ceef1274bee3142e2b5181aaa6de6
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Wed Nov 10 12:58:37 2021 +0800
Add showcase repo and doc
---
content/_index.html | 1 -
content/downloads/_index.md | 1 +
data/docs.yml | 26 ++++++++++++++++++++------
themes/docsy/layouts/partials/scripts.html | 6 ++++++
themes/docsy/layouts/projectDoc/baseof.html | 16 +++++++++++++++-
5 files changed, 42 insertions(+), 8 deletions(-)
diff --git a/content/_index.html b/content/_index.html
index 4b5eadd..5813958 100644
--- a/content/_index.html
+++ b/content/_index.html
@@ -213,4 +213,3 @@ For announcement of latest features etc on <a href="https://twitter.com/asfskywa
{{< /blocks/section >}}
-
diff --git a/content/downloads/_index.md b/content/downloads/_index.md
index 3af98c6..267cd60 100755
--- a/content/downloads/_index.md
+++ b/content/downloads/_index.md
@@ -3,6 +3,7 @@ title: "Downloads"
linkTitle: "Downloads"
descriptions: "Download the SkyWalking releases."
---
+
# Download the SkyWalking recommended releases
Use the links below to download the Apache SkyWalking from one of our mirrors.
diff --git a/data/docs.yml b/data/docs.yml
index 43db1fa..c028a9c 100644
--- a/data/docs.yml
+++ b/data/docs.yml
@@ -1,3 +1,17 @@
+- type: Quick Start
+ description:
+ list:
+ - name: SkyWalking Showcase
+ icon: S
+ description: A demo music applicatioon to demonstrate featues of Apache SkyWalking
+ user: apache
+ repo: skywalking-showcase
+ repoUrl: https://github.com/apache/skywalking-showcase.git
+ docs:
+ - version: current
+ link: /docs/skywalking-showcase/current/readme
+ commitId: doc
+
- type: General
description:
list:
@@ -12,7 +26,7 @@
link: /docs/main/latest/readme/
- version: v8.8.1
link: /docs/main/v8.8.1/readme/
- commitId: 96829da89ae0a7f4ef069ac97cbdc5b441efb434
+ commitId: 96829da89ae0a7f4ef069ac97cbdc5b441efb434
- version: v8.7.0
link: /docs/main/v8.7.0/readme/
commitId: 10f13c098d61ab149931860d11d347c9a960c8e2
@@ -84,7 +98,7 @@
docs:
- version: v0.5.0
link: https://github.com/apache/skywalking-nginx-lua/tree/v0.5.0
-
+
- name: Kong Agent
icon: K
description: SkyWalking Kong Agent provides the native tracing capability.
@@ -121,7 +135,7 @@
description: Watch, filter, and send Kubernetes events into Apache SkyWalking
user: apache
repo: skywalking-kubernetes-event-exporter
-
+
- name:
description: More language agents maintained by our community
descriptionLink: '#SkyAPM-dotnet'
@@ -176,7 +190,7 @@
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: G
description: Apache SkyWalking APIs in Golang
@@ -295,7 +309,7 @@
description: Java agent plugin extensions for Apache SkyWalking.
user: SkyAPM
repo: java-plugin-extensions
-
+
- name: Transporter Plugins
icon: T
description: 3rd-party transporter implementation of Apache SkyWalking.
@@ -307,7 +321,7 @@
description: A tool helps on locating witness class for Apache SkyWalking plugin.
user: SkyAPM
repo: uranus
-
+
- name: (Retired) SkyAPM Node.js
icon: O
description: SkyAPM Node.js is the Node.js instrumentation agent, this project wouldn't have any update, it has been retired and archived.
diff --git a/themes/docsy/layouts/partials/scripts.html b/themes/docsy/layouts/partials/scripts.html
index 7056ccc..b6dacdc 100644
--- a/themes/docsy/layouts/partials/scripts.html
+++ b/themes/docsy/layouts/partials/scripts.html
@@ -18,4 +18,10 @@
{{ $js := $js | minify | fingerprint }}
<script src="{{ $js.RelPermalink }}" integrity="{{ $js.Data.Integrity }}" crossorigin="anonymous"></script>
{{ end }}
+
+<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+<script>
+ window.onload = () => mermaid.init(undefined, ".language-mermaid");
+</script>
+
{{ partial "hooks/body-end.html" . }}
diff --git a/themes/docsy/layouts/projectDoc/baseof.html b/themes/docsy/layouts/projectDoc/baseof.html
index ab085b4..40b7660 100644
--- a/themes/docsy/layouts/projectDoc/baseof.html
+++ b/themes/docsy/layouts/projectDoc/baseof.html
@@ -13,8 +13,22 @@
<div class="td-main">
<div class="row flex-xl-nowrap">
<div class="col-12 col-md-3 col-xl-2 d-print-none scroll-bar td-sidebar">
+{{ if in .File.Path "docs/skywalking-showcase/current" }}
+ {{ $currentVersion := .Site.Data.docSidebar.skywalking_showcasecurrent.version }}
+ <h5>Documentation:
+ <select class="version-select">
+ {{range .Site.Data.docSidebar.skywalking_showcasecurrent.repoDocs}}
+ {{$version := .version}}
+ <option {{ cond (eq $currentVersion $version) "selected" "" }} value="{{$version}}">{{$version}}</option>
+ {{end}}
+ </select>
+ </h5>
+
+ {{ partial "sidebar-menu.html" .Site.Data.docSidebar.skywalking_showcasecurrent }}
+ <div class="commit-id">Commit Id: {{.Site.Data.docSidebar.skywalking_showcasecurrent.commitId}}</div>
+ {{ end }}
- </div>
+</div>
<main class="col-12 col-md-9 col-xl-8 pl-md-5 pr-md-4" role="main">
<i class="fa fa-bars doc-menu-button"></i>
{{ block "main" . }}{{ end }}