Skip to content

Commit e2e6120

Browse files
authored
Merge pull request creativecommons#539 from ariessa/master
Added new blog entry
2 parents 9f301bb + 584f5a2 commit e2e6120

File tree

2 files changed

+76
-0
lines changed
  • content/blog/entries
    • add-new-sections-descriptions-help-texts-code-examples-schemas-and-serializers
    • add-response-samples-and-descriptions-for-api-endpoints

2 files changed

+76
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
title: Add New Sections, Descriptions, Help Texts, Code Examples, Schemas, and Serializers
2+
3+
---
4+
categories:
5+
cc-catalog-api
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-10-21
16+
---
17+
body:
18+
19+
Welcome to my third blog entry! For week 5 and 6, I added new sections, descriptions, help texts, code examples, schemas, and serializers. I was so productive these past two weeks.
20+
21+
22+
### Week 5
23+
For this week, I managed to add a lot of stuff into the documentation.
24+
I figured out how to add help texts to classes and how to create serializers.
25+
I also managed to move all code examples under response samples.
26+
In order to do this, I created a new class called CustomAutoSchema to add [x-code-samples](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-codesamples).
27+
Other stuff that I did include creating new sections such as “Register and Authenticate” and “Glossary”.
28+
The hardest part of this week is probably trying to figure out how to add request body examples and move code examples.
29+
30+
31+
### Week 6
32+
33+
For week 6, I added another section called Contribute that provides a todolist to start contributing on Github.
34+
I also wrote and published this blog post.
35+
36+
----
37+
38+
All caught up!
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
title: Add Response Samples and Descriptions for API Endpoints
2+
---
3+
categories:
4+
cc-catalog-api
5+
gsod
6+
gsod-2020
7+
open-source
8+
community
9+
---
10+
author: ariessa
11+
---
12+
series: gsod-2020-cccatalog-api-usage-guide
13+
---
14+
pub_date: 2020-10-09
15+
---
16+
body:
17+
18+
Well, hello again 👋! For week 3 and week 4, I added response samples and descriptions for API endpoints. Writing documentation feels a bit like coding at this point because I need to read a lot about drf-yasg, dig through issues and questions at Github / Stackoverflow to ensure that I don’t ask redundant (or even stupid) questions.
19+
20+
### Week 3
21+
22+
Week 3 was quite hectic. I moved back to my hometown during week 3.
23+
Took 3 days off to settle my stuff and set up a workspace.
24+
I worked on my GSoD project for only 2 days, Monday and Tuesday.
25+
I managed to create response samples for most API endpoints.
26+
Had a monthly video call with Kriti this week.
27+
28+
### Week 4
29+
30+
For this week, I reviewed what I’ve done and what I haven’t to estimate new completion time.
31+
Thank god, I have a buffer week in my GSoD timeline and deliverables.
32+
So yeah, all is good in terms of completion time.
33+
I started to write descriptions for API endpoints.
34+
Submitted first PR and published blog entry.
35+
36+
----
37+
38+
Over and out.

0 commit comments

Comments
 (0)