kezhenxu94 commented on a change in pull request #23: URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573426300
########## File path: README.md ########## @@ -8,16 +8,34 @@ Apache SkyWalking Satellite [](https://github.com/apache/skywalking) [](https://twitter.com/AsfSkyWalking) -# Quick Start - # Documentation -- [The first design of Satellite 0.1.0](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) -- [The project structure](./docs/project_structue.md) +- [Official documentation](https://skywalking.apache.org/docs/) +- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0. + +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 and Linux. +If you want to try the latest features or run on the Windows, however, you can compile the latest codes yourself, as the guide below. # Compile -[How to compile the Satellite.](./docs/compile/compile.md) +As SkyWalking Satellite is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project. +```shell script +git clone https://github.com/apache/skywalking-satellite +cd skywalking-satellite +git submodule init +git submodule update +make build +``` +Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. If you need to compile SkyWalking Satellite on Windows platform, please read [the doc](docs/en/guides/compile/compile.md). Review comment: ```suggestion Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. Check the corresponding documentation to see whether the plugin is available on Windows. ``` ########## File path: README.md ########## @@ -8,16 +8,34 @@ Apache SkyWalking Satellite [](https://github.com/apache/skywalking) [](https://twitter.com/AsfSkyWalking) -# Quick Start - # Documentation -- [The first design of Satellite 0.1.0](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) -- [The project structure](./docs/project_structue.md) +- [Official documentation](https://skywalking.apache.org/docs/) +- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0. + +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 and Linux. +If you want to try the latest features or run on the Windows, however, you can compile the latest codes yourself, as the guide below. Review comment: Should be reworded, we will deliver a Windows binary, right? ########## File path: docs/en/setup/plugins/queue_mmap-queue.md ########## @@ -0,0 +1,20 @@ +# Queue/mmap-queue +## Description +this is a memory mapped queue to provide the persistent storage. +## DefaultConfig Review comment: You should indicate the Windows compatibility here ########## File path: docs/en/setup/plugins/queue_mmap-queue.md ########## @@ -0,0 +1,20 @@ +# Queue/mmap-queue +## Description +this is a memory mapped queue to provide the persistent storage. Review comment: The description (and other plugins') should be capitalized. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
