CC开源博客

简介:我的GSoD 2020旅程

功能

通过Ariessa Norramli在2020-12-02

这个博客是系列的一部分: GSoD 2020:改善CC目录API使用指南

谢谢你的美妙的经验,知识共享!卡塔尔vs葡萄牙分析

这篇文章作为一个项目报告“改善CC目录API使用指南”。它描述了我所做的工作在我的Google Docs (GSOD) 2020的季节。我的导师这个项目从Creative Commons殖民地奥尔登页面和克里特岛。卡塔尔vs葡萄牙分析

总共有12周医生开发阶段。每2周,我会发布一篇博文更新我对我的导师和组织的进步。

星期1

所以,前两周的Google Docs的季节已经过去了。第一周,我说的例子使用curl命令来执行查询。我打了一些问题被禁止的错误。原来我的访问密钥过期了。解决了我的问题后,获得一个新的访问键。

星期2

第二周,我开始写响应样本。很艰难,我很难理解drf-yasg,这是一个自动的发电机。它可以产生大摇大摆/ OpenAPI 2.0规范的Django框架API。我试图找到尽可能多的例子我可以提高我的理解。有趣,但我花了一段时间才意识到,drf-yasg不是随机字母组成。DRF的部分代表Django框架休息而YASG代表另一个时髦的发电机。

星期3

星期3非常忙碌。在星期3我搬回我的家乡。花了3天时间去解决我的东西并建立一个工作区。我从事GSoD项目只有2天,周一和周二。我设法创建响应样本对于大多数API端点。本周与克里特岛每月视频通话。

星期4

我回顾了我做了什么,我没有估计新的完成时间。感谢上帝,我有一个缓冲的一周我GSoD时间表和交付。是的,都是良好的完成时间。我开始写描述API端点。提交第一次公关和发表博客条目。

星期5

我设法向文档添加很多东西。我知道如何帮助文本添加到类和如何创建序列化器。我也设法将所有代码示例响应下样品。为此,我创建了一个名为CustomAutoSchema x-code-samples添加的新类。其他东西我确实包括创建新的部分,如“注册和认证”和“词汇表”。最难的部分本周可能是试图找出如何添加请求主体例子和代码示例。

第6周

我添加了另一个章节开始贡献贡献,提供了基于网络在Github上。我也写和发表这篇博客。

星期7

我重组CC目录的README文件API库。我添加了一个一步一步指导如何在本地运行服务器。我希望新用户将不再那么害怕与更新的指南为这个项目如何在本地运行服务器。

第八周

我创建了文档指南提供步骤如何有助于CC目录API文档,文档风格,并为drf-yasg备忘单。我也写和发表这篇博客。

9周

我已经完成所有GSoD任务周9。我上周请了几天假,固定的公关,克里特岛指派我与新任务,即港口CC目录从内部wiki文档到GitHub库。布伦特,CC目录维护人员向我解释要做什么。

第十个星期

我开始探索CC目录和它的文档。提醒我很多关于第一和第二周的GSoD。试图了解新东西,有一个“啊哈”最后时刻点连接。我开始将文档从内部wiki CC目录的GitHub库。我也写和发表这篇博客。

11周

我完成工作在移植CC目录文档内部wiki CC目录的GitHub库。克里特岛告诉我,会有一个会议,我必须为GSoD现在我所做的。由于会议将在当地时间1点我,克里特岛告诉我,我应该发送一个视频演示。

第12周

我提交了一个视频演示克里特岛。写完GSoD项目报告和评估。这个星期我2发表博客文章。一个用于更新在11周,第12周。另一个是这篇博文。



您可以查看最新的CC目录API文档在这里