Skip to content
This repository was archived by the owner on Jun 17, 2021. It is now read-only.

Commit 4295210

Browse files
authored
Update documentations and fix some dead links (#103)
1 parent db12eb2 commit 4295210

File tree

6 files changed

+21
-21
lines changed

6 files changed

+21
-21
lines changed

.gitmodules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[submodule "modules/nodejs-agent/proto"]
22
path = modules/nodejs-agent/proto
3-
url = https://github.com/apache/incubator-skywalking-data-collect-protocol.git
3+
url = https://github.com/apache/skywalking-data-collect-protocol.git

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [Apache SkyWalking](https://github.com/apache/skywalking) backend and others compatible agents/SDKs.
66

7-
[![Build Status](https://travis-ci.org/SkyAPM/SkyAPM-nodejs.svg?branch=master)](https://travis-ci.org/SkyAPM/SkyAPM-nodejs)
7+
[![Build Status](https://github.com/SkyAPM/SkyAPM-nodejs/workflows/Build/badge.svg?branch=master)](https://github.com/SkyAPM/SkyAPM-nodejs/actions?query=branch%3Amaster+event%3Apush+workflow%3ABuild)
88

99
## Documents
1010
* [Document in English](docs/README.md)

docs/compatibility-list.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Capatibility list
2-
In Skywalking, each monitored component/framework will have a unique identifier. because of the publish time and publish version for the Skywalking main project and nodejs project is not one by one corresponding. So some monitored component/framework identifier are not recognized by the Skywalking Collector, it will cause some problems on the UI.
1+
# Compatibility list
2+
In SkyWalking, each monitored component/framework will have a unique identifier. because of the publish time and publish version for the SkyWalking main project and nodejs project is not one by one corresponding. So some monitored component/framework identifier are not recognized by the SkyWalking Collector, it will cause some problems on the UI.
33

4-
So you have two way to resolve this problem. One is **download the capatiblity version** and the other way is **add your own component library setting**.
4+
So you have two ways to resolve this problem. One is **download the compatible version** and the other way is **add your own component library setting**.
55

6-
## Download the capatiblity version
6+
## Download the compatible version
77

8-
| Nodejs agent version| Skywalking backend version|
8+
| Nodejs agent version| SkyWalking backend version|
99
|:------|:----|
1010
| 0.1.x | 5.0.0-beta |
1111
| 0.3.0 | 5.0.0-RC |
1212
| 1.0.0 | 6.0.0-GA |
1313

1414

1515
## Add your own component library
16-
If you don't want to upgrade the Skywalking backend, No problem, Skywalking provide another simple way to resolve it, Just following [this document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Component-libraries-extend.md) to add your own component libray setting.
16+
If you don't want to upgrade the SkyWalking backend, no problem, SkyWalking provides another simple way to resolve it, just follow [this document](https://github.com/apache/skywalking/blob/master/docs/en/Component-libraries-extend.md) to add your own component library setting.
1717

1818
Here is the plugin support mapping.
1919

docs/how-to-deploy-agent-in-egg-framework.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# How to deploy agent in egg framework
22

33
## Install `skyapm-egg-require` module
4-
1. goto project
4+
1. goto project
55
2. run the following command
66
```shell
77
$ npm install skyapm-egg-require --save
88
```
99

1010
## Deploy Skywalking backend
11-
Skywalking provide two deploy mode, one is standalone mode and the other is cluster mode, and here is the deploy documents.
12-
* [Local mode](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-backend-in-standalone-mode.md)
13-
* [Cluster mode](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-backend-in-cluster-mode.md)
11+
SkyWalking provide two deploy mode, one is standalone mode and the other is cluster mode, and here is the deploy documents.
12+
* [Local mode](https://github.com/apache/skywalking/blob/master/docs/en/Deploy-backend-in-standalone-mode.md)
13+
* [Cluster mode](https://github.com/apache/skywalking/blob/master/docs/en/Deploy-backend-in-cluster-mode.md)
1414

1515
## Modify start script
1616
Add the following the stuff to the start script
@@ -25,6 +25,6 @@ Add the following the stuff to the start script
2525
## Visit your application
2626
After you do all above actions and your application has been monitored. you can visit your service that your application provided and the tracking data will be reported to the Skywalking backend.
2727

28-
## Visit skywalking webui
28+
## Visit SkyWalking webui
2929
If you has start up UI, you maybe can open browser and visit the webui url. The url by default is [http://localhost:8080](http://localhost:8080), If you has changed `server.port` configuration about webui, the visit url has change to http://localhost:[server.port]. If you haven't started yet, don't worry about the loss data problem and Skywalking will keep your data safe, just start up UI, and visit the webui url.
3030

docs/quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Quick start
22

33
Here is the steps:
4-
1. Look up the [compatiblity list](compatibility-list.md)
4+
1. Look up the [compatibility list](compatibility-list.md)
55
2. Download corresponding releases package from [Apache official website](http://skywalking.apache.org/downloads/).
6-
3. Deploy skywalking backend in standalone mode according [this document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-backend-in-standalone-mode.md)
6+
3. Deploy SkyWalking backend in standalone mode according [this document](https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/backend-ui-setup.md)
77
4. [Install Nodejs Agent](install-agent.md)
88
5. Reboot your applications and visit your service.
99

10-
And now your application has been monitored.
10+
And now your application has been monitored.

modules/nodejs-agent/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# SkyAPM Nodejs Agent
22

3-
SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [Apache SkyWalking(Incubating) APM](https://github.com/apache/incubator-skywalking) backend and others compatible agents/SDKs.
3+
SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [Apache SkyWalking APM](https://github.com/apache/skywalking) backend and others compatible agents/SDKs.
44

5-
[![Build Status](https://travis-ci.org/SkyAPM/SkyAPM-nodejs.svg?branch=master)](https://travis-ci.org/SkyAPM/SkyAPM-nodejs)
5+
[![Build Status](https://github.com/SkyAPM/SkyAPM-nodejs/workflows/Build/badge.svg?branch=master)](https://github.com/SkyAPM/SkyAPM-nodejs/actions?query=branch%3Amaster+event%3Apush+workflow%3ABuild)
66

77
## Documents
8-
* [Document in English](../docs/README.md)
8+
* [Document in English](../../docs/README.md)
99

1010
## Support List
1111
1. [Http](https://nodejs.org/api/http.html)
@@ -16,5 +16,5 @@ SkyAPM Node.js is the Node.js instrumentation agent, which is compatible with [A
1616
* Submit an issue
1717
* QQ Group: 392443393
1818

19-
## License ## License
20-
[Apache 2.0](LICENSE.md)
19+
## License
20+
[Apache 2.0](../../../LICENSE)

0 commit comments

Comments
 (0)