From c5ac642a078b533bf33fe82cfa3a3a22b5c16a2f Mon Sep 17 00:00:00 2001 From: govolokatliai Date: Thu, 22 Aug 2024 11:46:15 +0800 Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E4=BA=86=E5=BF=AB=E9=80=9F?= =?UTF-8?q?=E4=B8=8A=E6=89=8B=E6=8C=87=E5=8D=97=E7=9A=84=E4=B8=80=E4=BA=9B?= =?UTF-8?q?=E5=86=85=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../devdocs/02-网站/02-开发组网站/快速上手.md | 36 ++++++++++++++----- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/docs/devdocs/02-网站/02-开发组网站/快速上手.md b/docs/devdocs/02-网站/02-开发组网站/快速上手.md index 6335065..fa17a9e 100644 --- a/docs/devdocs/02-网站/02-开发组网站/快速上手.md +++ b/docs/devdocs/02-网站/02-开发组网站/快速上手.md @@ -1,5 +1,5 @@ # 快速上手 -本指南写给技术背景较浅，但是又愿意参与网站内容开发的人 +修网的知识需要在实践中不断积累，网维的wiki做为每一个网维成员经验的总结，自然也需要不断的更新，但是，wiki本身大部分时间都是由开发组的仅仅几个人来维护，难以时刻更新到最新情况，所以，我们想让网维的每个人都能加入wiki的维护，这篇文章就是写给希望为wiki添砖加瓦，却不太了解相关方法的小伙伴的，希望这篇文章能够快速让你上手wiki的维护工作。 :::info 信息 在正式开始编辑前，你可以看看我们的成品网站，每篇文章的下面会有一个`Edit This Page`的链接，是这篇文章的源代码，这里是网站的链接：[Click Me ](https://zscdev-demo.pages.dev/) @@ -8,9 +8,9 @@ ## 准备 我们假设你所使用的是windows系统。 -首先，我们需要安装必要的开发工具：git 和 nodejs。 +首先，我们需要安装必要的开发工具：git 和 Node.js。 -访问如下链接：[git下载](https://git-scm.com/download/win) , [nodejs下载](https://nodejs.org/zh-cn/download/prebuilt-installer)。 +访问如下链接：[git下载](https://git-scm.com/download/win) , [Node.js下载](https://nodejs.org/zh-cn/download/prebuilt-installer)。 :::info 信息 @@ -20,17 +20,17 @@ :::tip git是什么？ -git是一个版本控制工具，他可以追踪一个项目的改动，并且大大方便了多人协作的管理。 +git是一个版本控制工具，他会记录一个项目从创建之初任何人对任何文件的任何改动，大大方便了多人协作工程的管理，wiki的源代码托管在基于git设计的github上。 ::: :::tip 什么是Node.js? -Node.js是一个在后端运行javascript的运行时。 +Node.js是一个在后端运行javascript的运行时，我们使用基于这个平台设计的docusaurus框架来将wiki从一堆markdown文档变成一个网站。 ::: -访问github,如果没有账号，就注册一个，打开https://github.com/ZSCNetSupportDept/website。 +访问github,如果没有账号，就注册一个，然后，打开https://github.com/ZSCNetSupportDept/website。 点击上面的fork,创建仓库的一个分支，点击create fork。 @@ -50,7 +50,7 @@ Node.js是一个在后端运行javascript的运行时。 ::: -然后，输入`cd website` +然后，输入`cd website`。 切换到我们的项目目录下后，运行`npm install`来安装项目的所有依赖。 @@ -200,5 +200,25 @@ git push 然后就可以Create Pull Request了。 -我们会检查你的提交是否合适，然后在主仓库合并你的修改，这就是我们的开发流程了。 +提交后，开发组成员会校对你的修改，将你的修改应用到主仓库中，这就是我们的开发流程了。 + + +:::info wiki的分层更新模型 + +按照我们的设计，wiki的内容从新到旧，一共分为三个版本： +- 最新的版本是大家在自己的电脑上运行的测试版网站，这个版本包含了最新的想法和更改，等待完善后推送到主仓库。 +- 然后是我们的demo版本网站[zscdev-demo.pages.dev](zscdev-demo.pages.dev),这个版本立即反应了任何被合并进去主仓库master分支的更改，大家可以对这个网站上的内容随便提意见，任何修改都将很快被同步到网站里。 +- 当主仓库和demo网站的更新积累到一定程度的数量时，开发组成员会根据一个版本作为wiki的正式版，正式推送到我们的网站[developer.zsxyww.com](developer.zsxyww.com)里，这个版本通常要比demo要落后几次更新，但是那些在施工中的文章，和还在讨论的段落等不稳定的内容将不会被同步到这里，换句话说，这个版本是“稳定版”。 + +我们从debian的开发中(unstable/testing/stable)借鉴了这一模型,它可以确保最终正式的wiki是严谨的，可信赖的，同时将想法和讨论的场地从正式文档中分离开，确保了开发的有序进行. + + +这样的设计是考虑了这样的场景：有许多人同时参与wiki的开发，而不是一年不一定更新一回的随意开发，还是希望大家能多多参与到wiki的维护工作中来。。。 + +::: + + + + +