diff --git a/docusaurus.config.js b/docusaurus.config.js index 811bc7b..943c594 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -156,7 +156,7 @@ module.exports = { '@docusaurus/preset-classic', { docs: { - // sidebarPath: require.resolve('./sidebars.js'), + sidebarPath: require.resolve('./sidebars.js'), editUrl:'https://www.gitlink.org.cn/Gitlink/gitlink_help_center/tree/master/', routeBasePath: "/", }, diff --git a/sidebars.js b/sidebars.js index 889a90e..e9e3787 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,9 +1,56 @@ module.exports = { - DocsSidebar: [ + docs: [ { - type: 'doc', - id: 'index', - label: 'Docs', - } + type: 'category', + label: '快速开始', + items: [ + '快速开始/webide', + '快速开始/account-management', + '快速开始/keyboard-shortcuts', + ], + }, + { + type: 'category', + label: '代码库管理', + items: [ + '代码库管理/repository-settings', + '代码库管理/template-repositories', + ], + }, + { + type: 'category', + label: 'DevOps引擎', + items: [ + 'DevOps引擎/ci-config-validation', + ], + }, + { + type: 'category', + label: '合并请求', + items: [ + '合并请求/merge-request-guide', + ], + }, + { + type: 'category', + label: '疑修', + items: [ + '疑修/issue-management', + ], + }, + { + type: 'category', + label: '第三方服务', + items: [ + '第三方服务/api-guide', + ], + }, + { + type: 'category', + label: '版本说明', + items: [ + 'intro/version-differences', + ], + }, ], }; diff --git a/versioned_docs/version-1.1.0/Bot市场/bot安装.md b/versioned_docs/version-1.1.0/Bot市场/bot安装.md index 21ca1c5..1cd6f1d 100644 --- a/versioned_docs/version-1.1.0/Bot市场/bot安装.md +++ b/versioned_docs/version-1.1.0/Bot市场/bot安装.md @@ -2,6 +2,74 @@ sidebar_label: 'bot安装' sidebar_position: 1 --- +import MyButton from './mybutton'; + + { +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]; + } + } +} +} +}}>中/英 + # bot安装 @@ -9,12 +77,12 @@ Bot安装是进行bot安装和管理控制的重要模块,主要包括bot安 在bot详情页,用户点击“安装此Bot”按钮后,可以看到该bot工作所需的各项权限信息。若用户同意授予bot所需的相关权限即可进行安装。用户可选择将bot安装到所有仓库(用户拥有的所有仓库)中,也可以选择指定的仓库进行安装。 -![botinstall1](../../../static/img/bot/botinstall1.png) +![botinstall1](../../static/img/bot/botinstall1.png) 在个人“设置”或者“仓库设置”中,用户可以看到目前已经安装的Bot情况,点击“配置”按钮可以对bot安装情况进行配置,点击“卸载”按钮可以进行卸载。 -![botinstall2](../../../static/img/bot/botinstall2.png) +![botinstall2](../../static/img/bot/botinstall2.png) 在bot安装配置页中,用户可以掌握该bot的安装位置和工作状态。若用户需要更改bot的工作仓库时,可以进行更改安装位置。bot的工作状态包括激活和挂起,用户可根据需要对bot的状态进行调整,将其挂起或者激活,会影响到bot对仓库数据的访问权限。 -![botinstall3](../../../static/img/bot/botinstall3.png) \ No newline at end of file +![botinstall3](../../static/img/bot/botinstall3.png) \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/Bot市场/bot市场.md b/versioned_docs/version-1.1.0/Bot市场/bot市场.md index 36cc7ad..fcff76b 100644 --- a/versioned_docs/version-1.1.0/Bot市场/bot市场.md +++ b/versioned_docs/version-1.1.0/Bot市场/bot市场.md @@ -2,6 +2,52 @@ sidebar_label: 'bot市场' sidebar_position: 4 --- +import MyButton from './mybutton'; + + { +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]; + } + } +} +} +}}>中/英 # Bot市场 @@ -15,10 +61,22 @@ Bot市场主页中展示了目前所有已经上架市场的bot简要信息, 用户可结合种类筛选和关键字搜索缩小范围,在市场中快速找到符合项目相关需求的bot。 -![botmarket1](../../../static/img/bot/botmarket1.png) +![botmarket1](../../static/img/bot/botmarket1.png) 在bot市场页中,用户点击指定的bot卡片即可进入该bot的详情页。Bot的详情页包含bot的头像,名称,开发者,种类和详细介绍等信息,用户可在此掌握该bot的各项介绍,进一步判断是否将其安装到指定仓库中。 -![botmarket2](../../../static/img/bot/botmarket2.png) +![botmarket2](../../static/img/bot/botmarket2.png) + +在bot详情页中,若用户认为该bot满足自己的项目需求,可点击“安装此Bot”按钮,了解该bot的权限信息,将其安装到指定的仓库中,关于安装的更多介绍可见“Bot安装”部分。 + + + + + +去市场看看吧! + + { +location.href = "https://www.gitlink.org.cn/softbot"; +}}>Bot市场 + -在bot详情页中,若用户认为该bot满足自己的项目需求,可点击“安装此Bot”按钮,了解该bot的权限信息,将其安装到指定的仓库中,关于安装的更多介绍可见“Bot安装”部分。 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/Bot市场/bot开发.md b/versioned_docs/version-1.1.0/Bot市场/bot开发.md index baa62a6..452f564 100644 --- a/versioned_docs/version-1.1.0/Bot市场/bot开发.md +++ b/versioned_docs/version-1.1.0/Bot市场/bot开发.md @@ -2,6 +2,52 @@ sidebar_label: 'bot开发' sidebar_position: 3 --- +import MyButton from './mybutton'; + + { +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]; + } + } +} +} +}}>中/英 # Bot开发 @@ -9,7 +55,7 @@ Bot开发是开发者进行bot注册的重要模块。 在个人“设置”中,用户可以看到目前已经注册的bot列表,点击对应bot的“编辑”按钮可以对已注册的bot进行配置;点击“Bot注册”按钮开始注册新的bot。 -![botcreate1](../../../static/img/bot/botcreate1.png) +![botcreate1](../../static/img/bot/botcreate1.png) 在注册页中,开发者需要填写bot注册的相关信息,包括bot的名称、Webhook 地址,详细介绍等,系统将对开发者输入的信息进行合法性校验,确保bot各项信息的完整性和有效性。此外,系统将自动生成bot的唯一标识,同时调用 GitLink 平台的相关接口生成bot的身份凭证信息,包括客户端密钥和私钥等。 @@ -17,6 +63,6 @@ Bot开发是开发者进行bot注册的重要模块。 平台开发API链接(待完善):https://www.gitlink.org.cn/docs/api#introduction -![botcreate2](../../../static/img/bot/botcreate2.png) +![botcreate2](../../static/img/bot/botcreate2.png) -![botcreate3](../../../static/img/bot/botcreate3.png) \ No newline at end of file +![botcreate3](../../static/img/bot/botcreate3.png) \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/Bot市场/bot配置.md b/versioned_docs/version-1.1.0/Bot市场/bot配置.md index cb43c62..b271abf 100644 --- a/versioned_docs/version-1.1.0/Bot市场/bot配置.md +++ b/versioned_docs/version-1.1.0/Bot市场/bot配置.md @@ -2,6 +2,52 @@ sidebar_label: 'bot配置' sidebar_position: 2 --- +import MyButton from './mybutton'; + + { +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]; + } + } +} +} +}}>中/英 # Bot配置 @@ -9,15 +55,15 @@ Bot配置是开发者进行bot维护和配置的重要模块,主要包括bot Bot的基本信息维护中,开发者可以看到bot的各项基本信息,并可以根据需要对bot的头像,名称,Webhook地址等进行修改。 -![botconfig1](../../../static/img/bot/botconfig1.png) +![botconfig1](../../static/img/bot/botconfig1.png) Bot的权限&订阅事件管理中,开发者可根据对仓库资源的访问需要为bot分配不同的权限和等级,比如增加代码库权限,将拉取请求的写权限变为读权限等。开发者还能更改当前bot订阅的事件列表,比如订阅代码库推送,取消拉取请求分配订阅等,以实现bot功能的更新与升级。 -![botconfig2](../../../static/img/bot/botconfig2.png) +![botconfig2](../../static/img/bot/botconfig2.png) Bot高级选项配置中,开发者可以改变bot的公私有状态,从而影响到bot的使用范围。需要注意的是,公开状态下的bot在已有其他仓库安装的情况下不能变成私有。开发者可选择将bot上架到市场,需要填写上架信息,包括市场简介,主要功能,次要功能等各项信息。 开发者还能进行bot的删除和转让操作,发起转让意味着更改bot的所有权,需要输入接受者的用户名。在接受者确定接受后,即可完成bot的所有权变更,拒绝则会取消本次的转让操作。 -![botconfig3](../../../static/img/bot/botconfig3.png) +![botconfig3](../../static/img/bot/botconfig3.png) diff --git a/versioned_docs/version-1.1.0/Bot市场/mybutton.js b/versioned_docs/version-1.1.0/Bot市场/mybutton.js new file mode 100644 index 0000000..e0ab101 --- /dev/null +++ b/versioned_docs/version-1.1.0/Bot市场/mybutton.js @@ -0,0 +1,13 @@ +import React from 'react'; +import styles from './mybutton.module.css'; // 假设你有一个CSS模块文件来定义样式 + +const MyButton = ({ onClick, children, className = '' }) => ( + +); + +export default MyButton; \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/Bot市场/mybutton.module.css b/versioned_docs/version-1.1.0/Bot市场/mybutton.module.css new file mode 100644 index 0000000..014950c --- /dev/null +++ b/versioned_docs/version-1.1.0/Bot市场/mybutton.module.css @@ -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; /* 鼠标悬停时改变背景色 */ +} \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/DevOps引擎/ci-config-validation.md b/versioned_docs/version-1.1.0/DevOps引擎/ci-config-validation.md new file mode 100644 index 0000000..b21903f --- /dev/null +++ b/versioned_docs/version-1.1.0/DevOps引擎/ci-config-validation.md @@ -0,0 +1,85 @@ +# CI/CD配置文件校验指南 + +## 配置文件格式 +GitLink使用`.gitlink-ci.yml`作为CI/CD配置文件,提交时会自动进行语法校验。 + +## 校验规则 +1. **基本语法检查** + - YAML格式必须正确 + - 缩进必须使用2个空格 + - 不允许使用tab字符 + +2. **必需字段验证** + ```yaml + version: 1.0 # 必填,指定配置文件版本 + stages: # 必填,定义流水线阶段 + jobs: # 必填,定义具体任务 + ``` + +3. **字段类型验证** + - `version`: 字符串 + - `stages`: 数组 + - `jobs`: 对象 + - `script`: 字符串数组 + +4. **环境变量格式** + - 变量名只能包含字母、数字和下划线 + - 变量名必须以字母开头 + +## 错误提示说明 +当配置文件存在问题时,系统会在以下位置显示错误信息: +1. 提交时的即时反馈 +2. CI/CD页面的构建日志 +3. 合并请求的状态检查 + +## 常见错误及解决方案 +1. **缩进错误** + ```yaml + # 错误示例 + jobs: + build: # 应该缩进2个空格 + script: + - echo "Hello" + ``` + +2. **未定义必需字段** + ```yaml + # 正确示例 + version: 1.0 + stages: + - build + jobs: + build: + script: + - echo "Hello" + ``` + +3. **环境变量格式错误** + ```yaml + # 错误示例 + variables: + 1_invalid: "value" # 变量名不能以数字开头 + ``` + +## 配置文件模板 +```yaml +version: 1.0 +stages: + - build + - test + - deploy + +variables: + MAVEN_OPTS: "-Dmaven.repo.local=.m2/repository" + +jobs: + build: + stage: build + script: + - mvn compile + + test: + stage: test + script: + - mvn test +``` \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/DevOps引擎/代码流水线.md b/versioned_docs/version-1.1.0/DevOps引擎/代码流水线.md index ee5f1d0..ad9f400 100644 --- a/versioned_docs/version-1.1.0/DevOps引擎/代码流水线.md +++ b/versioned_docs/version-1.1.0/DevOps引擎/代码流水线.md @@ -5,8 +5,14 @@ sidebar_position: 5 # 代码流水线 可以通过代码的形式(YAML格式)来配置流水线,首先选择代码流水线和对应的分支: - ![code_workflow1](../../../static/img/engine/code_workflow1.jpg) + ![code_workflow1](../../static/img/engine/code_workflow1.jpg) 编辑流水线代码,其流水线名称描述、触发器、全局参数、执行串行/并发和流水线编排等概念同图形流水线,具体描述如下: -![code_workflow2](../../../static/img/engine/code_workflow2.png) \ No newline at end of file +![code_workflow2](../../static/img/engine/code_workflow2.png) + +# YAML校验规则 +提交.gitlink-ci.yml时会自动校验以下内容: +- 必须包含version字段 +- 节点名称不能重复 +- 每个任务必须指定runner类型 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/DevOps引擎/参数配置.md b/versioned_docs/version-1.1.0/DevOps引擎/参数配置.md index 913d2ad..493ea0e 100644 --- a/versioned_docs/version-1.1.0/DevOps引擎/参数配置.md +++ b/versioned_docs/version-1.1.0/DevOps引擎/参数配置.md @@ -7,9 +7,9 @@ sidebar_position: 2 可在流水线中使用,实现动态参数配置;有字符串、数字、布尔三种类型。 - ![parameter1](../../../static/img/engine/parameter1.png) + ![parameter1](../../static/img/engine/parameter1.png) 在流水线的配置中通过如下方式获取参数: - ![parameter2](../../../static/img/engine/parameter2.png) \ No newline at end of file + ![parameter2](../../static/img/engine/parameter2.png) \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/DevOps引擎/图形流水线.md b/versioned_docs/version-1.1.0/DevOps引擎/图形流水线.md index 7edba3d..1c6cdbe 100644 --- a/versioned_docs/version-1.1.0/DevOps引擎/图形流水线.md +++ b/versioned_docs/version-1.1.0/DevOps引擎/图形流水线.md @@ -9,38 +9,38 @@ sidebar_position: 4 同一仓库下的流水线名称不能重复 -![vis_workflow1](../../../static/img/engine/vis_workflow1.png) +![vis_workflow1](../../static/img/engine/vis_workflow1.png) ## 触发器 注:流水线编排时,触发器要放在开始节点之前;目前一条流水线仅添加支持一个触发器 * 定时触发器cron:可通过填写cron表达式设置触发的具体时间 -![vis_workflow2](../../../static/img/engine/vis_workflow2.png) +![vis_workflow2](../../static/img/engine/vis_workflow2.png) * 事件触发器GitLink_Webhook:给出了常见的代码变更事件触发,包括推送代码、合并请求、创建标签 -![vis_workflow3](../../../static/img/engine/vis_workflow3.png) +![vis_workflow3](../../static/img/engine/vis_workflow3.png) ## 全局参数 添加后可在当前流水线中使用 -![vis_workflow4](../../../static/img/engine/vis_workflow4.png) +![vis_workflow4](../../static/img/engine/vis_workflow4.png) 使用实例 -![vis_workflow5](../../../static/img/engine/vis_workflow5.png) +![vis_workflow5](../../static/img/engine/vis_workflow5.png) ## 并发执行 -![vis_workflow6](../../../static/img/engine/vis_workflow6.png) +![vis_workflow6](../../static/img/engine/vis_workflow6.png) 开启后,同一流水线可同时并发执行n个流水线实例(每触发一次我们得到一个流水线实例); -![vis_workflow7](../../../static/img/engine/vis_workflow7.png) +![vis_workflow7](../../static/img/engine/vis_workflow7.png) 若未开启,则当前流水线实例执行中,后面的实例处于排队状态(最多可排队5个实例)。当前实例执行完成,下一个实例开始执行。 -![vis_workflow8](../../../static/img/engine/vis_workflow8.png) +![vis_workflow8](../../static/img/engine/vis_workflow8.png) ## 流水线编排 diff --git a/versioned_docs/version-1.1.0/DevOps引擎/密钥设置.md b/versioned_docs/version-1.1.0/DevOps引擎/密钥设置.md index 24b3367..b28b953 100644 --- a/versioned_docs/version-1.1.0/DevOps引擎/密钥设置.md +++ b/versioned_docs/version-1.1.0/DevOps引擎/密钥设置.md @@ -7,10 +7,10 @@ sidebar_position: 3 将账号密码、密钥、证书等存放到密钥管理里,配置后可直接在流水线中使用,避免因直接填写引起的泄露风险。 -![secret1](../../../static/img/engine/secret1.png) +![secret1](../../static/img/engine/secret1.png) 使用示例 注:节点输入参数中,下拉选项为密钥类型,需要提前配置好密钥在流水线中选择使用 -![secret2](../../../static/img/engine/secret2.png) \ No newline at end of file +![secret2](../../static/img/engine/secret2.png) \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/DevOps引擎/引擎简介.md b/versioned_docs/version-1.1.0/DevOps引擎/引擎简介.md index 61ea381..2ebc078 100644 --- a/versioned_docs/version-1.1.0/DevOps引擎/引擎简介.md +++ b/versioned_docs/version-1.1.0/DevOps引擎/引擎简介.md @@ -8,6 +8,12 @@ sidebar_position: 1 引擎(Engine)是GitLink提供的一款DevOps工具,通过简单的节点编排来构建开发、测试、部署流水线,从而创建自动化的软件交付流程。 它可以实现持续的代码集成,让开发者能尽早发现质量问题,快速定位修复,提升软件开发效率和质量;自动化的代码扫描、编译打包、单元测试,把研发团队从重复的工作中解放出来,聚焦到更有价值的事情上。 -![engine_intro](../../../static/img/engine/engine_intro.jpg) +![engine_intro](../../static/img/engine/engine_intro.jpg) -在引擎页面中,用户可以创建和编辑图形流水线或代码流水线、设置外部参数、管理密钥等操作。 \ No newline at end of file +在引擎页面中,用户可以创建和编辑图形流水线或代码流水线、设置外部参数、管理密钥等操作。 + +# 配置文件校验 +提交.gitlink-ci.yml文件时会自动进行语法校验,系统会提示以下常见错误: +- 无效的stage名称 +- 缺少必填字段 +- 语法格式错误 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/DevOps引擎/执行记录查询.md b/versioned_docs/version-1.1.0/DevOps引擎/执行记录查询.md index 0642a6c..30ca593 100644 --- a/versioned_docs/version-1.1.0/DevOps引擎/执行记录查询.md +++ b/versioned_docs/version-1.1.0/DevOps引擎/执行记录查询.md @@ -7,4 +7,4 @@ sidebar_position: 6 用户可以查看流水线的运行状态 - ![result](../../../static/img/engine/result.png) \ No newline at end of file + ![result](../../static/img/engine/result.png) \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/intro.md b/versioned_docs/version-1.1.0/intro.md index ffb913f..f8aec7a 100644 --- a/versioned_docs/version-1.1.0/intro.md +++ b/versioned_docs/version-1.1.0/intro.md @@ -69,6 +69,25 @@ GitLink(确实开源)是CCF官方指定的开源创新服务平台,旨在

第三方服务

第三方服务使用及设置[3个文档]

+
+ +

通知

+

通知简介及设置[2个文档]

+
+
+ +

个人主页建站

+

个人主页建站使用及设置[2个文档]

+
+
+ +

平台公告

+
+
+ +

服务协议

+

GitLink服务协议[1个文档]

+
\ No newline at end of file diff --git a/versioned_docs/version-1.1.0/intro/version-differences.md b/versioned_docs/version-1.1.0/intro/version-differences.md new file mode 100644 index 0000000..027f1c4 --- /dev/null +++ b/versioned_docs/version-1.1.0/intro/version-differences.md @@ -0,0 +1,79 @@ +# GitLink版本功能对比 + +## 版本类型 + +### 社区版 +- 完全免费 +- 开源项目托管 +- 基础代码托管功能 +- 基础CI/CD功能 +- 公共仓库无限制 + +### 企业版 +- 收费服务 +- 私有部署 +- 高级功能支持 +- 专属技术支持 +- 自定义域名 + +## 功能对比表 + +| 功能 | 社区版 | 企业版 | +|------|--------|--------| +| 代码托管 | ✓ | ✓ | +| Issue管理 | ✓ | ✓ | +| Pull Request | ✓ | ✓ | +| WebHook | ✓ | ✓ | +| 基础CI/CD | ✓ | ✓ | +| Wiki | ✓ | ✓ | +| 公共仓库 | 无限制 | 无限制 | +| 私有仓库 | 限制数量 | 无限制 | +| 存储空间 | 1.2GB/仓库 | 可定制 | +| 团队成员 | 限制人数 | 无限制 | +| 审计日志 | ✗ | ✓ | +| LDAP集成 | ✗ | ✓ | +| SSO登录 | ✗ | ✓ | +| 高级CI/CD | ✗ | ✓ | +| 定制化服务 | ✗ | ✓ | +| 专属支持 | ✗ | ✓ | + +## 企业版专属功能 + +### 安全与合规 +- 审计日志 +- 合规检查 +- 安全扫描 +- 漏洞分析 + +### 身份认证 +- LDAP/AD集成 +- SSO登录 +- 双因素认证 +- 访问控制 + +### 高级DevOps +- 自定义CI/CD +- 容器镜像仓库 +- 制品库 +- 环境管理 + +### 团队协作 +- 项目组合管理 +- 高级权限控制 +- 工作流自动化 +- 团队数据分析 + +## 升级建议 +1. 适合升级企业版的场景: + - 需要私有部署 + - 要求更高安全性 + - 需要专业技术支持 + - 团队规模较大 + - 需要高级功能 + +2. 适合使用社区版的场景: + - 个人开发者 + - 小型团队 + - 开源项目 + - 基础代码托管需求 + - 预算有限 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/个人主页建站/建站工具.md b/versioned_docs/version-1.1.0/个人主页建站/建站工具.md index fda1d79..80604fb 100644 --- a/versioned_docs/version-1.1.0/个人主页建站/建站工具.md +++ b/versioned_docs/version-1.1.0/个人主页建站/建站工具.md @@ -13,14 +13,14 @@ sidebar_position: 2 将值改成 个人建站服务中显示的网站地址, 例如: 现在有一个网站地址为 http://KingChan.gitlink.net 那么 config.toml 中的 baseURL 应该为 http://KingChan.gitlink.net - ![img](../../../static/img/个人主页建站/建站工具1.png) + ![img](../../static/img/个人主页建站/建站工具1.png) 修改完毕后点击提交 - ![img](../../../static/img/个人主页建站/建站工具2.png) + ![img](../../static/img/个人主页建站/建站工具2.png) 提交完成后,开始部署 - ![img](../../../static/img/建站工具3.png) + ![img](../../static/img/建站工具3.png) 静态页面预览 - ![img](../../../static/img/建站工具4.png) + ![img](../../static/img/建站工具4.png) ### jekyll工具 @@ -32,14 +32,14 @@ sidebar_position: 2 baseurl: "/" url: "http://KingChan.gitlink.net" - ![img](../../../static/img/建站工具5.png) + ![img](../../static/img/建站工具5.png) 修改完成后点击 提交变更 - ![img](../../../static/img/个人主页建站/建站工具2.png) + ![img](../../static/img/个人主页建站/建站工具2.png) 提交完成后,前往建站服务开始部署 - ![img](../../../static/img/建站工具7.png) + ![img](../../static/img/建站工具7.png) - ![img](../../../static/img/建站工具8.png) + ![img](../../static/img/建站工具8.png) ### hexo工具 @@ -50,17 +50,17 @@ url: "http://KingChan.gitlink.net" 那么 _config.toml 中的 url应该为 http://KingChan.gitlink.net - ![img](../../../static/img/建站工具9.png) + ![img](../../static/img/建站工具9.png) 修改完毕后提交变更 - ![img](../../../static/img/个人主页建站/建站工具2.png) + ![img](../../static/img/个人主页建站/建站工具2.png) 提交完成后,前往建站服务开始部署 - ![img](../../../static/img/建站工具11.png) + ![img](../../static/img/建站工具11.png) - ![img](../../../static/img/建站工具12.png) + ![img](../../static/img/建站工具12.png) - ![img](../../../static/img/建站工具13.png) + ![img](../../static/img/建站工具13.png) ### file 工具 文档格式工具,使用该工具会部署所选中分支下的所有文件。 diff --git a/versioned_docs/version-1.1.0/个人主页建站/站点创建流程.md b/versioned_docs/version-1.1.0/个人主页建站/站点创建流程.md index 8ec2981..7a73db6 100644 --- a/versioned_docs/version-1.1.0/个人主页建站/站点创建流程.md +++ b/versioned_docs/version-1.1.0/个人主页建站/站点创建流程.md @@ -6,11 +6,11 @@ sidebar_position: 1 ### 我的站点 鼠标移动至右上角头像位置,点击设置进入我的设置界面 -![img](../../../static/img/建站工具/1.png) +![img](../../static/img/建站工具/1.png) 点击左测面板中 个人建站 - 我的站点 -![img](../../../static/img/建站工具/3.png) +![img](../../static/img/建站工具/3.png) ### 创建站点 @@ -20,11 +20,11 @@ sidebar_position: 1 并且选择对应的建站工具与主题,我们为您提供了3种不同的工具,每个工具10种主题,一共30种供您挑选 -![img](../../../static/img/建站工具/4.png) +![img](../../static/img/建站工具/4.png) 填写完毕后,点击页面下方蓝色按钮: 创建站点 -![img](../../../static/img/建站工具/5.png) +![img](../../static/img/建站工具/5.png) 这样您就拥有了一个网站,并且有了一个代码仓库。 @@ -32,19 +32,19 @@ sidebar_position: 1 ### 部署站点 -![img](../../../static/img/建站工具/6.png) +![img](../../static/img/建站工具/6.png) 点击去部署按钮,选择想要部署的分支后点击确定 -![img](../../../static/img/建站工具/7.png) +![img](../../static/img/建站工具/7.png) 等待程序运行一会儿后,会返回一些服务器部署信息给您 部署成功后您就可以访问站点了。点击网站地址就可以跳转 -![img](../../../static/img/建站工具/8.png) +![img](../../static/img/建站工具/8.png) ### 部署完成 -![img](../../../static/img/建站工具/9.png) +![img](../../static/img/建站工具/9.png) diff --git a/versioned_docs/version-1.1.0/代码库管理/WebIDE.md b/versioned_docs/version-1.1.0/代码库管理/WebIDE.md index 6a72f8f..6bd8608 100644 --- a/versioned_docs/version-1.1.0/代码库管理/WebIDE.md +++ b/versioned_docs/version-1.1.0/代码库管理/WebIDE.md @@ -10,32 +10,32 @@ sidebar_position: 9 ### **2. WebIDE 入口** 从 Gitlink 仓库首页 ,点击Web IDE 按键即可进入 -![](../../../static/img/代码库管理/WebIDE/WebIDE入口.png)
+![](../../static/img/代码库管理/WebIDE/WebIDE入口.png)
### **3. 分支** 支持分支切换:点击左下角分支名即可切换分支。 -![](../../../static/img/代码库管理/WebIDE/WebIDE切换分支.png)
+![](../../static/img/代码库管理/WebIDE/WebIDE切换分支.png)
### **4. 搜索** 当前支持 Gitlink 仓库内代码搜索(支持单词匹配和文件过滤)和文件搜索。 -![](../../../static/img/代码库管理/WebIDE/WebIDE搜索.png)
+![](../../static/img/代码库管理/WebIDE/WebIDE搜索.png)
### **5. 行高亮** 支持单行或多行高亮,点击行号即可高亮行,按住 Shift 可选中连续多行。 -![](../../../static/img/代码库管理/WebIDE/WebIDE行高亮.png)
+![](../../static/img/代码库管理/WebIDE/WebIDE行高亮.png)
### **6. Blame** 支持查看单行 blame 信息,hover 后可展示详细信息。 -![](../../../static/img/代码库管理/WebIDE/WebIDEblame.png)
+![](../../static/img/代码库管理/WebIDE/WebIDEblame.png)
### **7. Graph** 支持 graph 视图,可查看分支 commits 历史以及每个 commit 详细文件变更,并支持文件 diff 查看。底部状态栏左下角点击 Git Graph 或在命令面板输入 View Git Graph,即可打开 Git Graph 视图。 -![](../../../static/img/代码库管理/WebIDE/WebIDEGraph.png)
+![](../../static/img/代码库管理/WebIDE/WebIDEGraph.png)
### **8. WebSCM** 可以在极速版新建分支,修改代码后在 SCM 面板看到变更文件列表,写完 commit message 后提交到 Gitlink 上。如果想快速修改一些文件可以不用在本地修改,直接通过极速版修改代码一次性提交。 -### **9. 代码在线运行** -● 集成了基于 skypack 的更加轻量的 CodeSwing 插件,可以在极速版去运行前端代码。 -● 集成了基于 Pyodide 的 Code-Runner-For-Web 插件,可以将 Python 的运行搬到浏览器上。 -![](../../../static/img/代码库管理/WebIDE/WebIDE代码在线运行.png)
\ No newline at end of file +### **9. 快速访问方式** +在仓库文件列表页面,点击任意文件右侧的"编辑"按钮即可直接进入WebIDE界面。 + +![](../../static/img/代码库管理/WebIDE/快速访问入口.png) \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/Webhook.md b/versioned_docs/version-1.1.0/代码库管理/Webhook.md index 064ffc9..33bc170 100644 --- a/versioned_docs/version-1.1.0/代码库管理/Webhook.md +++ b/versioned_docs/version-1.1.0/代码库管理/Webhook.md @@ -4,23 +4,23 @@ sidebar_position: 8 --- ### **1. Webhook模块入口** 在项目主页,点击“仓库设置”按键,再点击“网络钩子”按键,即可进入仓库的Webhook模块。 - ![](../../../static/img/代码库管理/Webhook/Webhook入口.png)
+ ![](../../static/img/代码库管理/Webhook/Webhook入口.png)
### **2. 添加Webhook** 单击“添加Webhook”按键,可进入配置Webhook页面: - ![](../../../static/img/代码库管理/Webhook/添加Webhook.png)
- ![](../../../static/img/代码库管理/Webhook/Webhook配置.png)
+ ![](../../static/img/代码库管理/Webhook/添加Webhook.png)
+ ![](../../static/img/代码库管理/Webhook/Webhook配置.png)
### **3. 编辑Webhook** 添加Webhook后,如下图所示,可以通过点击右侧”编辑“按键来对每个Webhook进行编辑操作。 - ![](../../../static/img/代码库管理/Webhook/编辑Webhook.png)
+ ![](../../static/img/代码库管理/Webhook/编辑Webhook.png)
### **4. 删除Webhook** 添加Webhook后,如下图所示,可以通过点击右侧”删除“按键来对每个Webhook进行删除操作。 - ![](../../../static/img/代码库管理/Webhook/删除webhook.png)
+ ![](../../static/img/代码库管理/Webhook/删除webhook.png)
### **5. Webhook支持的事件类型** 在GitLink中,Webhook支持的事件类型如下: diff --git a/versioned_docs/version-1.1.0/代码库管理/repository-settings.md b/versioned_docs/version-1.1.0/代码库管理/repository-settings.md new file mode 100644 index 0000000..f2f0f36 --- /dev/null +++ b/versioned_docs/version-1.1.0/代码库管理/repository-settings.md @@ -0,0 +1,58 @@ +# 仓库设置指南 + +## 强制推送(Force Push)设置 +要启用强制推送功能,需要同时满足以下条件: + +1. **用户权限要求** + - 必须是仓库管理员 + - 或具有特定分支的写入权限 + +2. **仓库设置要求** + - 进入仓库设置页面 + - 找到"分支保护"设置 + - 开启`allow_force_push`选项 + +### 配置步骤 +1. 进入仓库设置 +2. 选择"分支管理" +3. 找到目标分支 +4. 开启"允许强制推送"选项 +5. 保存设置 + +### 注意事项 +- 强制推送可能会覆盖其他人的提交 +- 建议在个人分支上使用 +- 不推荐在主分支上启用 +- 操作前先备份代码 + +## 仓库基本设置 + +### 仓库信息 +- 仓库名称 +- 仓库描述 +- 可见性设置 +- 默认分支 + +### 访问控制 +- 协作者管理 +- 团队权限 +- 分支保护规则 +- SSH密钥管理 + +### 功能开关 +- Issues功能 +- Wiki功能 +- Projects功能 +- Pages服务 + +## 存储限制 +- 免费账户:1.2GB +- 单文件上限:100MB +- LFS支持:可选开启 + +## 高级功能 +- 仓库迁移 +- 仓库归档 +- 仓库模板 +- WebHook配置 +- 部署密钥 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/template-repositories.md b/versioned_docs/version-1.1.0/代码库管理/template-repositories.md new file mode 100644 index 0000000..3475851 --- /dev/null +++ b/versioned_docs/version-1.1.0/代码库管理/template-repositories.md @@ -0,0 +1,70 @@ +# 仓库模板使用指南 + +## 访问模板仓库 +有两种方式可以访问模板仓库: + +1. **通过URL参数** + - 在仓库URL后添加`?template=true` + - 例如:`https://gitlink.org/org/repo?template=true` + +2. **通过界面入口** + - 点击"新建仓库"按钮 + - 选择"从模板创建"选项 + +## 创建模板仓库 + +### 将仓库设置为模板 +1. 进入仓库设置 +2. 找到"仓库类型"选项 +3. 勾选"将此仓库设置为模板" +4. 保存设置 + +### 模板仓库特性 +- 不能被直接推送代码 +- 可以被任何人用作模板 +- 保持干净的提交历史 +- 支持自定义初始化配置 + +## 使用模板创建仓库 + +### 基本步骤 +1. 访问模板仓库 +2. 点击"使用此模板"按钮 +3. 填写新仓库信息 +4. 选择要包含的分支 +5. 确认创建 + +### 自定义选项 +- 选择性复制分支 +- 包含所有标签 +- 复制Issue模板 +- 保留提交历史 + +## 最佳实践 + +### 模板仓库结构 +``` +template-repo/ +├── .gitlink/ +│ ├── ISSUE_TEMPLATE/ +│ └── PR_TEMPLATE/ +├── docs/ +│ └── README.md +├── src/ +├── tests/ +├── .gitignore +└── README.md +``` + +### 推荐配置 +1. 添加详细的README +2. 包含必要的配置文件 +3. 提供示例代码 +4. 设置Issue和PR模板 +5. 配置CI/CD模板 + +## 注意事项 +1. 模板仓库应保持最小化 +2. 定期更新模板内容 +3. 提供清晰的使用文档 +4. 避免包含敏感信息 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/仓库创建.md b/versioned_docs/version-1.1.0/代码库管理/仓库创建.md index e358db7..e17cd76 100644 --- a/versioned_docs/version-1.1.0/代码库管理/仓库创建.md +++ b/versioned_docs/version-1.1.0/代码库管理/仓库创建.md @@ -4,8 +4,8 @@ sidebar_position: 1 --- ### **1. 仓库创建入口** 用户可以通过平台主页右上角的按键以及个人主页参与项目模块的“新建”按键来创建仓库。 -![](../../../static/img/代码库管理/仓库创建/仓库创建.png)
+![](../../static/img/代码库管理/仓库创建/仓库创建.png)
### **2. 填写项目基本信息** 进入新建项目页面后,如下图所示,填写拥有者、项目名称、项目标识等信息,单击”创建项目“按键即可完成创建。 -![](../../../static/img/代码库管理/仓库创建/新建项目.png)
\ No newline at end of file +![](../../static/img/代码库管理/仓库创建/新建项目.png)
\ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/仓库设置.md b/versioned_docs/version-1.1.0/代码库管理/仓库设置.md index e423b7c..6e31214 100644 --- a/versioned_docs/version-1.1.0/代码库管理/仓库设置.md +++ b/versioned_docs/version-1.1.0/代码库管理/仓库设置.md @@ -4,8 +4,8 @@ sidebar_position: 2 --- ### **1. 仓库设置入口** 在仓库主页,点击“仓库设置”按键即可进入仓库设置模块。仓库设置中可以修改项目的基本信息、进行成员管理、配置webhook、设置分支以及安装bot。 -![](../../../static/img/代码库管理/仓库设置/仓库设置.png)
+![](../../static/img/代码库管理/仓库设置/仓库设置.png)
### **2. 基本设置** 进入仓库设置模块后,单击”基本设置“按键,进入基本设置模块,如下图所示,可以对项目的项目名称、项目标识、项目简介、项目类别、项目语言等基本信息进行修改。单击“转移”按键可以将仓库转移给其他用户和组织,单击“删除本仓库“按键可以删除本仓库。 -![](../../../static/img/代码库管理/仓库设置/基本设置.png)
\ No newline at end of file +![](../../static/img/代码库管理/仓库设置/基本设置.png)
\ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/代码提交.md b/versioned_docs/version-1.1.0/代码库管理/代码提交.md index 11b6835..441021c 100644 --- a/versioned_docs/version-1.1.0/代码库管理/代码提交.md +++ b/versioned_docs/version-1.1.0/代码库管理/代码提交.md @@ -1,4 +1,11 @@ --- sidebar_label: '代码提交' sidebar_position: 3 ---- \ No newline at end of file +--- + ### **1. 代码提交入口** +用户可以通过项目代码库中间的文件下的“上传文件”按键来上传文件。 +![](../../static/img/代码库管理/代码提交/上传文件入口.png)
+ + ### **2. 上传文件** +进入上传文件页面后,如下图所示,拖动文件,选择提交变更的分支的单击”创建项目“按键即可完成创建。 +![](../../static/img/代码库管理/代码提交/上传文件.png)
\ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/分支管理.md b/versioned_docs/version-1.1.0/代码库管理/分支管理.md index f543748..ff803a5 100644 --- a/versioned_docs/version-1.1.0/代码库管理/分支管理.md +++ b/versioned_docs/version-1.1.0/代码库管理/分支管理.md @@ -1,4 +1,13 @@ --- sidebar_label: '分支管理' sidebar_position: 5 ---- \ No newline at end of file +--- + ### **1. 查看分支** +在代码库栏下,如下图所示,用户可以点击代码库分支从而查看当前项目的所有分支,并且选择对其进行操作。 +![](../../static/img/代码库管理/分支管理/分支管理方式1.jpg)
+ + ### **2. 合并分支** +在“和并请求(PR)”下点击“新建合并请求”后, +![](../../static/img/代码库管理/分支管理/分支管理方式3.png)
+如下图所示,用户可以选择源分支与目标分支以及填写分支信息后提交分支合并请求。 +![](../../static/img/代码库管理/分支管理/分支管理方式2.png)
\ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/成员管理.md b/versioned_docs/version-1.1.0/代码库管理/成员管理.md index 2edb5ef..cbf6199 100644 --- a/versioned_docs/version-1.1.0/代码库管理/成员管理.md +++ b/versioned_docs/version-1.1.0/代码库管理/成员管理.md @@ -4,20 +4,20 @@ sidebar_position: 7 --- ### **1. 成员管理入口** 在仓库主页,点击“仓库设置”按键,再点击”成员管理“按键,即可进入成员管理模块,如下图所示。 -![](../../../static/img/代码库管理/成员管理/成员管理入口.png)
+![](../../static/img/代码库管理/成员管理/成员管理入口.png)
### **2. 筛选、搜索项目成员** 进入成员管理模块后,可以通过”角色筛选“按键来筛选项目成员类型,通过”搜索“按键可以检索具体的项目成员,如下图所示。 -![](../../../static/img/代码库管理/成员管理/筛选、搜索项目成员.png)
+![](../../static/img/代码库管理/成员管理/筛选、搜索项目成员.png)
### **3. 筛选、搜索项目成员** 进入成员管理模块后,可以通过”添加成员“按键来添加项目成员,左侧搜索框检索到具体用户并选中后,单击”添加成员“按键即可成功添加项目成员。 -![](../../../static/img/代码库管理/成员管理/添加成员.png)
+![](../../static/img/代码库管理/成员管理/添加成员.png)
### **4. 项目成员权限管理** 进入成员管理模块后,单击项目成员右侧的角色栏,可以选择赋予该名项目成员的权限等级,如下图所示。 -![](../../../static/img/代码库管理/成员管理/项目成员权限管理.png)
+![](../../static/img/代码库管理/成员管理/项目成员权限管理.png)
### **5. 删除项目成员** 进入成员管理模块后,单击项目成员右侧的”删除“按键,可以删除改名项目成员,如下图所示。 -![](../../../static/img/代码库管理/成员管理/删除项目成员.png)
+![](../../static/img/代码库管理/成员管理/删除项目成员.png)
diff --git a/versioned_docs/version-1.1.0/代码库管理/文件管理.md b/versioned_docs/version-1.1.0/代码库管理/文件管理.md index af8c755..075a07d 100644 --- a/versioned_docs/version-1.1.0/代码库管理/文件管理.md +++ b/versioned_docs/version-1.1.0/代码库管理/文件管理.md @@ -1,4 +1,23 @@ --- sidebar_label: '文件管理' sidebar_position: 4 ---- \ No newline at end of file +--- +### **1. 文件管理位置** +在代码库界面,可直接对代码库中该分支下的文件进行操作,如下图所示。 +![](../../static/img/代码库管理/文件管理/文件管理入口.png)
+ +### **2. 进入目录** +点击进入相关目录,找到要编辑的文件,如下图所示。 +![](../../static/img/代码库管理/文件管理/进入文件所在目录.png)
+ +### **3. 进入文件编辑页面** +在线编辑文件,单击文件,即可进入编辑文件页面,如下图所示。 +![](../../static/img/代码库管理/文件管理/进入文件编辑界面.png)
+ +### **4. 编辑文件** +编辑界面右侧有三个按钮,分别是“下载”、“编辑”和“删除”,点击下载即可将文件下载到本地,编辑则可在线编辑文档,删除则将文件从代码库中删除,按钮位置如下图所示。 +![](../../static/img/代码库管理/文件管理/文件编辑按钮.png)
+ +### **5. WebIDE在线编辑** +点击文件右侧的"编辑"按钮可直接进入WebIDE界面: +![](../../static/img/代码库管理/webide_entry.png) \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/代码库管理/标签和发行版管理.md b/versioned_docs/version-1.1.0/代码库管理/标签和发行版管理.md index f1f30eb..44e0ae7 100644 --- a/versioned_docs/version-1.1.0/代码库管理/标签和发行版管理.md +++ b/versioned_docs/version-1.1.0/代码库管理/标签和发行版管理.md @@ -4,26 +4,26 @@ sidebar_position: 6 --- ### **1. 标签和发行版管理入口** 在仓库主页,点击“代码库”按键,再点击”标签“按键,即可进入标签和发行版管理模块,如下图所示。 -![](../../../static/img/代码库管理/标签和发行版管理/标签和发行版管理入口.png)
+![](../../static/img/代码库管理/标签和发行版管理/标签和发行版管理入口.png)
### **2. 删除标签** 进入标签和发行版管理模块后,点击标签右侧“删除”按键,即可实现对标签的删除操作,如下图所示。 -![](../../../static/img/代码库管理/标签和发行版管理/删除标签.png)
+![](../../static/img/代码库管理/标签和发行版管理/删除标签.png)
### **3. 查看发行版** 进入标签和发行版管理模块后,点击”发行版”按键即可查看项目的发行版,如下图所示。 -![](../../../static/img/代码库管理/标签和发行版管理/查看发行版.png)
+![](../../static/img/代码库管理/标签和发行版管理/查看发行版.png)
### **4. 创建发行版** 进入标签和发行版管理模块后,点击标签右侧”创建发行版”按键,即可快速创建绑定该标签的发行版,如下图所示。 -![](../../../static/img/代码库管理/标签和发行版管理/发布新版本.png)
+![](../../static/img/代码库管理/标签和发行版管理/发布新版本.png)
### **5. 修改发行版** 进入标签和发行版管理模块后,点击发行版右侧的修改按键,即可进入发行版的修改页面,如下图所示。完成发行版的修改后,单击”保存发行版“按键即可保存修改内容。 -![](../../../static/img/代码库管理/标签和发行版管理/修改发行版.png)
-![](../../../static/img/代码库管理/标签和发行版管理/发行版修改页面.png)
+![](../../static/img/代码库管理/标签和发行版管理/修改发行版.png)
+![](../../static/img/代码库管理/标签和发行版管理/发行版修改页面.png)
### **6. 删除发行版** 进入标签和发行版管理模块后,点击发行版右侧的删除按键,即可进入发行版的删除页面,如下图所示。 -![](../../../static/img/代码库管理/标签和发行版管理/删除发行版.png)
+![](../../static/img/代码库管理/标签和发行版管理/删除发行版.png)
\ No newline at end of file diff --git a/versioned_docs/version-1.1.0/合并请求/merge-request-guide.md b/versioned_docs/version-1.1.0/合并请求/merge-request-guide.md new file mode 100644 index 0000000..576f9f5 --- /dev/null +++ b/versioned_docs/version-1.1.0/合并请求/merge-request-guide.md @@ -0,0 +1,64 @@ +# 合并请求使用指南 + +## 创建合并请求 + +### 基本步骤 +1. 进入源分支 +2. 点击"新建合并请求" +3. 选择目标分支 +4. 填写标题和描述 +5. 提交合并请求 + +## 审查合并请求 + +### 代码审查 +1. 查看变更文件 +2. 添加行内评论 +3. 提交整体评审意见 +4. 设置审查状态 + +### 合并操作 +1. 确保所有检查通过 +2. 滚动到评论框下方 +3. 找到"合并"按钮(位于评论区下方) +4. 选择合并方式 + - 普通合并 + - 压缩合并 + - 变基合并 + +## 合并选项说明 + +### 普通合并 +- 保留完整提交历史 +- 创建合并提交 +- 适合功能分支合并 + +### 压缩合并 +- 将所有提交压缩为一个 +- 保持主分支历史整洁 +- 适合bug修复合并 + +### 变基合并 +- 重放所有提交 +- 形成线性历史 +- 适合长期维护分支 + +## 最佳实践 + +### 提交合并请求前 +1. 确保本地测试通过 +2. 更新分支到最新 +3. 解决冲突 +4. 编写清晰的描述 + +### 审查要点 +1. 代码质量 +2. 测试覆盖 +3. 文档更新 +4. 性能影响 + +### 合并后操作 +1. 删除源分支 +2. 更新相关Issue状态 +3. 部署新版本(如需要) +4. 通知相关人员 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/合并请求/代码评审.md b/versioned_docs/version-1.1.0/合并请求/代码评审.md index 9b4aefb..6f99645 100644 --- a/versioned_docs/version-1.1.0/合并请求/代码评审.md +++ b/versioned_docs/version-1.1.0/合并请求/代码评审.md @@ -3,4 +3,11 @@ sidebar_label: '代码评审' sidebar_position: 3 --- -# 代码评审 \ No newline at end of file +# 代码评审 + ### **1. 进入代码评审** +如下图所示,点击“代码评审”按钮可以进入代码评审 +![](../../static/img/PR/进入代码评审.png)
+ + ### **2. 代码评审界面** +如下图所示,用户可以在该界面下查看该PR操作要合并的新的代码,并对其进行评审。 +![](../../static/img/PR/具体代码评审.png)
diff --git a/versioned_docs/version-1.1.0/快速开始/account-management.md b/versioned_docs/version-1.1.0/快速开始/account-management.md new file mode 100644 index 0000000..28e383c --- /dev/null +++ b/versioned_docs/version-1.1.0/快速开始/account-management.md @@ -0,0 +1,38 @@ +# 账户管理指南 + +## 登录方式 +GitLink提供多种便捷的登录方式: + +### 1. 账号密码登录 +- 使用注册邮箱/用户名 + 密码登录 +- 支持记住登录状态 + +### 2. 移动端扫码登录 +1. 在网页端登录界面点击"扫码登录" +2. 打开GitLink移动端APP +3. 点击APP右上角的扫码图标 +4. 扫描网页上显示的二维码 +5. 在手机上确认登录 + +### 3. 第三方账号登录 +- GitHub账号登录 +- GitLab账号登录 +- 微信登录 + +## 账户安全 +1. **二次验证** + - 支持Google Authenticator + - 支持手机验证码 + +2. **登录历史** + - 查看最近的登录记录 + - 显示登录IP和设备信息 + +3. **访问令牌** + - 创建个人访问令牌 + - 管理令牌权限和有效期 + +## 账户限制 +- 免费账户仓库存储限制:1.2GB +- 单个文件大小限制:100MB +- API调用频率限制:每小时1000次 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/快速开始/keyboard-shortcuts.md b/versioned_docs/version-1.1.0/快速开始/keyboard-shortcuts.md new file mode 100644 index 0000000..75314e4 --- /dev/null +++ b/versioned_docs/version-1.1.0/快速开始/keyboard-shortcuts.md @@ -0,0 +1,41 @@ +# 快捷键指南 + +## 全局快捷键 +- `shift + ?`: 显示快捷键帮助面板 +- `t`: 打开文件快速搜索 +- `s`: 聚焦搜索框 +- `g + c`: 跳转到代码页面 +- `g + i`: 跳转到Issues页面 +- `g + p`: 跳转到Pull Requests页面 + +## 代码浏览 +- `/`: 在当前仓库中搜索 +- `l`: 跳转到指定行 +- `b`: 查看文件历史 +- `y`: 复制永久链接 +- `i`: 显示/隐藏差异 + +## 代码编辑 +- `ctrl + s`: 保存更改 +- `ctrl + f`: 查找 +- `ctrl + g`: 跳转到行 +- `ctrl + /`: 注释/取消注释 +- `ctrl + space`: 触发代码补全 + +## Issue和PR +- `ctrl + enter`: 提交评论 +- `r`: 回复 +- `n`: 创建新Issue +- `m`: 设置里程碑 +- `l`: 添加标签 + +## 导航 +- `h`: 返回首页 +- `g + n`: 查看通知 +- `g + d`: 跳转到仪表盘 +- `g + s`: 跳转到设置 + +## 提示 +1. 在任何页面按下`shift + ?`可以查看当前页面支持的所有快捷键 +2. 部分快捷键在特定页面才能使用 +3. 快捷键可能会随平台更新而变化,请以帮助面板显示为准 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/快速开始/webide.md b/versioned_docs/version-1.1.0/快速开始/webide.md new file mode 100644 index 0000000..b21ad66 --- /dev/null +++ b/versioned_docs/version-1.1.0/快速开始/webide.md @@ -0,0 +1,29 @@ +# WebIDE使用指南 + +## 概述 +GitLink提供了强大的在线WebIDE功能,让您无需在本地安装开发环境即可直接在浏览器中编辑和运行代码。 + +## 如何访问WebIDE +1. 进入任意代码仓库 +2. 在文件列表界面,点击文件右侧的"编辑"按钮 +3. 系统将自动打开Cloud IDE界面 + +## 主要功能 +- 在线编辑代码 +- 实时语法高亮 +- 代码自动补全 +- 集成终端 +- 实时预览 +- 一键提交变更 + +## 快捷键支持 +WebIDE支持多种快捷键操作以提升开发效率: +- `Ctrl + S`: 保存文件 +- `Ctrl + F`: 在当前文件中搜索 +- `Ctrl + Shift + F`: 在项目中搜索 +- `F5`: 运行/调试 + +## 注意事项 +1. 首次打开WebIDE可能需要等待几秒钟进行环境初始化 +2. 建议使用Chrome或Firefox等现代浏览器以获得最佳体验 +3. 编辑完成后请及时提交更改 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/疑修/issue-management.md b/versioned_docs/version-1.1.0/疑修/issue-management.md new file mode 100644 index 0000000..ba87fe7 --- /dev/null +++ b/versioned_docs/version-1.1.0/疑修/issue-management.md @@ -0,0 +1,55 @@ +# Issue 管理指南 + +## Issue自动关闭 +GitLink支持通过提交信息自动关闭Issue。在提交信息中使用特定关键字,可以自动关闭相关Issue。 + +### 支持的关键字 +- `fix #123` +- `fixes #123` +- `fixed #123` +- `close #123` +- `closes #123` +- `closed #123` +- `resolve #123` +- `resolves #123` +- `resolved #123` + +### 使用示例 +``` +git commit -m "fix #123: 修复了登录按钮无响应的问题" +``` + +### 多Issue关闭 +可以在一条提交信息中关闭多个Issue: +``` +git commit -m "fix #123, closes #456: 重构登录模块" +``` + +### 跨仓库关闭 +可以通过指定完整路径关闭其他仓库的Issue: +``` +git commit -m "fix organization/repo#123: 修复依赖问题" +``` + +## 手动关闭Issue +1. 打开需要关闭的Issue +2. 点击右侧状态下拉菜单 +3. 选择"关闭Issue" +4. 可选:添加关闭原因说明 + +## Issue标签管理 +- 使用合适的标签分类Issue +- 可自定义标签颜色和描述 +- 支持批量编辑标签 + +## Issue模板 +1. 在仓库`.gitlink`目录下创建`ISSUE_TEMPLATE`文件夹 +2. 添加模板文件(支持markdown格式) +3. 新建Issue时可选择使用模板 + +## 最佳实践 +1. 使用清晰的标题描述问题 +2. 提供完整的复现步骤 +3. 附上相关的错误日志或截图 +4. 及时更新Issue状态 +5. 使用自动关闭语法关联提交和Issue \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/第三方服务/WebIDE.md b/versioned_docs/version-1.1.0/第三方服务/WebIDE.md index 3d152e9..ac974e1 100644 --- a/versioned_docs/version-1.1.0/第三方服务/WebIDE.md +++ b/versioned_docs/version-1.1.0/第三方服务/WebIDE.md @@ -9,20 +9,20 @@ 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 框架的高扩展性,业务可以更加深度的定制模块与插件,让业务有多的想象空间。 @@ -72,7 +72,7 @@ Gitlink 代码阅读场景虽然接入极速版 IDE 编辑器,但文件树、 ![](/img/di_san_fang/WebIDE/JS语言服务提示.png)
JS语言服务提示
-- 3. 提供了 Java、Go、Python、C++、Php 的在线语言服务能力,支持简单的定义跳转、查找引用等功能,让大家更加方便的阅读代码 +- 3.提供了 Java、Go、Python、C++、Php 的在线语言服务能力,支持简单的定义跳转、查找引用等功能,让大家更加方便的阅读代码 ![](/img/di_san_fang/WebIDE/python查看引用.png)
Python 查看引用
diff --git a/versioned_docs/version-1.1.0/第三方服务/api-guide.md b/versioned_docs/version-1.1.0/第三方服务/api-guide.md new file mode 100644 index 0000000..da226eb --- /dev/null +++ b/versioned_docs/version-1.1.0/第三方服务/api-guide.md @@ -0,0 +1,84 @@ +# API使用指南 + +## API响应格式 + +所有API响应都遵循以下统一格式: + +```json +{ + "code": 200, // 状态码 + "request_id": "xxx", // 请求唯一标识 + "data": { // 响应数据 + // 具体的业务数据 + } +} +``` + +### 状态码说明 +- 200: 请求成功 +- 400: 请求参数错误 +- 401: 未授权 +- 403: 禁止访问 +- 404: 资源不存在 +- 500: 服务器内部错误 + +### 重要说明 +1. `request_id`字段在每个响应中都会返回,用于问题追踪 +2. v2版本API已废弃,请使用v3版本 +3. 所有API调用都需要在Header中携带认证信息 + +## API版本说明 +- v3: 当前稳定版本(推荐使用) +- v2: 已废弃,返回410 Gone +- v1: 已移除 + +## 仓库相关API + +### 获取仓库信息 +```http +GET /api/v3/repos/{owner}/{repo} +``` + +响应示例: +```json +{ + "code": 200, + "request_id": "f58c7dd4-9876-4321-abcd-ef1234567890", + "data": { + "id": 12345, + "name": "example-repo", + "owner": { + "id": 67890, + "login": "example-user" + } + } +} +``` + +### 创建仓库 +```http +POST /api/v3/repos +``` + +请求体示例: +```json +{ + "name": "new-repo", + "description": "A new repository", + "private": false +} +``` + +## WebHook事件类型 +支持的事件类型包括: +1. `push`: 推送代码时触发 +2. `pull_request`: PR相关操作触发 +3. `issue`: Issue相关操作触发 +4. `release`: 发布版本时触发 +5. `star`: 加星操作触发 +6. `fork`: 仓库被fork时触发 +7. `comment`: 评论相关操作触发 +8. `repo_analytics`: 仓库统计数据更新时触发 +9. `wiki`: Wiki页面更新时触发 +10. `member`: 成员变更时触发 +11. `deploy`: 部署事件触发 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/第三方服务/跨平台代码同步.md b/versioned_docs/version-1.1.0/第三方服务/跨平台代码同步.md index 7bf5c56..c63abac 100644 --- a/versioned_docs/version-1.1.0/第三方服务/跨平台代码同步.md +++ b/versioned_docs/version-1.1.0/第三方服务/跨平台代码同步.md @@ -8,46 +8,46 @@ sidebar_position: 2 跨平台仓库代码同步服务用于不同代码托管平台之间的仓库代码双向同步功能。用户将不同平台的仓库分支进行绑定,当任意仓库分支有push事件被webhook监听时,代码推送将实时自动同步至另一个仓库,以实现不同平台之间分支、提交信息的自动同步(代码托管平台仅限于github与gitee)。 -![1.同步流程](../../../static/img/reposyncer/1.同步流程.png) +![1.同步流程](../../static/img/reposyncer/1.同步流程.png) 同步服务既满足双平台代码库分支同步需求,也支持最多创建三个平台的代码仓库同步,如下图所示 -![2.同步方式](../../../static/img/reposyncer/2.同步方式.png) +![2.同步方式](../../static/img/reposyncer/2.同步方式.png) ### 配置双向同步 1、进入需要创建同步的代码库“服务”tab,开通跨平台代码同步服务。 -![3.开启跨平台服务](../../../static/img/reposyncer/3.开启跨平台服务.png) +![3.开启跨平台服务](../../static/img/reposyncer/3.开启跨平台服务.png) 2、配置跨平台的同步仓库,支持github和gitee。需输入代码库地址(git地址和网站访问地址均支持),以及配置对应token用于授权同步,此处须注意token的权限以及是否过期。
Github配置方式为:个人头像→Settings→Developer Settings→Personal access tokens (classic)→Generate new token→勾选repo按钮→保存
Gitee配置方式为:个人头像→设置→私人令牌→生成新令牌→勾选projects权限→提交 -![4.配置同步仓库](../../../static/img/reposyncer/4.配置同步仓库.jpg) +![4.配置同步仓库](../../static/img/reposyncer/4.配置同步仓库.jpg) 3、在首次创建同步仓库时,需要用户手动在目标仓库的代码库创建一条webhook,用于监听仓库push事件,从而向其他同步仓库推送代码完成同步,同步步骤如下: ①点击“复制链接”按钮,复制平台用于接收webhook请求的地址 -![5.配置webhook](../../../static/img/reposyncer/5.配置webhook.jpg) +![5.配置webhook](../../static/img/reposyncer/5.配置webhook.jpg) ②访问点击前往按钮前往目标仓库webhook页新建一个webhook,以github为例 -![6.webhook示例](../../../static/img/reposyncer/6.webhook示例.png) +![6.webhook示例](../../static/img/reposyncer/6.webhook示例.png) ③粘贴链接,并确保该webhook支持push事件的监听,并已经成功激活 -![7.webhook配置规则](../../../static/img/reposyncer/7.webhook配置规则.png) +![7.webhook配置规则](../../static/img/reposyncer/7.webhook配置规则.png) 4、完成仓库配置绑定后,需要绑定这两个仓库的指定同步分支,建立首次同步方向。注:首次同步的策略为单向代码强推,请谨慎选择同步方向开启同步以避免代码被覆盖 -![8.绑定分支](../../../static/img/reposyncer/8.绑定分支.jpg) +![8.绑定分支](../../static/img/reposyncer/8.绑定分支.jpg) 5、完成分支的绑定,在绑定后会根据选择的同步方向立即执行一次同步。后续webhook监听到任意分支有代码推送,会实时向另一个绑定分支同步代码推送代码 -![9.确认绑定](../../../static/img/reposyncer/9.确认绑定.jpg) +![9.确认绑定](../../static/img/reposyncer/9.确认绑定.jpg) ### 管理同步分支 @@ -60,7 +60,7 @@ Gitee配置方式为:个人头像→设置→私人令牌→生成新令牌→ ⑤查询同步记录,包括查看历次同步的代码变更方,同步时间,同步状态及对应commt id,查询同步日志。
⑥中止、开启同步,相当于同步开关,可随时启停 -![同步分支管理](../../../static/img/reposyncer/同步分支管理.png) +![同步分支管理](../../static/img/reposyncer/同步分支管理.png) ### 注意事项 diff --git a/versioned_docs/version-1.1.0/第三方服务/重睛鸟代码溯源.md b/versioned_docs/version-1.1.0/第三方服务/重睛鸟代码溯源.md index c1aea2c..83d1542 100644 --- a/versioned_docs/version-1.1.0/第三方服务/重睛鸟代码溯源.md +++ b/versioned_docs/version-1.1.0/第三方服务/重睛鸟代码溯源.md @@ -5,24 +5,24 @@ sidebar_position: 1 ## 代码分析入口 -![](../../../static/img/di_san_fang/重晴鸟代码溯源/代码分析入口.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/代码分析入口.png)
代码分析入口

页面说明:
1、用户可点击"服务"菜单 tab 进入服务页面。
2、仓库管理员可在"仓库设置" tab 中项目导航处开启/关闭代码分析菜单可见性,如下图:
-![](../../../static/img/di_san_fang/重晴鸟代码溯源/项目导航.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/项目导航.png)
项目导航

## 代码分析检测 -![](../../../static/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png)
代码分析检测

-![](../../../static/img/di_san_fang/重晴鸟代码溯源/新建分析.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/新建分析.png)
新建分析

页面说明:
@@ -32,7 +32,7 @@ sidebar_position: 1 ## 分支选择 -![](../../../static/img/di_san_fang/重晴鸟代码溯源/分支选择.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/分支选择.png)
分支选择

页面说明:
@@ -42,7 +42,7 @@ sidebar_position: 1 ## 列表展示 -![](../../../static/img/di_san_fang/重晴鸟代码溯源/列表展示.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/列表展示.png)
列表展示

页面说明:
@@ -52,7 +52,7 @@ sidebar_position: 1 ## 结果展示 -![](../../../static/img/di_san_fang/重晴鸟代码溯源/结果展示.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/结果展示.png)
结果展示

页面说明:
@@ -62,6 +62,6 @@ sidebar_position: 1 ## 用户操作流程 -![](../../../static/img/di_san_fang/重晴鸟代码溯源/用户操作流程.png)
+![](../../static/img/di_san_fang/重晴鸟代码溯源/用户操作流程(新).png)
用户操作流程

diff --git a/versioned_docs/version-1.1.0/组织管理/组织成员管理.md b/versioned_docs/version-1.1.0/组织管理/组织成员管理.md index b178a64..8c78b2b 100644 --- a/versioned_docs/version-1.1.0/组织管理/组织成员管理.md +++ b/versioned_docs/version-1.1.0/组织管理/组织成员管理.md @@ -1,4 +1,21 @@ --- sidebar_label: '组织成员管理' sidebar_position: 4 ---- \ No newline at end of file +--- +# 成员管理(Members Management) + + 在 个人所管理的项目当中的**仓库设置**当中的**成员管理**可以进入成员管理界面 + + ![](/img/Org/imageOrg14.png) + +## 成员查询和添加 +在成员管理界面当中,可以进行组织成员的查询和添加 + + ![](/img/Org/imageOrg14.png) + +## 成员邀请权限设置 +管理员可以对邀请成员的权限进行设置 + ![](/img/Org/imageOrg15.png) +此外,也可以复制邀请链接的方式来更方便地邀请成员加入到项目当中来 + + **注**:此项功能仅对管理员可见 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/维基/模板导入及导出.md b/versioned_docs/version-1.1.0/维基/模板导入及导出.md index 0901b17..8245753 100644 --- a/versioned_docs/version-1.1.0/维基/模板导入及导出.md +++ b/versioned_docs/version-1.1.0/维基/模板导入及导出.md @@ -1,4 +1,15 @@ --- sidebar_label: '模板导入及导出' sidebar_position: 2 ---- \ No newline at end of file +--- + +# 确实开源帮助中心 + +## 模板的导入及导出管理 +#### 1.模板导入 +通过点击wiki界面的**导入模板**按钮即可导入本地的txt,markdown等格式文件进行Wiki文档的创建,当前平台此项功能尚在开发测试环节 +[](/img/wiki/img4.png) +#### 2.模板导出 +当前平台此项功能尚在开发测试环节 +
+ diff --git a/versioned_docs/version-1.1.0/维基/维基页面管理.md b/versioned_docs/version-1.1.0/维基/维基页面管理.md index 1ed56fc..976a092 100644 --- a/versioned_docs/version-1.1.0/维基/维基页面管理.md +++ b/versioned_docs/version-1.1.0/维基/维基页面管理.md @@ -1,4 +1,23 @@ --- sidebar_label: '维基页面管理' sidebar_position: 1 ---- \ No newline at end of file +--- + + +# 确实开源帮助中心 + +## 维基界面管理 +#### 1.维基界面 +GitLink项目安排了专门的**维基(Wiki)界面**来展示项目的一些情况 +[](/img/wiki/img1.png) + +#### 2.创建维基内容 +在初始化的维基界面当中点击**创建Wiki文档**或者**导入模板**即可进行Wiki文档的编辑 +
+ +#### 3.进行Wiki文档的编辑 +点击**创建Wiki文档**后即跳转到编辑界面,初始内容为空白的文档 +[](/img/wiki/img3.png) +也可以通过勾选*添加模板*来进行模板的导入,平台提供的模板包括*周报*和*月报*的格式 +[](/img/wiki/img2.png) +完成编辑后点击左下角的的保存即可 \ No newline at end of file diff --git a/versioned_docs/version-1.1.0/通知/通知设置.md b/versioned_docs/version-1.1.0/通知/通知设置.md index 37f798c..bfde209 100644 --- a/versioned_docs/version-1.1.0/通知/通知设置.md +++ b/versioned_docs/version-1.1.0/通知/通知设置.md @@ -12,6 +12,7 @@ sidebar_position: 2 ![](/img/notice/home_notice.png)
或在头像下拉列表中选择设置可以进入消息通知设置界面; + ![](/img/notice/into_notice.png) #### 2.进行通知设置