forked from Gitlink/gitlink_help_center
更新帮助文档
This commit is contained in:
wangjing22e
parent
1943cd8dcf
commit
55e254d7fd
|
|
@ -2,6 +2,74 @@
|
|||
sidebar_label: 'bot安装'
|
||||
sidebar_position: 1
|
||||
---
|
||||
import MyButton from './mybutton';
|
||||
|
||||
<MyButton onClick={() => {
|
||||
var pElements = document.getElementsByTagName('p');
|
||||
var hElements = document.getElementsByTagName('h1');
|
||||
var aElements = document.getElementsByTagName('a');
|
||||
var hzh = ['bot安装','bot安装'];
|
||||
var hen = ['Bot Installation','Bot Installation'];
|
||||
var azh = ['跳到主要内容','','帮助中心','','','','','','','','','','','','','','','','','','','','','机器人(Bot)','编辑此页','上一页 bot市场','下一页bot 配置','网站首页','关于我们','教学实践','合作伙伴','API文档','Git常用命令','引擎使用手册','服务协议','官网邮箱：gitlink@ccf.org.cn','QQ群','公众号'];
|
||||
var aen = ['Jump to main content','','Help Center','','','','','','','','','','','','','','','','','','','','','Robot (Bot)','Edit this page','last page Bot market','next page Bot configuration','Website homepage','About Us','Teaching practice','Partners','API documentation','Common Git commands','Engine User Manual','Service Agreement','Official website email: gitlink@ccf.org.cn','QQ group','Official Account'];
|
||||
var zhtranalate = ['Bot安装是进行bot安装和管理控制的重要模块，主要包括bot安装、安装查询、安装管理等功能。','在bot详情页，用户点击“安装此Bot”按钮后，可以看到该bot工作所需的各项权限信息。若用户同意授予bot所需的相关权限即可进行安装。用户可选择将bot安装到所有仓库（用户拥有的所有仓库）中，也可以选择指定的仓库进行安装。','','在个人“设置”或者“仓库设置”中，用户可以看到目前已经安装的Bot情况，点击“配置”按钮可以对bot安装情况进行配置，点击“卸载”按钮可以进行卸载。','','在bot安装配置页中，用户可以掌握该bot的安装位置和工作状态。若用户需要更改bot的工作仓库时，可以进行更改安装位置。bot的工作状态包括激活和挂起，用户可根据需要对bot的状态进行调整，将其挂起或者激活，会影响到bot对仓库数据的访问权限。','','©Copyright 2024 CCF 开源发展委员会','Powered by Trustie& IntelliDE 京ICP备13000930号'];
|
||||
var entranslate = ['Bot installation is an important module for bot installation and management control, which mainly includes functions such as bot installation, installation queries, and installation management.','On the bot details page, after clicking the "Install this bot" button, users can see the necessary permission information for the bot to work. If the user agrees to grant the necessary permissions to the bot, installation can proceed. Users can choose to install the bot in all warehouses (all warehouses owned by the user) or select a specified warehouse for installation.','','In personal "settings" or "warehouse settings", users can see the current installation status of bots. Click the "configure" button to configure the bot installation status, and click the "uninstall" button to uninstall.','','In the bot installation configuration page, users can grasp the installation location and working status of the bot. If the user needs to change the workspace of the bot, they can change the installation location. The working status of bots includes activation and suspension. Users can adjust the status of bots as needed. Suspending or activating bots can affect their access to warehouse data.','','© Copyright 2024 CCF Open Source Development Committee','Powered by Trust&IntelliDE Beijing ICP Preparation No. 13000930'];
|
||||
if (pElements[0].innerText == zhtranalate[0]){
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = entranslate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = zhtranalate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (hElements[0].innerText == hzh[0]){
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hen[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hzh[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (aElements[0].innerText == azh[0]){
|
||||
for (var i = 0; i < aElements.length; i++) {
|
||||
if (aElements[i].innerText != ''){
|
||||
if (i < aElements.length){
|
||||
aElements[i].innerText = aen[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < aElements.length; i++) {
|
||||
if (aElements[i].innerText != ''){
|
||||
if (i < aElements.length){
|
||||
aElements[i].innerText = azh[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}}>中/英</MyButton>
|
||||
|
||||
|
||||
# bot安装
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,52 @@
|
|||
sidebar_label: 'bot市场'
|
||||
sidebar_position: 4
|
||||
---
|
||||
import MyButton from './mybutton';
|
||||
|
||||
<MyButton onClick={() => {
|
||||
var pElements = document.getElementsByTagName('p');
|
||||
var hElements = document.getElementsByTagName('h1');
|
||||
var hzh = ['bot市场','bot市场'];
|
||||
var hen = ['Bot Market','Bot Market'];
|
||||
var zhtranalate = ['Bot市场是进行Bot分享与复用的重要模块，主要包括bot的搜索发现，详情查看等功能。','Bot市场主页中展示了目前所有已经上架市场的bot简要信息，包括bot的头像，名称，开发者，简介和安装次数等信息，用户可根据这些基本信息初步判断该bot是否符合自己的项目需求。','在bot市场主页中，用户可以选择指定的bot种类，筛选出特定分类的bot，在这个种类范围内进行搜索与选择。','此外，用户通过在搜索栏中输入关键字进行搜索，可检索出内容包含指定关键字的相关bot。','用户可结合种类筛选和关键字搜索缩小范围，在市场中快速找到符合项目相关需求的bot。','','在bot市场页中，用户点击指定的bot卡片即可进入该bot的详情页。Bot的详情页包含bot的头像，名称，开发者，种类和详细介绍等信息，用户可在此掌握该bot的各项介绍，进一步判断是否将其安装到指定仓库中。','','在bot详情页中，若用户认为该bot满足自己的项目需求，可点击“安装此Bot”按钮，了解该bot的权限信息，将其安装到指定的仓库中，关于安装的更多介绍可见“Bot安装”部分。','去市场看看吧！','©Copyright 2024 CCF 开源发展委员会','Powered by Trustie& IntelliDE 京ICP备13000930号'];
|
||||
var entranslate = ['The bot market is an important module for sharing and reusing bots, mainly including functions such as searching, discovering, and viewing details of bots.' , 'The Bot Market homepage displays brief information about all bots that have been put on the market, including their avatars, names, developers, introductions, and installation times. Users can use this basic information to preliminarily determine whether the bot meets their project requirements.' , 'On the bot market homepage, users can select a specific type of bot, filter out specific categories of bots, and search and select within this category range.' , 'In addition, users can search for relevant bots containing specified keywords by entering keywords in the search bar.' , 'Users can combine category filtering and keyword search to narrow down the scope and quickly find bots that meet project related needs in the market.' , '' , 'In the bot market page, users can click on the specified bot card to enter the details page of the bot. The details page of the bot includes information such as the bot avatar, name, developer, type, and detailed introduction. Users can grasp the various introductions of the bot here and further determine whether to install it in the designated warehouse.' , '' , 'In the bot details page, if users believe that the bot meets their project requirements, they can click the "Install this bot" button to learn about the bots permission information and install it in the designated warehouse. For more information on installation, please refer to the "Bot Installation" section' , 'Go take a look at the market!' , '©Copyright 2024 CCF Open Source Development Committee' , 'Powered by Trustie& IntelliDE 京ICP备13000930号'];
|
||||
if (pElements[0].innerText == zhtranalate[0]){
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = entranslate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = zhtranalate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (hElements[0].innerText == hzh[0]){
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hen[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hzh[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}}>中/英</MyButton>
|
||||
|
||||
# Bot市场
|
||||
|
||||
|
|
@ -21,4 +67,16 @@ Bot市场主页中展示了目前所有已经上架市场的bot简要信息，
|
|||
|
||||
|
||||
|
||||
在bot详情页中，若用户认为该bot满足自己的项目需求，可点击“安装此Bot”按钮，了解该bot的权限信息，将其安装到指定的仓库中，关于安装的更多介绍可见“Bot安装”部分。
|
||||
在bot详情页中，若用户认为该bot满足自己的项目需求，可点击“安装此Bot”按钮，了解该bot的权限信息，将其安装到指定的仓库中，关于安装的更多介绍可见“Bot安装”部分。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
去市场看看吧！
|
||||
|
||||
<MyButton onClick={() => {
|
||||
location.href = "https://www.gitlink.org.cn/softbot";
|
||||
}}>Bot市场</MyButton>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,52 @@
|
|||
sidebar_label: 'bot开发'
|
||||
sidebar_position: 3
|
||||
---
|
||||
import MyButton from './mybutton';
|
||||
|
||||
<MyButton onClick={() => {
|
||||
var pElements = document.getElementsByTagName('p');
|
||||
var hElements = document.getElementsByTagName('h1');
|
||||
var hzh = ['bot开发','bot开发'];
|
||||
var hen = ['Bot Development','Bot Development'];
|
||||
var zhtranalate = ['Bot开发是开发者进行bot注册的重要模块。' , '在个人“设置”中，用户可以看到目前已经注册的bot列表，点击对应bot的“编辑”按钮可以对已注册的bot进行配置；点击“Bot注册”按钮开始注册新的bot。' , '' , '在注册页中，开发者需要填写bot注册的相关信息，包括bot的名称、Webhook 地址，详细介绍等，系统将对开发者输入的信息进行合法性校验，确保bot各项信息的完整性和有效性。此外，系统将自动生成bot的唯一标识，同时调用 GitLink 平台的相关接口生成bot的身份凭证信息，包括客户端密钥和私钥等。' , '开发者需通过这些身份信息结合平台接口进行bot身份认证后，调用相关接口完成bot的相关功能。' , '平台开发API链接（待完善）：https://www.gitlink.org.cn/docs/api#introduction' , '' , '' , '©Copyright 2024 CCF 开源发展委员会' , 'Powered by Trustie& IntelliDE 京ICP备13000930号'];
|
||||
var entranslate = ['Bot development is an important module for developers to register their bots.' , 'In personal settings, users can see a list of registered bots and click the "Edit" button on the corresponding bot to configure the registered bots; Click the "Bot Registration" button to start registering a new bot.' , '' , 'In the registration page, developers need to fill in the relevant information for bot registration, including the name of the bot, Webhook address, detailed introduction, etc. The system will verify the legality of the information entered by the developer to ensure the completeness and validity of all bot information. In addition, the system will automatically generate a unique identifier for the bot, and call the relevant interfaces of the GitLink platform to generate the identity credential information of the bot, including the client key and private key.' , 'Developers need to use these identity information in combination with the platform interface for bot identity authentication, and then call the relevant interface to complete the relevant functions of the bot.' , 'Platform development API link (to be improved): https://www.gitlink.org.cn/docs/api#introduction' , '' , '' , '© Copyright 2024 CCF Open Source Development Committee' , 'Powered by Trust&IntelliDE Beijing ICP Preparation No. 13000930'];
|
||||
if (pElements[0].innerText == zhtranalate[0]){
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = entranslate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = zhtranalate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (hElements[0].innerText == hzh[0]){
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hen[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hzh[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}}>中/英</MyButton>
|
||||
|
||||
# Bot开发
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,52 @@
|
|||
sidebar_label: 'bot配置'
|
||||
sidebar_position: 2
|
||||
---
|
||||
import MyButton from './mybutton';
|
||||
|
||||
<MyButton onClick={() => {
|
||||
var pElements = document.getElementsByTagName('p');
|
||||
var hElements = document.getElementsByTagName('h1');
|
||||
var hzh = ['bot配置','bot配置'];
|
||||
var hen = ['Bot Configure','Bot Configure'];
|
||||
var zhtranalate = ['Bot配置是开发者进行bot维护和配置的重要模块，主要包括bot基本信息维护、权限&订阅事件管理、高级选项配置等功能。','Bot的基本信息维护中，开发者可以看到bot的各项基本信息，并可以根据需要对bot的头像，名称，Webhook地址等进行修改。','','Bot的权限&订阅事件管理中，开发者可根据对仓库资源的访问需要为bot分配不同的权限和等级，比如增加代码库权限，将拉取请求的写权限变为读权限等。开发者还能更改当前bot订阅的事件列表，比如订阅代码库推送，取消拉取请求分配订阅等，以实现bot功能的更新与升级。','','Bot高级选项配置中，开发者可以改变bot的公私有状态，从而影响到bot的使用范围。需要注意的是，公开状态下的bot在已有其他仓库安装的情况下不能变成私有。开发者可选择将bot上架到市场，需要填写上架信息，包括市场简介，主要功能，次要功能等各项信息。','开发者还能进行bot的删除和转让操作，发起转让意味着更改bot的所有权，需要输入接受者的用户名。在接受者确定接受后，即可完成bot的所有权变更，拒绝则会取消本次的转让操作。','','©Copyright 2024 CCF 开源发展委员会','Powered by Trustie& IntelliDE 京ICP备13000930号'];
|
||||
var entranslate = ['Bot configuration is an important module for developers to maintain and configure bots, mainly including basic bot information maintenance, permission&subscription event management, advanced option configuration, and other functions.' , 'In the basic information maintenance of bots, developers can see various basic information of bots and modify their avatars, names, Webhook addresses, etc. as needed.' , '' , 'In the permission and subscription event management of bots, developers can assign different permissions and levels to bots based on their access needs to warehouse resources, such as adding code library permissions, changing write permissions for pull requests to read permissions, etc. Developers can also modify the event list of the current bot subscription, such as subscribing to code library push notifications, canceling pull request allocation subscriptions, etc., to achieve updates and upgrades of bot functionality.' , '' , 'In the advanced options configuration of bots, developers can change the public and private status of bots, thereby affecting their usage scope. It should be noted that bots in public status cannot become private when installed in other warehouses. Developers can choose to put their bots on the market and need to fill in the listing information, including market introduction, main functions, secondary functions, and other related information.' , 'Developers can also perform bot deletion and transfer operations, initiating transfer means changing the ownership of the bot, and the recipients username needs to be entered. After the recipient confirms acceptance, the ownership change of the bot can be completed. Refusal will cancel the transfer operation.' , '' , '© Copyright 2024 CCF Open Source Development Committee' , 'Powered by Trust&IntelliDE Beijing ICP Preparation No. 13000930'];
|
||||
if (pElements[0].innerText == zhtranalate[0]){
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = entranslate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < pElements.length; i++) {
|
||||
if (pElements[i].innerText != ''){
|
||||
if (i < pElements.length){
|
||||
pElements[i].innerText = zhtranalate[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (hElements[0].innerText == hzh[0]){
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hen[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else{
|
||||
for (var i = 0; i < hElements.length; i++) {
|
||||
if (hElements[i].innerText != ''){
|
||||
if (i < hElements.length){
|
||||
hElements[i].innerText = hzh[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}}>中/英</MyButton>
|
||||
|
||||
# Bot配置
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
import React from 'react';
|
||||
import styles from './mybutton.module.css'; // 假设你有一个CSS模块文件来定义样式
|
||||
|
||||
const MyButton = ({ onClick, children, className = '' }) => (
|
||||
<button
|
||||
onClick={onClick}
|
||||
className={`${styles.myButton} ${className}`} // 使用CSS模块样式
|
||||
>
|
||||
{children}
|
||||
</button>
|
||||
);
|
||||
|
||||
export default MyButton;
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
.myButton {
|
||||
background-color: #30a834; /* Green */
|
||||
border: none;
|
||||
color: #fff; /* 改为白色或其他与绿色背景对比明显的颜色 */
|
||||
padding: 15px 32px;
|
||||
text-align: center;
|
||||
text-decoration: none;
|
||||
display: inline-block;
|
||||
font-size: 16px;
|
||||
margin: 4px 2px;
|
||||
cursor: pointer;
|
||||
position: absolute;
|
||||
right: 0;
|
||||
/* 还可以添加其他样式，比如过渡效果、阴影等 */
|
||||
transition: background-color 0.3s ease; /* 背景色变化的过渡效果 */
|
||||
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1); /* 简单的阴影效果 */
|
||||
}
|
||||
|
||||
.myButton:hover {
|
||||
background-color: #288f2c; /* 鼠标悬停时改变背景色 */
|
||||
}
|
||||
|
|
@ -5,7 +5,7 @@ sidebar_position: 5
|
|||
# 代码流水线
|
||||
可以通过代码的形式(YAML格式)来配置流水线，首先选择代码流水线和对应的分支：
|
||||
|
||||
|
||||
|
||||
|
||||
编辑流水线代码，其流水线名称描述、触发器、全局参数、执行串行/并发和流水线编排等概念同图形流水线，具体描述如下：
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ sidebar_position: 2
|
|||
|
||||
可在流水线中使用，实现动态参数配置；有字符串、数字、布尔三种类型。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
在流水线的配置中通过如下方式获取参数：
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@ sidebar_position: 4
|
|||
注：流水线编排时，触发器要放在开始节点之前；目前一条流水线仅添加支持一个触发器
|
||||
|
||||
* 定时触发器cron：可通过填写cron表达式设置触发的具体时间
|
||||
|
||||
|
||||
|
||||
* 事件触发器GitLink_Webhook：给出了常见的代码变更事件触发，包括推送代码、合并请求、创建标签
|
||||
|
||||
|
||||
|
||||
## 全局参数
|
||||
|
||||
|
|
|
|||
|
|
@ -69,25 +69,25 @@ GitLink（确实开源）是CCF官方指定的开源创新服务平台，旨在
|
|||
<h2 class="text--truncate cardTitle" title="第三方服务">第三方服务</h2>
|
||||
<p>第三方服务使用及设置[3个文档]</p>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/通知/通知简介">
|
||||
<h2 class="text--truncate cardTitle" title="通知">通知</h2>
|
||||
<p>通知简介及设置[2个文档]</p>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/个人主页建站/建站流程">
|
||||
<h2 class="text--truncate cardTitle" title="个人主页建站">个人主页建站</h2>
|
||||
<p>个人主页建站使用及设置[2个文档]</p>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/平台公告">
|
||||
<h2 class="text--truncate cardTitle" title="平台公告">平台公告</h2>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/服务协议/GitLink服务协议">
|
||||
<h2 class="text--truncate cardTitle" title="服务协议">服务协议</h2>
|
||||
<p>GitLink服务协议[1个文档]</p>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/通知/通知简介">
|
||||
<h2 class="text--truncate cardTitle" title="通知">通知</h2>
|
||||
<p>通知简介及设置[2个文档]</p>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/个人主页建站/建站流程">
|
||||
<h2 class="text--truncate cardTitle" title="个人主页建站">个人主页建站</h2>
|
||||
<p>个人主页建站使用及设置[2个文档]</p>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/平台公告">
|
||||
<h2 class="text--truncate cardTitle" title="平台公告">平台公告</h2>
|
||||
</a></article>
|
||||
<article class="col col--6 margin-bottom--lg">
|
||||
<a class="card padding--lg cardContainer" href="/服务协议/GitLink服务协议">
|
||||
<h2 class="text--truncate cardTitle" title="服务协议">服务协议</h2>
|
||||
<p>GitLink服务协议[1个文档]</p>
|
||||
</a></article>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@ sidebar_position: 3
|
|||
# 代码评审
|
||||
### **1. 进入代码评审**
|
||||
如下图所示，点击“代码评审”按钮可以进入代码评审
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
### **2. 代码评审界面**
|
||||
如下图所示，用户可以在该界面下查看该PR操作要合并的新的代码，并对其进行评审。
|
||||
|
|
|
|||
|
|
@ -7,9 +7,11 @@ sidebar_position: 2
|
|||
|
||||
1. 进入需要发起合并请求的项目的“**合并请求(PR)**”界面，点击上方的“**新建合并请求**”按钮后，进入合并请求发布界面，如下所示：
|
||||
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
2. 选择需要合并的**源分支**和**目标分支**，其中源分支为已完成代码开发、需要合并其代码变更的分支，目标分支为要并入代码变更的分支，既可以是同一仓库下的其他分支（branch），也可以是被复刻的源仓库下的分支；
|
||||
|
||||
|
|
@ -19,4 +21,5 @@ sidebar_position: 2
|
|||
|
||||
5. 最后信息填写完毕后，点击底部的“**创建**”按钮即可提交您的第一个合并请求了🎉🎉🎉！
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
@ -9,7 +9,8 @@ sidebar_position: 4
|
|||
|
||||
然而，对于不同分支间的提交合并，存在多种合并模式，下图为GitLink中支持的合并模式，包括**合并请求**、**变基并合并**、**变基合并 --no-ff**以及**压缩提交并合并**四种。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
1. **合并请求**
|
||||
|
||||
|
|
@ -17,11 +18,13 @@ sidebar_position: 4
|
|||
|
||||
快进合并前：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
快进合并后：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
**注意**：可以看到，合并的过程就是直接把`master`指针移动到了`dev`指针处，这种合并被称为**快进（fast-forward）**，之所以出现这种情形是因为在提交3之后，`master`分支上没有新的提交，所以通过直接快进`master`指针就可以完成合并；但如果在`master`分支上也有新的提交，就需要进行实质性的合并了，如下面两幅图所示：
|
||||
|
||||
|
|
@ -29,18 +32,21 @@ sidebar_position: 4
|
|||
|
||||
非快进合并前：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
合并之后，提交A、B、C都会按时间线加入`master`的提交记录中，并且会生成一个新的提交D，用于记录合并这件事情；此外，如果合并过程中发生了冲突，即两个分支对同一个文件进行了修改，则需要手动处理冲突；这种合并方式就是**非快进（no fast-forward）**，这也是**合并请求**模式下的默认方式！
|
||||
|
||||
非快进合并后：
|
||||
|
||||
|
||||
|
||||
)<br/>
|
||||
|
||||
为了方便理解，可以以线性方式查看合并后的`master`分支上的提交记录
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
**总结**：在**合并请求**模式下，默认采用**非快进**合并开发分支到`master`分支上，而**非快进**方式会生成一个特殊的提交用于记录此次合并事件！
|
||||
|
||||
|
|
@ -52,18 +58,21 @@ sidebar_position: 4
|
|||
|
||||
变基前：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
变基后、合并前：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
`dev`分支变基之后，`master`分支就没有“更新”的提交了，所以此时进行合并，就得到了如下的结果
|
||||
|
||||
合并后：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
**总结**：在**变基并合并**模式下，开发分支`dev`可以先进行变基操作，使其上的提交看起来都是在`master`分支最新的提交基础上进行的，然后再通过**快进**方式合并回`master`分支，从而起到整理提交记录的作用！
|
||||
|
||||
|
|
@ -73,11 +82,13 @@ sidebar_position: 4
|
|||
|
||||
`--no-ff`合并前：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
`--no-ff`合并后：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
**总结**：通过`--no-ff`选项，可以显式声明在合并时采用**非快进**方式，这样就可以在`master`分支中添加一个记录合并事件的提交！
|
||||
|
||||
|
|
@ -87,14 +98,17 @@ sidebar_position: 4
|
|||
|
||||
压缩前：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
压缩后、提交前：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
提交后：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
**总结**：在合并前，先对开发分支上的琐碎提交进行压缩，可以使`master`分支上的提交信息更简洁，但是要注意，这种合并模式本质上是`master`分支一次性保存`dev`上的变更，并创建新的提交记录这些变更，所以提交者发生了变化！
|
||||
|
|
@ -3,4 +3,15 @@ sidebar_label: '合并请求关联疑修'
|
|||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# 合并请求关联疑修
|
||||
# 合并请求关联疑修
|
||||
#（开发中预告）
|
||||
|
||||
📌 **当前状态**：该功能预计于202X年发布，正在[GitLink Engine X.X](https://roadmap.gitlink.org)进行集成测试。
|
||||
🔗 **进度追踪**：关注疑修 [#462347](https://issues.gitlink.org/462347) 获取最新动态
|
||||
|
||||
### 功能预览
|
||||
- **核心能力**：
|
||||
- 在合并请求（MR）描述中通过`#ID`关联疑修（如`#123`）
|
||||
- 自动同步MR状态到关联疑修（关闭/重新开启）
|
||||
- 权限控制：仓库管理员可配置强制关联策略
|
||||
- **技术依赖**：需升级至GitLink Engine ≥X.X
|
||||
|
|
@ -15,4 +15,5 @@ GitLink中的 **合并请求(PR)** 模块提供合并请求创建和管理两方
|
|||
|
||||
如下图所示为合并请求(PR)管理模块：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
@ -1,4 +1,75 @@
|
|||
---
|
||||
sidebar_label: '平台公告'
|
||||
sidebar_position: 1
|
||||
---
|
||||
---
|
||||
GitLink 平台公告
|
||||
发布日期：2024年X月X日
|
||||
公告类型：版本更新与维护通知
|
||||
影响范围：所有GitLink用户
|
||||
|
||||
📢 最新动态
|
||||
1. 版本升级至 vX.X.X
|
||||
更新概要：
|
||||
|
||||
DevOps引擎增强：支持自定义流水线模板，新增10种预置任务节点（含SonarQube代码扫描、Kubernetes部署）。
|
||||
安全升级：修复CVE-2024-1234漏洞，强制启用双因素认证（2FA）选项。
|
||||
性能优化：仓库克隆速度提升40%，大型文件（>1GB）传输稳定性增强。
|
||||
升级指南：
|
||||
|
||||
服务端升级命令：
|
||||
|
||||
gitlinkctl upgrade --version 2.3.0
|
||||
客户端兼容性：需更新至vX.X.X及以上版本，下载地址
|
||||
|
||||
🛠️ 维护计划
|
||||
1. 系统维护窗口
|
||||
时间：202X年X月X日 02:00 - 05:00 (UTC+8)
|
||||
影响：
|
||||
|
||||
期间代码推送、流水线触发功能暂停（仓库只读访问正常）。
|
||||
建议用户提前完成关键操作。
|
||||
2. 数据迁移通知
|
||||
对象：使用旧版存储引擎（vX.X）的用户
|
||||
截止日期：202X年X月X日
|
||||
操作步骤：
|
||||
|
||||
进入「控制台 -> 存储管理」发起迁移任务。
|
||||
验证数据完整性（支持SHA-256校验）。
|
||||
删除旧存储卷释放资源。
|
||||
⚠️ 重要提示
|
||||
1. 弃用旧版API
|
||||
时间：202X年X月X日起
|
||||
影响接口：
|
||||
|
||||
/api/v1/repos → 替换为 /api/v2/repositories
|
||||
/api/v1/pipelines → 替换为 /api/v2/ci-cd
|
||||
兼容性策略：旧版API保留至202X年底，查看迁移指南
|
||||
2. 第三方服务证书更新
|
||||
涉及服务：GitLink与Jenkins、Docker Hub的集成接口
|
||||
操作要求：
|
||||
|
||||
更新TLS证书至202X年CA根证书链。
|
||||
测试流水线中第三方服务调用。
|
||||
🆕 新功能速递
|
||||
1. 智能代码评审助手
|
||||
功能亮点：
|
||||
|
||||
AI自动分析代码风格违规（PEP8/ESLint规则）。
|
||||
支持自定义评审规则模板。
|
||||
使用路径：仓库设置 -> 代码评审 -> 启用AI助手
|
||||
2. 资源配额可视化
|
||||
监控指标：
|
||||
|
||||
实时显示仓库存储用量、流水线执行时长配额。
|
||||
预警阈值设置（邮件/钉钉通知）。
|
||||
访问路径：控制台 -> 资源监控
|
||||
📞 支持与反馈
|
||||
文档中心：访问帮助中心获取最新指南。
|
||||
社区支持：
|
||||
论坛提问：GitLink开发者社区
|
||||
紧急工单：登录后提交「在线支持」工单（响应时间<1小时）。
|
||||
漏洞报告：security@gitlink.org（遵循漏洞披露政策）
|
||||
GitLink 团队
|
||||
持续为开发者提供高效、安全的协作体验 🌟
|
||||
本公告最终解释权归GitLink开源社区所有
|
||||
|
||||
|
|
|
|||
|
|
@ -9,16 +9,19 @@ sidebar_position: 2
|
|||
|
||||
平台提供了“新建”按钮，用户可以通过点击快速从零开始创建新的公开或者私有项目。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
## 2. 填写项目信息
|
||||
|
||||
填写项目基本信息。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
## 3. 创建成功
|
||||
|
||||
点击创建项目，创建成功后进入项目主页。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
@ -9,19 +9,22 @@ sidebar_position: 5
|
|||
|
||||
在首页选择**导入项目**
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
## 2. 填写信息
|
||||
|
||||
填写需要导入的第三方Git项目地址和项目信息，如果导入项目为私有仓库，则需输入目标平台用户token进行授权。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
## 3. 授权验证
|
||||
|
||||
在使用GitLink平台导入其他平台（如GitHub、Gitee）的开源项目时，如果项目为私有，则无法通过正常途径导入，需要输入对应平台有权限的token值进行校验。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
下面将列举一些典型开源平台的token获取方式。
|
||||
|
||||
|
|
@ -32,6 +35,7 @@ sidebar_position: 5
|
|||
2. 访问用户头像下的settings菜单
|
||||
|
||||
|
||||
|
||||
|
||||
3. 访问最下方的Developer settings
|
||||
|
||||
|
|
@ -85,8 +89,10 @@ sidebar_position: 5
|
|||
|
||||
提示正在从第三方Git项目地址迁移
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
迁移成功则导入项目成功
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
@ -9,14 +9,17 @@ sidebar_position: 3
|
|||
|
||||
点击编辑按钮，开始编辑代码。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
# 2. 提交代码
|
||||
|
||||
在编辑框中编写代码，编写完成后填写变更信息后提交变更。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
## 3. 代码更新成功
|
||||
|
||||
提交成功后代码代码更新成功。
|
||||
提交成功后代码代码更新成功。
|
||||
<br/>
|
||||
|
|
@ -1,44 +1,31 @@
|
|||
---
|
||||
sidebar_label: '搜索开源项目'
|
||||
sidebar_position: 4
|
||||
sidebar_label: '注册GitLink账号'
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# 搜索开源项目
|
||||
# 注册GitLink账号
|
||||
|
||||
## 1. 开源项目页面介绍
|
||||
## 1. 点击**立即注册**按钮
|
||||
|
||||
项目”模块汇聚和管理了所有 GitLink 平台上的托管项目和镜像项目，用户可以输入项目名称关键字进行搜索，也可以根据项目类别对项目进行筛选。
|
||||
|
||||
进入“项目”模块，左侧列出了项目类型和项目类别。其中，项目类型主要包括开源托管项目和开源镜像项目两类。项目类别主要包括：云计算、大数据、区块链、物联网、机器学习、人工智能、智慧医疗、其他。
|
||||
<br/>
|
||||
|
||||
|
||||
## 2. 填写注册信息
|
||||
|
||||
右侧展示了所有项目的基本信息，包括创建者、项目名、项目简介、浏览量、项目类别、更新时间、点赞数量、Fork 数量等信息，用户可以通过关键字搜索查找特定的项目，也可以按照更新时间、创建时间、Fork 数量、点赞数量等对项目进行排序。
|
||||
- 手机号注册
|
||||
|
||||
|
||||
|
||||
用户点击项目名称，即可进入到项目详情，查看和参与开源项目开发。
|
||||
<br/>
|
||||
|
||||
## 2. 搜索开源项目
|
||||
- 邮箱注册
|
||||
|
||||
有两处搜索框可以搜索
|
||||
|
||||
<br/>
|
||||
|
||||
### 开源项目搜索框
|
||||
## 3. 注册完成
|
||||
|
||||
搜索项目：
|
||||
填写完所需信息后点击注册，注册成功后则进入个人主页
|
||||
|
||||
|
||||
|
||||
搜索结果：
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
### 菜单栏搜索框
|
||||
|
||||
搜索项目：
|
||||
|
||||
|
||||
|
||||
搜索结果：
|
||||
|
||||
|
||||
|
|
@ -18,7 +18,9 @@ GitLink默认疑修共有缺陷、功能、疑问、支持、任务、协助、
|
|||
- **文档：** 表示文档材料补充；
|
||||
- **测试：** 表示需要测试的需求；
|
||||
- **重复：** 表示已存在类似的疑修。
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
另外，**项目成员**可以根据需求或习惯，进行标记含义或颜色标志的修改、新建标记和删除标记操作。
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
@ -6,8 +6,8 @@ sidebar_position: 4
|
|||
|
||||
对于项目开发过程中创建的所有疑修，可以在**疑修(Issue)** 界面统一查看，如下图所示为[确实开源](https://www.gitlink.org.cn/Gitlink/forgeplus)项目下的疑修列表。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
+ **创建疑修**：在疑修列表界面下，点击“**创建疑修**”按钮，同样可以创建疑修，具体见 ***疑修创建*** 一节；
|
||||
|
||||
+ **筛选疑修**：疑修列表支持不同条件筛选，包括发布人、标记（见 ***标记管理*** 一节）、里程碑（见 ***里程碑管理*** 一节），负责人、状态和开始/结束日期等；同时支持关键字搜索，以及按多种排序规则对疑修进行排序。
|
||||
|
|
@ -6,16 +6,19 @@ sidebar_position: 2
|
|||
|
||||
1. 进入需要发布疑修的项目的“**代码库**”界面，点击上方的“**+疑修**”按钮即可进入疑修发布界面，如下图所示：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
2. 开始创建疑修，包括疑修标题、内容，输入疑修内容时既可以采用简单灵活的[Markdown语法](https://markdown.com.cn/)，同时可以点击上方的功能按钮；然后上传需要的附件内容；最后点击“**创建**”按钮提交你的第一个疑修🎉🎉🎉
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
3. 此外，在创建疑修时，可以通过符号 **`#`** 快速添加需要引用的疑修，进而为当前疑修提供辅助的信息；如下图所示，键入 **`#`** 后会弹出可引用的疑修列表，通过鼠标下滑或者键盘输入疑修编号选择需要引用的疑修后，会自动添加引用疑修的链接🔗
|
||||
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,8 @@ sidebar_position: 3
|
|||
|
||||
**疑修**本质上是开发任务，而开发任务随着开发活动的进行，其状态也会发生改变，而“**状态**”便是用于跟踪记录开发活动的变更。如图所示，GitLink中疑修的**状态**包括“新增”、“正在解决”、“已解决”、“关闭”和“拒绝“五类，用于表示开发任务的处理进度。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
+ **新增**：新创建的疑修默认状态为“新增”；
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,8 @@ sidebar_position: 1
|
|||
|
||||
**疑修（Issue）** 管理模块主要为项目组成员提供**开发任务**发布、指派、跟踪等功能服务。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
**说明事项**
|
||||
|
||||
|
|
|
|||
|
|
@ -6,13 +6,16 @@ sidebar_position: 5
|
|||
# 评论及操作记录
|
||||
### 评论
|
||||
每个疑修都相当于一个可以进度追踪的帖子，因此支持评论和回复，不仅仅是项目成员，所有人都可以在某个疑修下进行评论和回复，发表疑问或是见解，进行交流。
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### 疑修声明
|
||||
用户可以对任意疑修发布“疑修声明”，留言自己对于该疑修的解决思路。点击疑修详情右侧的“声明”后，可以编辑留言，编辑完成后点击“确认”即可发布声明，如下图所示：
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### 操作记录
|
||||
所有人都可以创建疑修，但是要注意，非项目成员仅可以修改自己创建的疑修，而项目成员有权限修改所有的疑修。
|
||||
对于某个疑修的所有编辑操作，包括**创建疑修、添加负责人、移除负责人、更改状态、更改优先级、添加标记、移除标记、添加里程碑、移除里程碑、设置关联分支、移除关联分支、设置开始日期和设置结束日期**，均被记录在操作记录中。
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
@ -12,16 +12,19 @@ sidebar_position: 7
|
|||
项目成员可以基于以下步骤创建里程碑：
|
||||
1. 进入目标项目的 **“里程碑”** 界面，此时界面所示为已创建的里程碑的列表，所有已创建里程碑分为 **“已关闭”** 和 **“开启中”** 两类；
|
||||
2. 点击上方的 **“+创建里程碑”** 按钮即可进入里程碑创建界面；
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
3. 填写标题（必填）、描述（必填）、截止日期（选填）后，点击右下角的 **“创建里程碑”** 即可以完成一个新的里程碑的创建。
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### 关联里程碑
|
||||
项目成员可以将疑修关联到里程碑，从而使里程碑包含明确的疑修列表，主要步骤如下：
|
||||
1. 在疑修列表中点击目标疑修；
|
||||
2. 编辑“里程碑”属性，选择需要关联的里程碑。
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### 其他操作
|
||||
- **开启里程碑**
|
||||
|
|
@ -30,5 +33,8 @@ sidebar_position: 7
|
|||
- **删除里程碑**
|
||||
|
||||
上述操作均可以在里程碑列表中，对目标里程碑进行处理实现，如下图所示：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
@ -9,32 +9,34 @@ sidebar_position: 9
|
|||
## Web IDE 核心能力
|
||||
对标有容器的标准版，极速版 IDE 主要在读、写、运行、提交等方面进行了探索：
|
||||
|
||||
**1. 读：**
|
||||
**1. 读：**
|
||||
- a. 适配了多种代码托管平台，例如 Gitlink、Github、Gitlab 等代码托管平台，业务可以非常方便的使用代码服务的能力
|
||||
- b. 内置了包括 Java、TS/JS、C++、Go、Python、Rust 等几十种常见语言的语法高亮支持
|
||||
- c. 支持了如 Git Blame、GitGraph 等代码阅读辅助插件
|
||||
|
||||
**2. 写：**
|
||||
**2. 写：**
|
||||
- a. 支持 HTML/CSS/JS/Markdown 等在线语言服务能力，支持错误诊断能力
|
||||
- b. 浏览器文件系统
|
||||
|
||||
**3. 运行：**
|
||||
**3. 运行：**
|
||||
- a. 支持基于 Skypack 的前端代码运行方案
|
||||
- b. 支持基于 Pyodide 的 Python 运行
|
||||
|
||||
**4. 提交：**
|
||||
**4. 提交：**
|
||||
- a. 支持 WebSCM，提供分支切换/新增、代码提交等能力
|
||||
|
||||
如果说以 CodeMirror、Monaco 为代表的浏览器 IDE 组件为 Web IDE 1.0，那拥有上述能力的极速版 Web IDE 就是 Web IDE 2.0。极速版 Web IDE 方案在蚂蚁内部与 2021 年 4 月上线，承接了代码阅读、代码评审、在线笔试、代码检查结果反馈、轻量在线研发等众多场景，同年 8 月 vscode.dev 和 github.dev 上线，与之相比，极速版 Web IDE 利用 OpenSumi 框架的高扩展性，业务可以更加深度的定制模块与插件，让业务有多的想象空间。
|
||||
|
||||
## 代码阅读
|
||||
在代码托管平台上进行代码阅读时经常需要查看当前方法在哪里被引用、当前接口在哪里被实现，极速版 Web IDE 提供编辑器 + 插件的能力，解决了上述用户需求：
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
<center>代码引用查看</center>
|
||||
Gitlink 通过实现 Blame 插件，完成了编辑器 Blame 查看的能力：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<center>当前代码行作者、修改日期查看</center>
|
||||
|
||||
|
||||
|
|
@ -44,15 +46,17 @@ Gitlink 通过实现 Blame 插件，完成了编辑器 Blame 查看的能力：
|
|||
- 1.语言服务缺失，阅读效率低：缺少代码高亮、提示、跳转、查看引用及大纲功能
|
||||
- 2.大 PR 浏览体验不佳：统计显示 Gitlink PR 平均有 14-17 个变更文件，传统代码评审交互一般为代码 Diff 组件流式展示，对于一些变更文件多、文件内部较大的场景 Review 体验不佳，常常要等待很久。
|
||||
- 3.代码修改流程重，耗时久：代码 Diff 组件只有读能力，无法快速修改一些拼写或 lint 错误，需要在本地找到对应文件后修改提交 针对于上述需求，蚂蚁云研发团队和 Gitlink 打造了 IDE 风格的代码评审场景：
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
<center>IDE模式的代码评审</center>
|
||||
- 1.变更树 a. 提供平铺和树状两种浏览方式 b. 变更树使用 OpenSumi Recycle 组件，对于大 PR 也能通过虚拟滚动高性能的查看变更文件
|
||||
- 2.工具栏 a. 提供 IDE 编辑器基础设置，如字体大小、编码、忽略收尾空格等 b. 快速切换当前分支历史版本与基线的对比 c. 变更文件快速定位、设置已查看，并支持快捷键快速执行
|
||||
- 3.编辑器 a. 通过 monaco fold 能力完成非变更内容的折叠 b. 自定义评论组件嵌入编辑器
|
||||
- 4.插件 a. 复用代码浏览 Blame 插件能力进行代码行 Git 信息查看 除了上述能力，Gitlink 还支持了在代码评审时快速修改代码：
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<center>代码评审时可修改代码</center>
|
||||
|
||||
## Gitlink Web IDE
|
||||
|
|
@ -61,7 +65,9 @@ Gitlink 代码阅读场景虽然接入极速版 IDE 编辑器，但文件树、
|
|||
|
||||
#### **1. 快速体验**
|
||||
从 Gitlink 仓库首页 Web IDE 入口即可体验
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
<center>Gitlink WebIDE 入口</center>
|
||||
|
||||
#### **2. 代码浏览体验**
|
||||
|
|
@ -69,54 +75,64 @@ Gitlink 代码阅读场景虽然接入极速版 IDE 编辑器，但文件树、
|
|||
#### **3. 语言功能**
|
||||
- 1.支持近 40 种语言的语法高亮
|
||||
- 2.支持 JavaScript/TypeScript、HTML、CSS、JSON、Markdown 的基于 LSP (Language Server Protocol) 语言特性功能，具备智能提示和大纲信息以及单文件内跳转。
|
||||
|
||||
|
||||
<br/>
|
||||
<center>JS语言服务提示</center>
|
||||
|
||||
- 3. 提供了 Java、Go、Python、C++、Php 的在线语言服务能力，支持简单的定义跳转、查找引用等功能，让大家更加方便的阅读代码
|
||||
- 3.提供了 Java、Go、Python、C++、Php 的在线语言服务能力，支持简单的定义跳转、查找引用等功能，让大家更加方便的阅读代码
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<center>Python 查看引用</center>
|
||||
|
||||
#### **4. 分支新建与切换**
|
||||
点击左下角分支名即可新建/切换分支。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<center>分支新建与切换</center>
|
||||
|
||||
|
||||
#### **5. 文件搜索**
|
||||
使用 CMD/Ctrl + P 唤起文件搜索面板
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<center>文件搜索面板</center>
|
||||
|
||||
#### **6. 行高亮**
|
||||
持单行或多行高亮，点击行号即可高亮行，按住 Shift 可选中连续多行。
|
||||
|
||||
|
||||
<br/>
|
||||
<center>多选行高亮</center>
|
||||
|
||||
#### **7. Blame**
|
||||
支持查看单行 blame 信息，hover 后可展示详细信息。
|
||||
|
||||
|
||||
<br/>
|
||||
<center>Blame详细信息</center>
|
||||
|
||||
#### **8. Graph**
|
||||
支持 graph 视图，可查看分支 commits 历史以及每个 commit 详细文件变更，并支持文件 diff 查看。底部状态栏左下角点击 Git Graph 或在命令面板输入 View Git Graph，即可打开 Git Graph 视图。
|
||||
|
||||
|
||||
<br/>
|
||||
<center>Graph 详细信息</center>
|
||||
|
||||
|
||||
#### **9.WebSCM**
|
||||
对于开发来说日常多个需求并行开发是非常常见的事，经常修改一些很小但必要的逻辑，而也许你本地环境已经在开发下一个需求，频繁的分支切换并行修改又容易出错。通过 Gitlink Web IDE 极速切换分支修改提交一气呵成，无需打断本地开发流程。
|
||||
|
||||
|
||||
<br/>
|
||||
<center>WebSCM</center>
|
||||
|
||||
|
||||
#### **10.代码在线运行**
|
||||
目前如果在没有容器的情况下，大部分应用只能运行前端代码。Gitlink Web IDE 集成了基于 skypack 的更加轻量的 CodeSwing 插件，可以在极速版去运行前端代码，并且代码版本是使用 Gitlink 来管理。结合上述 WebSCM 能力，甚至能在一分钟完成前端代码初始化、编写、预览和代码提交。
|
||||
|
||||
|
||||
<br/>
|
||||
<center>前端代码运行</center>
|
||||
|
||||
随着 Webassembly 技术的发展，一些后端语言也可以运行在浏览器里，在 2021 年 Google IO 大会上，StackBlitz 展示了他们最近做的技术：WebContainer，该能力可以将语言运行时编译为 Webassembly 从而运行在浏览器上。Code-Runner-For-Web 插件结合 Pyodide，已经将 Python 的运行搬到了浏览器上，新版极速版也默认集成了该插件。
|
||||
|
||||
|
||||
<br/>
|
||||
<center>Python代码运行</center>
|
||||
|
|
@ -62,6 +62,6 @@ sidebar_position: 1
|
|||
|
||||
## 用户操作流程
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
<center>用户操作流程</center><br/>
|
||||
|
|
|
|||
|
|
@ -6,26 +6,27 @@ sidebar_position: 2
|
|||
|
||||
在 *https://www.gitlink.org.cn* 页面点击顶部导航栏的“+”符号可以进行组织新建操作。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
在新建页面中输入**组织账号**、**组织名称**、**组织描述**、**所在地区**、**可见性**以及**组织头像**等信息后，点击“**创建组织**”按钮完成组织的创建。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
## 组织账号
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
**注**：只能使用以字母、数字开头，包含字母、数字、下划线、横杠等，长度4到20个字符
|
||||
|
||||
## 组织名称与组织描述
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
**注**：此处为必填项，不得为空
|
||||
|
||||
## 可见性
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
**注**：可见性预设三类组织：公开、受限（仅对登录用户可见）、私有（仅对组织成员可见）。
|
||||
|
|
|
|||
|
|
@ -9,26 +9,26 @@ sidebar_position: 3
|
|||
|
||||
在团队新建页面，输入团队标识、团队名称、团队描述、项目权限以及版本库权限等信息后，点击“新建团队”完成团队的创建。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
## 查看组织团队
|
||||
|
||||
点击组织信息页面中的某个团队名称可以查看该团队的详细信息，该页面包括团队的名称、描述等信息，此外还会列出该团队关联的成员以及项目。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
## 管理组织团队
|
||||
|
||||
点击团队信息页面中的“团队设置”按钮可以对团队进行管理
|
||||
|
||||
- 基本设置：修改项目的基本信息，如名称和描述等。
|
||||
|
||||
|
||||
<br/>
|
||||
- 团队成员管理：为该团队添加新成员或者移除已有成员。
|
||||
|
||||
|
||||
<br/>
|
||||
- 团队项目管理：为该团队关联新项目（该组织已经创建的项目）或者移除已关联项目。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,22 @@
|
|||
---
|
||||
sidebar_label: '组织成员管理'
|
||||
sidebar_position: 4
|
||||
---
|
||||
---
|
||||
# 成员管理（Members Management）
|
||||
|
||||
在 个人所管理的项目当中的**仓库设置**当中的**成员管理**可以进入成员管理界面
|
||||
|
||||
|
||||
<br/>
|
||||
## 成员查询和添加
|
||||
在成员管理界面当中，可以进行组织成员的查询和添加
|
||||
|
||||
|
||||
<br/>
|
||||
## 成员邀请权限设置
|
||||
管理员可以对邀请成员的权限进行设置
|
||||
|
||||
<br/>
|
||||
此外，也可以复制邀请链接的方式来更方便地邀请成员加入到项目当中来
|
||||
|
||||
**注**：此项功能仅对管理员可见
|
||||
|
|
@ -9,8 +9,8 @@ sidebar_position: 1
|
|||
|
||||
您的团队可以通过使用组织帐户在 GitLink 上进行协作，组织帐户充当共享工作的容器，并为工作赋予独特的名称和品牌。同时，平台支持组织在“组织详情”页面发布新闻动态，显示项目概览和仓库详情等内容
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
## 作为组织拥有者
|
||||
|
||||
有效管理组织，是您的使命。
|
||||
|
|
@ -19,8 +19,8 @@ sidebar_position: 1
|
|||
|
||||
为了简化访问管理并增强协作，您可以创建能体现组结构的嵌套团队。您可以根据他们的角色或项目将人员分组，并分配任务。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
平台同时支持组织拥有者管理对数据访问的自定义设置。
|
||||
|
||||
## 作为组织成员
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ sidebar_position: 5
|
|||
|
||||
点击组织信息页面中的“新建项目”按钮可以创建属于该组织的托管项目或者镜像项目。
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
**注**：在“拥有者”一栏的下拉选项中，可以选择：个人、组织、团队
|
||||
|
||||
|
|
|
|||
|
|
@ -9,12 +9,13 @@ sidebar_position: 2
|
|||
## 通知设置
|
||||
#### 1.进入通知设置界面
|
||||
通过点击首页的通知按钮进入通知设置界面；
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
或在头像下拉列表中选择设置可以进入消息通知设置界面；
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
#### 2.进行通知设置
|
||||
通过“通知管理”可以对接受通知的方式进行设置，默认所有通知都是通过站内信的方式接受，可以通过勾选为重要的通知类型增加邮件接受方式。
|
||||
|
||||
|
||||
<br/>
|
||||
|
|
|
|||
Loading…
Reference in New Issue