Commit f2811800 authored by 吴晟's avatar 吴晟
Browse files

Add more ducoments.

parent f80b0312

README.md

+1 −1
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDU 
- [See all screenshots](/docs/Screenshots.md)



# Compiling project

Follow this [document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/How-to-build.md).

Follow this [document](docs/en/guides/How-to-build.md).



# Contact Us

* Submit an issue

docs/en/setup/backend/Component-library-settings.md→docs/en/guides/Component-library-settings.md

+1 −0
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ This is a both-way mapping, agent or SDK could use the value(ID) to represent th 
- Node.js Platform reserved: (4000, 5000]

- Go reserved: (5000, 6000]

- PHP reserved: (6000, 7000]

- Python reserved: (7000, 8000]



Example

```yaml

docs/en/How-to-build.md→docs/en/guides/How-to-build.md

+0 −0

File moved.

View file

docs/en/guides/Java-Plugin-Development-Guide.md

+2 −1
Original line number Diff line number Diff line
@@ -158,7 +158,7 @@ SpanLayer is the catalog of span. Here are 5 values: 
1. MQ



Component IDs are defined and reserved by SkyWalking project.

For component name/ID extension, please follow [component library setting document](../setup/backend/Component-library-settings.md).

For component name/ID extension, please follow [cComponent library definition and extension](Component-library-settings.md) document.



## Develop a plugin

### Abstract
@@ -275,6 +275,7 @@ public interface InstanceMethodsAroundInterceptor { 
```

Use the core APIs in before, after and exception handle stages.





### Contribute plugins into Apache SkyWalking repository

We are welcome everyone to contribute plugins.

docs/en/guides/README.md

+13 −2
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
Guides help everyone developer, including PPMC member, committer and contributor, to understand the project structure. 

Also learn to build the project, even to release the official Apache version(If you have been accepted as the formal committer).



- [Compiling Guide](../How-to-build.md). Teaches developer how to build the project in local.

- [Compiling Guide](How-to-build.md). Teaches developer how to build the project in local.

- [Apache Release Guide](How-to-release.md). Apache license allows everyone to redistribute if you keep our licenses and NOTICE

in your redistribution. This document introduces to the committer team about doing official Apache version release, to avoid 

breaking any Apache rule.
@@ -14,4 +14,15 @@ read the following guides. 
- [Java agent plugin development guide](Java-Plugin-Development-Guide.md).

This guide helps you to develop SkyWalking agent plugin to support more frameworks. Both open source plugin

and private plugin developer should read this. 

- [Storage extension development guide](storage-extention.md)
 
- If you want to build a new probe or plugin in any language, please read [Component library definition and extension](Component-library-settings.md) document.

- [Storage extension development guide](storage-extention.md). Help potential contributors to build a new 

storage implementor besides the official.





## UI developer

Our UI is constituted by static pages and web container.



- **Static pages** is built based on [Ant Design Pro](https://pro.ant.design/), which source codes are 

hosted in our [UI repository](https://github.com/apache/incubator-skywalking-ui).

- **Web container** source codes are in `apm-webapp` module. This is a just an easy zuul proxy to host

static resources and send GraphQL query requests to backend.