Skip to content

Commit 1eda1c0

Browse files
nimishbongalenimishbongale
authored
Merge pull request creativecommons#6 from creativecommons/master
Update fork
2 parents 3602b55 + 1fb0838 commit 1eda1c0

File tree

5 files changed

+200
-21
lines changed

5 files changed

+200
-21
lines changed

‎content/blog/entries/finish-video-presentation-project-report-and-evaluation-form/contents.lr

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
title: Finish Video Presentation, Project Report and Evaluation Form
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-01
16+
---
17+
body:
18+
19+
For week 10 and 11, I finished porting CC Catalog documentation, submitted a video presentation, and wrapped up my GSoD 2020 journey.
20+
21+
### Week 11
22+
23+
For Week 11, I finished working on porting CC Catalog documentation from internal wiki to CC Catalog’s GitHub repository.
24+
Kriti told me that there would be a meeting in which I have to present what I've done for GSoD.
25+
Since the meeting will take place at 1AM in my local time, Kriti told me that I should send a video presentation instead.
26+
27+
### Week 12
28+
29+
For this week, I submitted a video presentation to Kriti.
30+
Finished writing project report and evaluation for GSoD.
31+
I published 2 blog posts this week.
32+
One for updates on Week 11 and Week 12.
33+
Another one is a summary of my GSoD 2020 journey, which also serves as a project report.
34+
35+
----
36+
37+
Signing off.

‎content/blog/entries/summary-my-gsod-2020-journey/contents.lr

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
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/).

‎databags/issues.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@
315315
"number": 159,
316316
"repo": "creativecommons.github.io-source",
317317
"title": "Move information about old GSoC projects to CC Open Source ",
318-
"updatedAt": 1601490653,
318+
"updatedAt": 1606887154,
319319
"url": "https://github.com/creativecommons/creativecommons.github.io-source/issues/159"
320320
},
321321
{
@@ -431,6 +431,21 @@
431431
"updatedAt": 1603376723,
432432
"url": "https://github.com/creativecommons/creativecommons.org/issues/940"
433433
},
434+
{
435+
"createdAt": 1606848017,
436+
"labels": [
437+
"good first issue",
438+
"help wanted",
439+
"\ud83d\udcbb aspect: code",
440+
"\ud83d\udee0 goal: fix",
441+
"\ud83d\udfe7 priority: high"
442+
],
443+
"number": 18,
444+
"repo": "og-image-generator",
445+
"title": "Encode query parameters containing urls for facebook and other social media platforms.",
446+
"updatedAt": 1606848029,
447+
"url": "https://github.com/creativecommons/og-image-generator/issues/18"
448+
},
434449
{
435450
"createdAt": 1606659007,
436451
"labels": [
@@ -464,21 +479,6 @@
464479
"updatedAt": 1606284360,
465480
"url": "https://github.com/creativecommons/chooser/issues/207"
466481
},
467-
{
468-
"createdAt": 1604609253,
469-
"labels": [
470-
"good first issue",
471-
"help wanted",
472-
"\ud83c\udf1f goal: addition",
473-
"\ud83d\udcaa skill: lektor",
474-
"\ud83d\udcbb aspect: code"
475-
],
476-
"number": 553,
477-
"repo": "creativecommons.github.io-source",
478-
"title": "Implement generated Open Graph Images ",
479-
"updatedAt": 1604609253,
480-
"url": "https://github.com/creativecommons/creativecommons.github.io-source/issues/553"
481-
},
482482
{
483483
"createdAt": 1604518405,
484484
"labels": [

‎themes/vocabulary_theme/templates/layout.html

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,8 @@
1717
{% endif %}
1818
<meta property="og:url" content="{{ this|url }}" />
1919
<meta property="og:type" content="article" />
20-
{% set image = this.attachments.images.first() %}
21-
{% if image %}
22-
<meta property="og:image" content="{{ image|url(external=true)}}" />
23-
{% endif %}
20+
{% from "macros/og_image.html" import og_image %}
21+
{{ og_image(this) }}
2422
<meta name="twitter:card" content="summary_large_image" />
2523
<meta name="twitter:title" content="{{ this.title }}">
2624
<meta name="twitter:description" content="{{ desc }}">
@@ -41,7 +39,7 @@
4139
<script>
4240
const globalHeaderInstance = vocabulary.createGlobalHeader();
4341
</script>
44-
<title>{% block title %}Welcome{% endblock %} — Creative Commons on GitHub</title>
42+
<title>{% block title %}Welcome{% endblock %} — Creative Commons Open Source</title>
4543

4644
<body>
4745
<div class="ga-script">{{ generate_google_analytics() }}</div>

‎themes/vocabulary_theme/templates/macros/og_image.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{% from "macros/author_name.html" import render_author_name %}
2+
3+
{% macro og_image(page) %}
4+
{% set baseUrl = 'https://cc-og-image.vercel.app/' %}
5+
{% set queryParams = '?&md=1&fontFamily=roboto-condensed&fontSize=100px&images=https%3A%2F%2Fcc-vocabulary.netlify.app%2Flogos%2Fproducts%2Fopen_source.svg%23opensource' %}
6+
7+
{% if page.title %}
8+
{% set pageTitle = page.title %}
9+
{% else %}
10+
{% set pageTitle = 'Open Source at CC' %}
11+
{% endif %}
12+
13+
{% if page.author %}
14+
{% set author = page.parent.parent.children.get('authors').children.get(page.author) %}
15+
{% if author and author.md5_hashed_email %}
16+
{% set gravatarURL = 'https://secure.gravatar.com/avatar/' + author.md5_hashed_email + '?size=300&d=mp' %}
17+
{% set queryParams = queryParams + '&images=' + gravatarURL %}
18+
{% set pageTitle = page.title + '<br><sm style="font-size:70px;">By '+ render_author_name(author) + '</sm>' %}
19+
{% endif %}
20+
{% endif %}
21+
22+
{% set url = baseUrl + pageTitle + '.png' + queryParams %}
23+
24+
<meta property="og:image" content="{{ url }}" />
25+
{% endmacro %}

0 commit comments

Comments
 (0)