保姆级教程：如何成为Apache Linkis文档贡献者

不会写代码，也能为社区做贡献

大家好，我是WeDataSphere小助手，平时有些刚刚接触开源项目的同学找我聊天，问到一个有趣的问题：

开源项目都是开发大佬，但我不会写代码，我还能为开源社区做贡献么？

小助手的答案非常明确：

不会写代码，也可以给社区做出很多贡献的。

首先我们立体的看待开源项目和开源社区，除了代码以外，我们是不是还需要：

• 完善的安装部署文档、技术博客、官网文档指引、视频教程；

• 组织社区活动、推广开源项目、撰写宣传文案、设计精美的社区图案；

• 参与用户交流、QA答疑、社区投票、发现BUG、提出建议；

每一个社区用户都可以结合自己的兴趣爱好和擅长的领域，为社区做贡献。

文档作为项目很重要的一部分，需要不断的更新迭代。因此今天小助手准备了保姆级教程，手把手教大家如何做文档贡献者，成功为Linkis项目贡献文档，还能够成为Apache项目的文档贡献者，获得社区定制的贡献者证书哦~~

（证书系列）

文档贡献实践案例

这次的教程，我们的实践场景是：

在Linkis官网中增加“如何参与开发者例会”菜单和对应的文档内容

。

- 官网链接（英文）：

https://linkis.apache.org/community/how-to-contribute-to-website/

- 官网链接（中文）：

https://linkis.apache.org/zh-CN/community/how-to-contribute-to-website/

当前是没有“如何参与开发者例会”的菜单，请跟小助手一步一步来操作，走起~~

实践操作步骤

第一步：Fork官网仓库

步骤1：打开官网对应的GitHub链接：

https://github.com/apache/incubator-linkis-website/

       

步骤2：点击Fork按钮，把官网的项目Fork到自己的仓库中       

第二步：同步源仓库&创建临时开发分支

步骤1：打开自己fork的仓库

 https://github.com/{you githubid}/incubator-linkis-website/。

步骤2：

切换到dev分支

，点击【Fetch upstream】；如果你的dev分支不是上游源仓库dev分支最新的代码，可以点击【Fetch and Merge】进行同步，将上游源仓库dev分支代码同步fork的dev分支上。

步骤3：基于dev分支创建dev-fix分支，修改开发基于dev-fix分支进行 ，如果存在上一次提交PR使用的dev-fix分支，如果PR已经被merge，可以先删除，再创建dev-fix分支；或则创建dev-fix2分支。

第三步：Clone到本地

首次克隆，参考步骤1-4；后续的更新，参考步骤5。

步骤1：点击“code”按钮，选择“Open with GitHub Desktop”。大家可以提前下载安装好GitHub的桌面客户端，链接：

https://desktop.github.com/

。

步骤2：确认克隆配置链接和本地文件夹。     

步骤3：等待克隆完成。通过GitHub客户端下载代码到本地，首次需要的时间会比较长。     

步骤4：克隆完成，在本地可以看到对应的文件与GitHub上的是一致的。   

步骤5：获取远程分支，同步到本地。如果已经克隆过，后续修改直接获取远程分支即可。

由于dev是基于多人协作，开发者会同时提交多处修改。因此在做修改前，一定要基于最新版本的分支，否则会导致版本冲突等异常情况。

第四步：修改内容

包含了增删改查的操作，对于本次的实践，是增加“如何参与开发者例会”的内容，因此我们只需要添加对应文档即可。

步骤1：找到对应的官网文档目录。我们是在顶部“社区”导航下添加内容，因此找“/community/”目录。官网分为中英文版本，所以需要找到中英文对应的目录。

- 英文目录：/community/

- 中文目录：/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/

（中文目录）

步骤2：在中文和英文的路径目录中增加文件“

how-to-participate-in-developer-meetings.md

”

步骤3：编写文件内容，需要中英文版本，使用markdown的格式来写；

第五步：Commit到仓库

步骤1：中文和英文两个文件都修改完毕后，我们可以看到GitHub客户端左边会出现对应修改的文件。左下角有Commit的功能，填写Commit的相关内容，点击按钮。

注意点：要在dev-fix分支上进行提交，不要选择master/dev，不要选择master/dev，不要选择master/dev。

步骤2：点击“Push origin”，把提交的Commits内容Push到GitHub项目中

第六步：创建Pull Request

步骤1：Push完毕后，客户端会出现“Create Pull Request”按钮。       

步骤2：创建Pull Request。

有两种方式进行创建PR，提交自己的

dev-fix

分支的PR到上游源仓库的

dev

分支。

第一种：通过点击客户端出现的“Create Pull Request”按钮进行创建

第二种：打开GitHub网页直接进行创建，链接：

https://github.com/apache/incubator-linkis-website/compare/master...Andywli:master

步骤3：创建PR成功    

         

第七步：等待Review和Merge

（1）提交PR成功后，需要等待官方开发同学进行内容Review。如果提交的内容有问题，官方开发同学会在PR上进行留言，根据反馈进行修改文档内容。

（2）如无修改，则等待Merge。Merge成功后，会收到邮件通知。

（3）PR被Merge后，状态也会发生改变；

经过千辛万苦，终于完成了7步，成功把文档内容提交到GitHub，后续就留意项目开发者的Merge进度了。

第八步：更新官网内容

负责官网的开发同学，会定期把代码更新到测试环境，在测试环境中测试通过后就会更新到正式环境的官网。

- 测试官网：

https://linkis.staged.apache.org/zh-CN/community/community:how-to-participate-in-developer-meetings/

- 正式官网：

https://linkis.apache.org/zh-CN/community/community:how-to-participate-in-developer-meetings

        

成为Apache Linkis贡献者

很高兴，我们成功把“

如何参与开发者例会

”的文档更新到官网啦！

所以，不会写代码，也是可以为开源社区做贡献的。对于成功贡献的小伙伴们，我们也能看到自己的劳动成果。

在GitHub项目中的Contributors列表中可以看到自己的头像。

在Linkis官网中也可以看到自己已经被添加到“Contributors of Apache Linkis WebSite”中。

官网贡献者列表：

https://linkis.apache.org/zh-CN/team

最后，参考文章

【请领取贡献者证书】WeDataSphere社区贡献名单公布

的内容，填写调查问卷，获取您的贡献者证书。

【贡献指引】

• Apache Linkis 官网贡献指引：
  https://www.bilibili.com/video/BV1qr4y1s7pv?share_source=copy_web

• Apache Linkis 项目贡献指引：
  https://www.bilibili.com/video/BV1MZ4y1b7Km?share_source=copy_web

• 官网项目新手任务列表：
  https://github.com/apache/incubator-linkis-website/issues/270