Skip to content

Commit

Permalink
docs:修正polaris-java中错误的文件名描述 (#372)
Browse files Browse the repository at this point in the history
  • Loading branch information
chuntaojun authored Nov 14, 2023
1 parent 656129b commit 15068b0
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ weight: 9
```


## 初始化 polaris.yaml
## 初始化 polaris.yml

你需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。[polaris.yaml配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)
你需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。[polaris.yml 配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)


## 修改 polaris.yaml 开启二次寻址
## 修改 polaris.yml 开启二次寻址

```yaml
global:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@ weight: 3
</dependencies>
```

## 初始化 polaris.yaml
## 初始化 polaris.yml

你需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。[polaris.yaml配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)
你需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。[polaris.yml 配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)



## 服务注册

### SDK实例构建

当初始化好 polaris.yaml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.RouterAPIFactory**, 使用 **RouterAPIFactory** 中的方法进行构造一个 RouterAPI SDK 实例
当初始化好 polaris.yml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.RouterAPIFactory**, 使用 **RouterAPIFactory** 中的方法进行构造一个 RouterAPI SDK 实例

```java
import com.tencent.polaris.factory.api.RouterAPIFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ weight: 8
</dependencies>
```

## 通过配置文件 polaris.yaml 开启监控上报
## 通过配置文件 polaris.yml 开启监控上报

你需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。[polaris.yaml配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)
你需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。[polaris.yml 配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)

##### 通过 prometheus pull 模式上报监控数据

Expand Down Expand Up @@ -114,7 +114,7 @@ configuration.getGlobal().getStatReporter()

## SDK实例构建

当初始化好 polaris.yaml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.DiscoveryAPIFactory**, 使用 **DiscoveryAPIFactory** 中的方法进行构造一个 ConsumerAPI SDK 实例
当初始化好 polaris.yml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.DiscoveryAPIFactory**, 使用 **DiscoveryAPIFactory** 中的方法进行构造一个 ConsumerAPI SDK 实例

```java
import com.tencent.polaris.factory.api.DiscoveryAPIFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ weight: 2
```


## 初始化 polaris.yaml
## 初始化 polaris.yml

你需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。[polaris.yaml配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)
你需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。[polaris.yml 配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)



## 服务注册

### SDK实例构建

当初始化好 polaris.yaml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.DiscoveryAPIFactory**, 使用 **DiscoveryAPIFactory** 中的方法进行构造一个 ProviderAPI SDK 实例
当初始化好 polaris.yml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.DiscoveryAPIFactory**, 使用 **DiscoveryAPIFactory** 中的方法进行构造一个 ProviderAPI SDK 实例

```java
import com.tencent.polaris.factory.api.DiscoveryAPIFactory;
Expand Down Expand Up @@ -107,7 +107,7 @@ InstanceRegisterResponse registerResp = providerAPI.registerInstance(registerReq

### SDK实例构建

当初始化好 polaris.yaml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.DiscoveryAPIFactory**, 使用 **DiscoveryAPIFactory** 中的方法进行构造一个 ConsumerAPI SDK 实例
当初始化好 polaris.yml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.DiscoveryAPIFactory**, 使用 **DiscoveryAPIFactory** 中的方法进行构造一个 ConsumerAPI SDK 实例

```java
import com.tencent.polaris.factory.api.DiscoveryAPIFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ weight: 5

***使用示例***

```
```java
// 创建CircuitBreakAPI实例
CircuitBreakAPI circuitBreakAPI = CircuitBreakAPIFactory.createCircuitBreakAPI();

Expand Down Expand Up @@ -74,7 +74,7 @@ for (int i = 0; i < 500; i++) {

***使用示例***

```
```java
// 创建CircuitBreakAPI实例
CircuitBreakAPI circuitBreakAPI = CircuitBreakAPIFactory.createCircuitBreakAPI();

Expand Down Expand Up @@ -150,7 +150,7 @@ for (int i = 0; i < 500; i++) {

***配置北极星服务端地址***

用户需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。
用户需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。

```
global:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ weight: 6
```


## 初始化 polaris.yaml
## 初始化 polaris.yml

你需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。[polaris.yaml配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)
你需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。[polaris.yml 配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)


## SDK实例构建

当初始化好 polaris.yaml 文件之后,你可以直接 import **com.tencent.polaris.ratelimit.factory**, 使用 **LimitAPIFactory** 中的方法进行构造一个 ProviderAPI SDK 实例
当初始化好 polaris.yml 文件之后,你可以直接 import **com.tencent.polaris.ratelimit.factory**, 使用 **LimitAPIFactory** 中的方法进行构造一个 ProviderAPI SDK 实例

```java
import com.tencent.polaris.ratelimit.factory.LimitAPIFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ weight: 4
```


## 初始化 polaris.yaml
## 初始化 polaris.yml

你需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。[polaris.yaml配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)
你需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。[polaris.yml 配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)



## 服务注册

### SDK实例构建

当初始化好 polaris.yaml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.RouterAPIFactory**, 使用 **RouterAPIFactory** 中的方法进行构造一个 RouterAPI SDK 实例
当初始化好 polaris.yml 文件之后,你可以直接 import **com.tencent.polaris.factory.api.RouterAPIFactory**, 使用 **RouterAPIFactory** 中的方法进行构造一个 RouterAPI SDK 实例

```java
import com.tencent.polaris.factory.api.RouterAPIFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ weight: 7
```


## 初始化 polaris.yaml
## 初始化 polaris.yml

你需要在项目的 **main/resources** 下创建一个 polaris.yaml 文件用于初始化 polaris-java SDK。[polaris.yaml配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)
你需要在项目的 **main/resources** 下创建一个 polaris.yml 文件用于初始化 polaris-java SDK。[polaris.yml 配置详细](https://github.com/polarismesh/polaris-java/blob/main/polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml)


## SDK实例构建

当初始化好 polaris.yaml 文件之后,你可以直接 import **com.tencent.polaris.configuration.factory**, 使用 **ConfigFileServiceFactory** 中的方法进行构造一个 ConfigFileService SDK 实例
当初始化好 polaris.yml 文件之后,你可以直接 import **com.tencent.polaris.configuration.factory**, 使用 **ConfigFileServiceFactory** 中的方法进行构造一个 ConfigFileService SDK 实例

```java
import com.tencent.polaris.configuration.factory.ConfigFileServiceFactory;
Expand Down Expand Up @@ -100,7 +100,7 @@ ConfigFile getConfigFile(String namespace, String fileGroup, String fileName);
ConfigFile getConfigFile(ConfigFileMetadata configFileMetadata);
```

调整 **polaris.yaml** 配置文件
调整 **polaris.yml** 配置文件

```yaml
# 配置中心默认配置
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight: -1

| Polaris-Server Version | Polaris-Console Version |
|:-----------------------|:------------------------|
| v1.17.3~v1.17.5 | v1.14.2 |
| v1.17.3~v1.17.7 | v1.14.2 |
| v1.17.2 | v1.14.0 |
| v1.17.0~v1.17.1 | v1.13.x |
| v1.16.x | v1.13.x |
Expand Down

0 comments on commit 15068b0

Please sign in to comment.