|
| 1 | +title: Summary: My GSoD 2020 Journey |
| 2 | + |
| 3 | +--- |
| 4 | +categories: |
| 5 | +cc-catalog |
| 6 | +gsod |
| 7 | +gsod-2020 |
| 8 | +open-source |
| 9 | +community |
| 10 | +--- |
| 11 | +author: ariessa |
| 12 | +--- |
| 13 | +series: gsod-2020-cccatalog-api-usage-guide |
| 14 | +--- |
| 15 | +pub_date: 2020-12-02 |
| 16 | +--- |
| 17 | +body: |
| 18 | + |
| 19 | +Thank you for the wonderful experience, Creative Commons! |
| 20 | + |
| 21 | +This blog post serves as a project report for ‘Improve CC Catalog API Usage Guide’. |
| 22 | +It describes the work that I’ve done during my Google Season Of Docs (GSOD) 2020. |
| 23 | +My mentors for this project are Alden Page and Kriti Godey from Creative Commons. |
| 24 | + |
| 25 | +In total, there are 12 weeks in the Doc Development Phase. |
| 26 | +Every 2 weeks, I would publish a blog post to update my progress to my mentors and organization. |
| 27 | + |
| 28 | +### Week 1 |
| 29 | + |
| 30 | +So, the first two weeks of Google Season of Docs have passed. |
| 31 | +For the first week, I added examples to perform the query using curl command. |
| 32 | +I hit some problem with a Forbidden error. Turns out my access key got expired. |
| 33 | +My problem was solved after obtaining a new access key. |
| 34 | + |
| 35 | +### Week 2 |
| 36 | + |
| 37 | +For the second week, I started to write response samples. |
| 38 | +It was tough as I have a hard time understanding drf-yasg, which is an automatic Swagger generator. |
| 39 | +It can produce Swagger / OpenAPI 2.0 specifications from a Django Rest Framework API. |
| 40 | +I tried to find as many examples as I could to increase my understanding. |
| 41 | +Funny, but it took me awhile to realise that drf-yasg is not made up of random letters. |
| 42 | +The DRF part stands for Django Rest Framework while YASG stands for Yet Another Swagger Generator. |
| 43 | + |
| 44 | +### Week 3 |
| 45 | + |
| 46 | +Week 3 was quite hectic. |
| 47 | +I moved back to my hometown during week 3. |
| 48 | +Took 3 days off to settle my stuff and set up a workspace. |
| 49 | +I worked on my GSoD project for only 2 days, Monday and Tuesday. |
| 50 | +I managed to create response samples for most API endpoints. |
| 51 | +Had a monthly video call with Kriti this week. |
| 52 | + |
| 53 | +### Week 4 |
| 54 | + |
| 55 | +I reviewed what I’ve done and what I haven’t to estimate new completion time. |
| 56 | +Thank god, I have a buffer week in my GSoD timeline and deliverables. |
| 57 | +So yeah, all is good in terms of completion time. |
| 58 | +I started to write descriptions for API endpoints. |
| 59 | +Submitted first PR and published blog entry. |
| 60 | + |
| 61 | +### Week 5 |
| 62 | + |
| 63 | +I managed to add a lot of stuff into the documentation. |
| 64 | +I figured out how to add help texts to classes and how to create serializers. |
| 65 | +I also managed to move all code examples under response samples. |
| 66 | +In order to do this, I created a new class called CustomAutoSchema to add x-code-samples. |
| 67 | +Other stuff that I did include creating new sections such as “Register and Authenticate” and “Glossary”. |
| 68 | +The hardest part of this week is probably trying to figure out how to add request body examples and move code examples. |
| 69 | + |
| 70 | +### Week 6 |
| 71 | + |
| 72 | +I added another section called Contribute that provides a todolist to start contributing on Github. |
| 73 | +I also wrote and published this blog post. |
| 74 | + |
| 75 | +### Week 7 |
| 76 | + |
| 77 | +I restructured the file README in CC Catalog API repository. |
| 78 | +I added a step by step guide on how to run the server locally. |
| 79 | +I hope new users will be less intimidated to contribute to this project with the updated guide on how to run the server locally. |
| 80 | + |
| 81 | +### Week 8 |
| 82 | + |
| 83 | +I created Documentation Guidelines which provides steps on how to contribute to CC Catalog API documentation, documentation styles, and cheat sheet for drf-yasg. |
| 84 | +I also wrote and published this blog post. |
| 85 | + |
| 86 | +### Week 9 |
| 87 | + |
| 88 | +I had completed all GSoD tasks by week 9. |
| 89 | +So, I took a couple of days off and fixed last week's PR. |
| 90 | +Kriti assigned me with new tasks, which is to port CC Catalog documentation from the internal wiki into GitHub repository. |
| 91 | +Brent, the CC Catalog maintainer explained to me about what needs to be done. |
| 92 | + |
| 93 | +### Week 10 |
| 94 | + |
| 95 | +I started exploring CC Catalog and its documentation. |
| 96 | +Reminds me a lot about the first and second weeks of GSoD. |
| 97 | +Trying to understand new stuff and having an "aha" moment when the dots finally connect. |
| 98 | +I started to move the documentation from the internal wiki to CC Catalog’s GitHub repository. |
| 99 | +I also wrote and published this blog post. |
| 100 | + |
| 101 | +### Week 11 |
| 102 | + |
| 103 | +I finished working on porting CC Catalog documentation from internal wiki to CC Catalog’s GitHub repository. |
| 104 | +Kriti told me that there would be a meeting in which I have to present what I've done for GSoD. |
| 105 | +Since the meeting will take place at 1AM in my local time, Kriti told me that I should send a video presentation instead. |
| 106 | + |
| 107 | +### Week 12 |
| 108 | + |
| 109 | +I submitted a video presentation to Kriti. |
| 110 | +Finished writing project report and evaluation for GSoD. |
| 111 | +I published 2 blog posts this week. |
| 112 | +One for updates on Week 11 and Week 12. |
| 113 | +Another one is this blog post. |
| 114 | + |
| 115 | +<br/> |
| 116 | + |
| 117 | +---- |
| 118 | + |
| 119 | +You can view the latest CC Catalog API documentation [here](https://api.creativecommons.engineering/v1/). |
0 commit comments