You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by li...@apache.org on 2021/02/22 03:34:54 UTC
[skywalking-satellite] branch main updated: add website doc (#32)
This is an automated email from the ASF dual-hosted git repository.
liujiapeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-satellite.git
The following commit(s) were added to refs/heads/main by this push:
new efc1ed6 add website doc (#32)
efc1ed6 is described below
commit efc1ed6696a9782756d1e5430346191d6687a351
Author: Evan <31...@users.noreply.github.com>
AuthorDate: Mon Feb 22 11:34:48 2021 +0800
add website doc (#32)
* add website doc
* Update changes/changes-0.1.0.md
Co-authored-by: Evan <ev...@outlook.com>
Co-authored-by: 吴晟 Wu Sheng <wu...@foxmail.com>
---
changes/changes-0.1.0.md | 26 +++++
docs/en/FAQ/README.md | 2 +-
docs/en/guides/README.md | 10 +-
.../compile/{compile.md => How-to-compile.md} | 0
.../How-to-release.md | 0
.../How-to-write-plugin.md} | 0
.../guides/test/{test.md => How-to-unit-test.md} | 0
docs/menu.yml | 116 +++++++++++++++++++++
8 files changed, 150 insertions(+), 4 deletions(-)
diff --git a/changes/changes-0.1.0.md b/changes/changes-0.1.0.md
new file mode 100644
index 0000000..30d6de5
--- /dev/null
+++ b/changes/changes-0.1.0.md
@@ -0,0 +1,26 @@
+Changes by Version
+==================
+Release Notes.
+
+0.1.0
+------------------
+#### Features
+* Build the Satellite core structure.
+* Add prometheus self telemetry.
+* Add kafka client plugin.
+* Add none-fallbacker plugin.
+* Add timer-fallbacker plugin.
+* Add nativelog-kafka-forwarder plugin.
+* Add memory-queue plugin.
+* Add mmap-queue plugin.
+* Add grpc-nativelog-receiver plugin.
+* Add http-nativelog-receiver plugin.
+* Add grpc-server plugin.
+* Add http-server plugin.
+* Add prometheus-server plugin.
+
+#### Bug Fixes
+
+#### Issues and PR
+- All issues are [here](https://github.com/apache/skywalking/milestone/64?closed=1)
+- All pull requests are [here](https://github.com/apache/skywalking-satellite/pulls?q=is%3Aopen+is%3Apr+milestone%3A0.1.0)
diff --git a/docs/en/FAQ/README.md b/docs/en/FAQ/README.md
index d3be759..20b7448 100644
--- a/docs/en/FAQ/README.md
+++ b/docs/en/FAQ/README.md
@@ -1,2 +1,2 @@
## FAQ
-
+- [What is the performance of the Satellite?](performance.md)
diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md
index 100b2d8..08dd8db 100644
--- a/docs/en/guides/README.md
+++ b/docs/en/guides/README.md
@@ -1,6 +1,10 @@
# Guides
If you want to debug or develop SkyWalking Satellite, The following documentations would guide you.
-- [How to contribute a plugin?](./contribuation/plugin.md)
-- [How to add unit test for a plugin?](./test/test.md)
-- [How to compile SkyWalking Satellite?](./compile/compile.md)
+- Contribution
+ - [How to contribute a plugin?](./contribution/How-to-write-plugin.md)
+ - [How to release SkyWalking Satellite?](./contribution/How-to-release.md)
+- Compile
+ - [How to compile SkyWalking Satellite?](./compile/How-to-compile.md)
+- Test
+ - [How to add unit test for a plugin?](./test/How-to-unit-test.md)
diff --git a/docs/en/guides/compile/compile.md b/docs/en/guides/compile/How-to-compile.md
similarity index 100%
rename from docs/en/guides/compile/compile.md
rename to docs/en/guides/compile/How-to-compile.md
diff --git a/docs/en/guides/contribuation/How-to-release.md b/docs/en/guides/contribution/How-to-release.md
similarity index 100%
rename from docs/en/guides/contribuation/How-to-release.md
rename to docs/en/guides/contribution/How-to-release.md
diff --git a/docs/en/guides/contribuation/plugin.md b/docs/en/guides/contribution/How-to-write-plugin.md
similarity index 100%
rename from docs/en/guides/contribuation/plugin.md
rename to docs/en/guides/contribution/How-to-write-plugin.md
diff --git a/docs/en/guides/test/test.md b/docs/en/guides/test/How-to-unit-test.md
similarity index 100%
rename from docs/en/guides/test/test.md
rename to docs/en/guides/test/How-to-unit-test.md
diff --git a/docs/menu.yml b/docs/menu.yml
new file mode 100644
index 0000000..dcf0055
--- /dev/null
+++ b/docs/menu.yml
@@ -0,0 +1,116 @@
+# 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 Satellite?"
+ catalog:
+ - name: "Overview and Core concepts"
+ path: "/en/concepts-and-designs/overview"
+ - name: "Project Goals"
+ path: "/en/concepts-and-designs/project-goals"
+ - name: "Design"
+ catalog:
+ - name: "Module Design"
+ path: "/en/concepts-and-designs/module_design"
+ - name: "Plugin mechanism"
+ path: "/en/concepts-and-designs/plugin_mechanism"
+ - name: "Project Structure"
+ path: "/en/concepts-and-designs/project_structue"
+ - name: "The design of the memory mapped queue"
+ path: "/en/concepts-and-designs/mmap-queue"
+
+ - name: "Setup"
+ path: "/en/setup/readme"
+ catalog:
+ - name: "Configuration"
+ catalog:
+ - name: "Common Configuration"
+ path: "/en/setup/configuration/common"
+ - name: "Sharing Configuration"
+ path: "/en/setup/configuration/sharing-plugins"
+ - name: "Pipe Configuration"
+ path: "/en/setup/configuration/pipe-plugins"
+ - name: "Override Configuration"
+ path: "/en/setup/configuration/override-settings"
+
+ - name: "Plugins"
+ path: "/en/setup/plugins/plugin-list"
+ catalog:
+ - name: "client"
+ catalog:
+ - name: "kafka-client"
+ path: "/en/setup/plugins/client_kafka-client"
+ - name: "fallbacker"
+ catalog:
+ - name: "none-fallbacker"
+ path: "/en/setup/plugins/fallbacker_none-fallbacker"
+ - name: "timer-fallbacker"
+ path: "/en/setup/plugins/fallbacker_timer-fallbacker"
+ - name: "forwarder"
+ catalog:
+ - name: "nativelog-kafka-forwarder"
+ path: "/en/setup/plugins/forwarder_nativelog-kafka-forwarder"
+ - name: "queue"
+ catalog:
+ - name: "memory-queue"
+ path: "/en/setup/plugins/queue_memory-queue"
+ - name: "mmap-queue"
+ path: "/en/setup/plugins/queue_mmap-queue"
+ - name: "receiver"
+ catalog:
+ - name: "grpc-nativelog-receiver"
+ path: "/en/setup/plugins/receiver_grpc-nativelog-receiver"
+ - name: "http-nativelog-receiver"
+ path: "/en/setup/plugins/receiver_http-nativelog-receiver"
+ - name: "server"
+ catalog:
+ - name: "grpc-server"
+ path: "/en/setup/plugins/server_grpc-server"
+ - name: "http-server"
+ path: "/en/setup/plugins/server_http-server"
+ - name: "prometheus-server"
+ path: "/en/setup/plugins/server_http-server"
+
+ - name: "Guides"
+ path: "/en/guides/readme"
+ catalog:
+ - name: "Contribution"
+ catalog:
+ - name: "How to write a plugin"
+ path: "/en/guides/contribution/How-to-write-plugin"
+ - name: "How to release"
+ path: "/en/guides/contribution/How-to-release"
+ - name: "Test"
+ catalog:
+ - name: "How to do unit test"
+ path: "/en/guides/test/How-to-unit-test"
+ - name: "Compile"
+ catalog:
+ - name: "How to compile SkyWalking Satellite"
+ path: "/en/guides/compile/How-to-compile"
+ - name: "FAQs"
+ path: "/en/FAQ/readme"
+
+
+
+
+