Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: replace marketplace doc #138

Merged
merged 2 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/extension/overview.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Currently, OpenSumi supports two types of plugin marketplaces as shown below:

![Extension Marketplace](https://img.alicdn.com/imgextra/i2/O1CN01Kq3jZf25zTjbBJWzR_!!6000000007597-2-tps-1906-732.png)

- [OpenTRS](https://marketplace.opentrs.cn/square) —— A public extension marketplace service provided by Ant Group.
- [AlipayCloud](https://ide.cloud.alipay.com/marketplace/square) —— A public extension marketplace service provided by Ant Group.
- [OpenVSX](https://open-vsx.org/) —— A public extension marketplace service provided by the Eclipse Foundation (with open source code).

You can freely switch between sources according to your usage scenario, see the documentation for [Custom Extension Marketplace](../integrate/universal-integrate-case/custom-marketplace-entrypoint).
2 changes: 1 addition & 1 deletion docs/extension/overview.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Worker 端拥有 WebWorker 环境运行时,如果你的插件包含一些计

![Extension Marketplace](https://img.alicdn.com/imgextra/i2/O1CN01Kq3jZf25zTjbBJWzR_!!6000000007597-2-tps-1906-732.png)

- [OpenTRS](https://marketplace.opentrs.cn/square) —— 蚂蚁集团开放的公共插件市场服务
- [AlipayCloud](https://ide.cloud.alipay.com/marketplace/square) —— 蚂蚁集团开放的支付宝小程序云插件市场
- [OpenVSX](https://open-vsx.org/) —— Eclipse 基金会开放的公共插件市场服务(源码开源)

可以根据使用场景自由进行源的切换,见文档 [自定义插件市场源](../integrate/universal-integrate-case/custom-marketplace-entrypoint)。
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: custom-marketplace-entrypoint
order: 8
---

OpenSumi support both [Ant CloudIDE Marketplace](https://marketplace.opentrs.cn/square) and [Eclipse Open VSX](https://www.eclipse.org/community/eclipse_newsletter/2020/march/1.php), and can be switched between each other through configuration. At present, the default is the Ant CloudIDE extension marketplace
OpenSumi support both [Alipay CloudIDE Marketplace](https://ide.cloud.alipay.com/marketplace/square) and [Eclipse Open VSX](https://www.eclipse.org/community/eclipse_newsletter/2020/march/1.php), and can be switched between each other through configuration. At present, the default is the Alipay CloudIDE extension marketplace


## Configuration
Expand All @@ -15,7 +15,7 @@ Generally, the initial project of the framework will use the configuration of th

### How to modify the download script

The download script (`scripts/download.js`) uses the Ant CloudIDE extension marketplace by default. If you need to switch, you can specify the extension marketplace type in the `download-extension` directive in the `package.json` file:
The download script (`scripts/download.js`) uses the Alipay CloudIDE extension marketplace by default. If you need to switch, you can specify the extension marketplace type in the `download-extension` directive in the `package.json` file:

```json
{
Expand All @@ -30,20 +30,20 @@ The download script (`scripts/download.js`) uses the Ant CloudIDE extension mark

You can refer to the code here: [node/start-server.ts#L18](https://github.com/opensumi/opensumi-module-samples/blob/main/example/src/node/start-server.ts# L18), add relevant parameter information in the configuration parameters of the Node process startup. The specific configuration is as follows:

#### Ant CloudIDE Marketplace
#### Alipay CloudIDE Marketplace

```typescript
let opts: IServerAppOpts = {
...
marketplace: {
endpoint: 'https://marketplace.opentrs.cn',
accountId: 'clcJKq_Gea47whxAJGrgoYqf',
masterKey: '_V_LPJ6Ar-1nrSVa05xDGBYp',
endpoint: 'https://twebgwnet.alipay.com/atsmarketplace',
accountId: 'WWPLOa7vWXCUTSHCfV5FK7Su',
masterKey: 'i6rkupqyvC6Bc6CiO0yVLNqq',
},
...
};
```
The `accountId` and `masterKey` used in the above configuration are the public secret key provided by the Ant CloudIDE Marketplace. This secret key can access all public extensions in the marketplace by default. If you need to customize the secret key, you can refer to the client management section in the [Ant CloudIDE Marketplace documentation](https://www.opentrs.cn/cloudide/documents/documentDetail?productStr=cloudide-20221026&nameSpace=trms2d/xyyfdt&slug=ooxr2vxp32r9hv4q). Through the custom secret key, you can access your private extensions hosted in the marketplace.
The `accountId` and `masterKey` used in the above configuration are the public secret key provided by the Alipay CloudIDE Marketplace. This secret key can access all public extensions in the marketplace by default. If you need to customize the secret key, you can refer to the client management section in the [Alipay CloudIDE Marketplace documentation](https://www.opentrs.cn/cloudide/documents/documentDetail?productStr=cloudide-20221026&nameSpace=trms2d/xyyfdt&slug=ooxr2vxp32r9hv4q). Through the custom secret key, you can access your private extensions hosted in the marketplace.


#### Eclipse Open VSX
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 8

## 概览

OpenSumi 同时支持 [蚂蚁 CloudIDE 插件市场](https://marketplace.opentrs.cn/square) 及 [Eclipse Open VSX](https://www.eclipse.org/community/eclipse_newsletter/2020/march/1.php) ,两个插件市场可以通过配置相互切换,目前默认使用的是蚂蚁 CloudIDE 插件市场
OpenSumi 同时支持 [支付宝小程序云 CloudIDE 插件市场](https://ide.cloud.alipay.com/marketplace/square) 及 [Eclipse Open VSX](https://www.eclipse.org/community/eclipse_newsletter/2020/march/1.php) ,两个插件市场可以通过配置相互切换,目前默认使用的是支付宝小程序云 CloudIDE 插件市场


## 配置方式
Expand All @@ -16,7 +16,7 @@ OpenSumi 同时支持 [蚂蚁 CloudIDE 插件市场](https://marketplace.opentrs

### 如何修改下载脚本

下载脚本(`scripts/download.js`)默认使用的是蚂蚁 CloudIDE 插件市场,如需切换,可以在 `package.json` 文件的 `download-extension` 命令中指定插件市场类型:
下载脚本(`scripts/download.js`)默认使用的是支付宝小程序云 CloudIDE 插件市场,如需切换,可以在 `package.json` 文件的 `download-extension` 命令中指定插件市场类型:

```json
{
Expand All @@ -31,20 +31,20 @@ OpenSumi 同时支持 [蚂蚁 CloudIDE 插件市场](https://marketplace.opentrs

可以参考这里的代码:[node/start-server.ts#L18](https://github.com/opensumi/opensumi-module-samples/blob/main/example/src/node/start-server.ts#L18),在 Node 进程启动的配置参数中添加相关参数信息,具体配置如下:

#### 蚂蚁 CloudIDE 插件市场
#### 支付宝小程序云 CloudIDE 插件市场

```typescript
let opts: IServerAppOpts = {
...
marketplace: {
endpoint: 'https://marketplace.opentrs.cn',
accountId: 'clcJKq_Gea47whxAJGrgoYqf',
masterKey: '_V_LPJ6Ar-1nrSVa05xDGBYp',
endpoint: 'https://twebgwnet.alipay.com/atsmarketplace',
accountId: 'WWPLOa7vWXCUTSHCfV5FK7Su',
masterKey: 'i6rkupqyvC6Bc6CiO0yVLNqq',
},
...
};
```
上文配置中使用的 `accountId` 及 `masterKey` 是由蚂蚁 CloudIDE 插件市场提供的公共密钥,该密钥默认可访问插件市场中全部的公开插件,如需要自定义密钥,可以参考 [蚂蚁 CloudIDE 插件市场文档](https://www.opentrs.cn/cloudide/documents/documentDetail?productStr=cloudide-20221026&nameSpace=trms2d/xyyfdt&slug=ooxr2vxp32r9hv4q) 中的客户端管理一节的内容,通过自定义密钥,用户可以访问自己托管在插件市场中的私有插件
上文配置中使用的 `accountId` 及 `masterKey` 是由支付宝小程序云 CloudIDE 插件市场提供的公共密钥,该密钥默认可访问插件市场中全部的公开插件,如需要自定义密钥,可以参考 [支付宝小程序云 CloudIDE 插件市场文档](https://www.opentrs.cn/cloudide/documents/documentDetail?productStr=cloudide-20221026&nameSpace=trms2d/xyyfdt&slug=ooxr2vxp32r9hv4q) 中的客户端管理一节的内容,通过自定义密钥,用户可以访问自己托管在插件市场中的私有插件

#### Eclipse Open VSX

Expand All @@ -63,4 +63,4 @@ let opts: IServerAppOpts = {

## 插件同步机制

目前 OpenSumi 对 VSCode 插件 API 的兼容有一定的滞后性(约三个月),因此托管在插件市场中的 VSCode 插件在同步前必须先进行代码扫描,如果用户在使用蚂蚁 CloudIDE 插件市场时发现缺少想要的插件,可以在 [OpenSumi 项目主仓库](https://github.com/opensumi/core/issues) issues 列表中提出插件同步需求,项目组成员会对插件扫描后同步可用的版本。
目前 OpenSumi 对 VSCode 插件 API 的兼容有一定的滞后性(约三个月),因此托管在插件市场中的 VSCode 插件在同步前必须先进行代码扫描,如果用户在使用支付宝小程序云 CloudIDE 插件市场时发现缺少想要的插件,可以在 [OpenSumi 项目主仓库](https://github.com/opensumi/core/issues) issues 列表中提出插件同步需求,项目组成员会对插件扫描后同步可用的版本。
2 changes: 1 addition & 1 deletion gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ module.exports = {
}
},
{
slug: 'https://marketplace.opentrs.cn/square',
slug: 'https://ide.cloud.alipay.com/marketplace/square',
title: {
en: 'Marketplace',
zh: '插件市场'
Expand Down
Loading