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/02/11 03:15:51 UTC
[skywalking-satellite] 01/01: Polish the doc and compact the GHA
configs
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch doc/polish
in repository https://gitbox.apache.org/repos/asf/skywalking-satellite.git
commit c4ba71c95c8667ab2601b4f92bd728a4176dc400
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Thu Feb 11 11:10:15 2021 +0800
Polish the doc and compact the GHA configs
---
.github/workflows/build-and-test.yaml | 39 ++++++++--------------
README.md | 2 +-
docs/en/concepts-and-designs/project-goals.md | 8 ++---
docs/en/guides/contribuation/plugin.md | 2 +-
docs/en/setup/README.md | 4 +--
docs/en/setup/configuration/common.md | 6 ++--
.../en/setup/plugins/fallbacker_none-fallbacker.md | 2 +-
plugins/fallbacker/none/none_fallbacker.go | 2 +-
8 files changed, 27 insertions(+), 38 deletions(-)
diff --git a/.github/workflows/build-and-test.yaml b/.github/workflows/build-and-test.yaml
index 7eb20c1..dcbd2b3 100644
--- a/.github/workflows/build-and-test.yaml
+++ b/.github/workflows/build-and-test.yaml
@@ -21,14 +21,16 @@ on:
push:
branches:
- main
+ - doc/polish
jobs:
CI-Windows:
- runs-on: windows-latest
- timeout-minutes: 90
+ runs-on: ${{ matrix.runner }}
+ timeout-minutes: 30
strategy:
matrix:
go-version: [ 1.14, 1.15 ]
+ runner: [ macos-latest, windows-latest ]
fail-fast: true
steps:
- name: Set up Go ${{ matrix.go-version }}
@@ -39,35 +41,22 @@ jobs:
uses: actions/checkout@v2
with:
submodules: true
+ - name: Check License
+ run: make license
- name: Get dependencies
run: make deps
+ - name: Check generate
+ run: make gen && make build
+ - name: Check CI Consistency
+ if: matrix.go-version == '1.15' && matrix.runner == 'ubuntu-latest'
+ run: make check
+ - name: Lint
+ run: make lint
- name: Test
run: make test
- name: Build
run: make build
- CI-MacOS:
- runs-on: macos-latest
- timeout-minutes: 90
- strategy:
- matrix:
- go-version: [ 1.14, 1.15 ]
- fail-fast: true
- steps:
- - name: Set up Go ${{ matrix.go-version }}
- uses: actions/setup-go@v2
- with:
- go-version: ${{ matrix.go-version }}
- - name: Check out code into the Go module directory
- uses: actions/checkout@v2
- with:
- submodules: true
- - name: Get dependencies
- run: make deps
- - name: Test
- run: make test
- - name: Build
- run: make build
CI:
runs-on: ubuntu-latest
timeout-minutes: 90
@@ -91,7 +80,7 @@ jobs:
- name: Check generate
run: make gen && make build
- name: Check CI Consistency
- if: matrix.go-version == '1.15'
+ if: matrix.go-version == '1.15' && matrix.runner == 'ubuntu-latest'
run: make check
- name: Lint
run: make lint
diff --git a/README.md b/README.md
index 67d2417..f46a0d9 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ Apache SkyWalking Satellite
NOTICE, SkyWalking Satellite uses [v3 protocols](https://github.com/apache/skywalking/blob/master/docs/en/protocols/README.md). They are incompatible with previous SkyWalking releases before SkyWalking 8.0.
# Download
-Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS, Linux and Windows. Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. Check [the corresponding documentation](./docs/en/guides/compile/compile.md) to see whether the plugin is available on Windows.
+Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS, Linux and Windows. Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. Check [the corresponding documentation](./docs/en/setup/plugins) to see whether the plugin is available on Windows.
# Compile
As SkyWalking Satellite is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project.
diff --git a/docs/en/concepts-and-designs/project-goals.md b/docs/en/concepts-and-designs/project-goals.md
index c620f4c..c8795b2 100644
--- a/docs/en/concepts-and-designs/project-goals.md
+++ b/docs/en/concepts-and-designs/project-goals.md
@@ -3,13 +3,13 @@ The document outlines the core design goals for SkyWalking Satellite project.
- **Light Weight**. SkyWalking Satellite has a limited cost for resources and high-performance because of the requirements of the sidecar deployment model.
-- **Pluggable**. SkyWalking Satellite core team provides many default implementations, but definitely it is not enough,
+- **Pluggability**. SkyWalking Satellite core team provides many default implementations, but definitely it is not enough,
and also don't fit every scenario. So, we provide a lot of features for being pluggable.
- **Portability**. SkyWalking Satellite can run in multiple environments, including:
- - Use traditional deployment as a demon process to collect data.
- - Use cloud services as a sidecar, such as in the kubernetes platform.
+ - Use traditional deployment as a daemon process to collect data.
+ - Use cloud services as a sidecar, such as in the Kubernetes platform.
-- **Interop**. Observability is a big landscape, SkyWalking is impossible to support all, even by its community. So SkyWalking Satellite is compatible with many protocols, including:
+- **Interoperability**. Observability is a big landscape, SkyWalking is impossible to support all, even by its community. So SkyWalking Satellite is compatible with many protocols, including:
- SkyWalking protocol
- (WIP) Prometheus protocol.
diff --git a/docs/en/guides/contribuation/plugin.md b/docs/en/guides/contribuation/plugin.md
index ffbd624..b2f4a61 100644
--- a/docs/en/guides/contribuation/plugin.md
+++ b/docs/en/guides/contribuation/plugin.md
@@ -2,7 +2,7 @@
If you want to add a custom plugin in SkyWalking Satellite, the following contents would guide you.
Let's use memory-queue as an example of how to write a plugin.
-1. Choose the plugin category. According to the memory-queue is a queue, the plugin should be write in the **skywalking-satellite/plugins/queue** directory. So we create a new directory called memory as the plugin codes space.
+1. Choose the plugin category. As the memory-queue is a queue, the plugin should be written in the **skywalking-satellite/plugins/queue** directory. So we create a new directory called memory as the plugin codes space.
2. Implement the interface in the **skywalking-satellite/plugins/queue/api**. Each plugin has 3 common methods, which are Name(), Description(), DefaultConfig().
- Name() returns the unique name in the plugin category.
diff --git a/docs/en/setup/README.md b/docs/en/setup/README.md
index 77a2d2c..3c5ab09 100644
--- a/docs/en/setup/README.md
+++ b/docs/en/setup/README.md
@@ -1,5 +1,5 @@
# Setup
-First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understood the setting file will help you to read this document.
+First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understanding the setting file will help you to read this document.
## Startup script
The startup script is /bin/skywalking-satellite-{version}-{plateform}-amd64.
@@ -16,4 +16,4 @@ So, in satellite_config.yaml, there are three parts.
3. [The pipe plugin configurations](./configuration/pipe-plugins.md).
## Advanced feature document link list
-1. [Overriding settings](./configuration/override-settings.md) in satellite_config.yaml is supported
\ No newline at end of file
+1. [Overriding settings](./configuration/override-settings.md) in satellite_config.yaml is supported
diff --git a/docs/en/setup/configuration/common.md b/docs/en/setup/configuration/common.md
index e4581e2..4990d01 100644
--- a/docs/en/setup/configuration/common.md
+++ b/docs/en/setup/configuration/common.md
@@ -12,7 +12,7 @@ configuration and the telemetry configuration.
## Self Telemetry
| Config |Default| Description |
| ---- | ---- | ---- |
-| cluster | default-cluster | The space concept for the deployment, such as the namespace concept in the kubernetes.|
-| service | default-service | The group concept for the deployment, such as the service resource concept in the kubernetes.|
-| instance | default-instance |The minimum running unit, such as the pod concept in the kubernetes.|
+| cluster | default-cluster | The space concept for the deployment, such as the namespace concept in the Kubernetes.|
+| service | default-service | The group concept for the deployment, such as the service resource concept in the Kubernetes.|
+| instance | default-instance |The minimum running unit, such as the pod concept in the Kubernetes.|
diff --git a/docs/en/setup/plugins/fallbacker_none-fallbacker.md b/docs/en/setup/plugins/fallbacker_none-fallbacker.md
index 4b8fa4d..b425422 100755
--- a/docs/en/setup/plugins/fallbacker_none-fallbacker.md
+++ b/docs/en/setup/plugins/fallbacker_none-fallbacker.md
@@ -1,5 +1,5 @@
# Fallbacker/none-fallbacker
## Description
-The fallbacker would nothing to do when facing failure data.
+The fallbacker would do nothing when facing failure data.
## DefaultConfig
```yaml```
diff --git a/plugins/fallbacker/none/none_fallbacker.go b/plugins/fallbacker/none/none_fallbacker.go
index ffb4822..f61cff1 100644
--- a/plugins/fallbacker/none/none_fallbacker.go
+++ b/plugins/fallbacker/none/none_fallbacker.go
@@ -34,7 +34,7 @@ func (f *Fallbacker) Name() string {
}
func (f *Fallbacker) Description() string {
- return "The fallbacker would nothing to do when facing failure data."
+ return "The fallbacker would do nothing when facing failure data."
}
func (f *Fallbacker) DefaultConfig() string {