Skip to content

Commit d6fb684

Browse files
dhruvkbdhruvkb
committed
Merge branch 'master' of https://github.com/creativecommons/creativecommons.github.io-source into engagement_guide
2 parents b87f8e5 + 7344000 commit d6fb684

File tree

44 files changed

+1814
-545
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1814
-545
lines changed

‎Pipfile.lock

+63-64
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎content/blog/authors/krysal/contents.lr

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ name: Krystle Salazar
55
md5_hashed_email: f36bcb2678c0c0845f8adf634c4d764b
66
---
77
about:
8-
Krystle is a Software Developer from Venezuela, working on **Reimplement [CC’s Legal Database](https://github.com/creativecommons/caselaw) using Django** as part of Outreachy Summer round of 2020. You can find her as `@krysal` on the CC Slack.
8+
Krystle is a Software Developer from Venezuela, working on **Reimplement [CC’s Legal Database](https://github.com/creativecommons/legaldb) using Django** as part of Outreachy Summer round of 2020. You can find her as `@krysal` on the CC Slack.

‎content/blog/entries/add-new-sections-descriptions-help-texts-code-examples-schemas-and-serializers/contents.lr

+38
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!

‎content/blog/entries/add-response-samples-and-descriptions-for-api-endpoints/contents.lr

+38
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.

‎content/blog/entries/cc-vocabulary-docs-updates-1/contents.lr

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
title: Vocabulary Site Updates (v1)
2+
---
3+
categories:
4+
cc-vocabulary
5+
gsod
6+
gsod-2020
7+
---
8+
author: nimishbongale
9+
---
10+
series: gsod-2020-vocabulary-usage-guide
11+
---
12+
pub_date: 2020-10-26
13+
---
14+
body:
15+
16+
Hello there! Well well well. It has been an eventful first few weeks, to say the least! Let's gauge my progress, shall we?
17+
18+
## Vocabulary Site Updates (Edition 1/many more to come)
19+
20+
### What I've been upto
21+
22+
I've mainly got myself invested in a survey of the existing documentation that vocabulary currently possesses, and find places where it could be made better. After clearing those issues out, I began building the main landing site for `Vocabulary`, `Vue-vocabulary` and `Fonts`. It wasn't particularly difficult to establish the necessary workflows as I had done something similar before. During the process of designing the basic structure of the site, I came across a few instances where I felt we needed new/improved components & I discussed the same with my team over on the sprint calls. The design of the site is nearly done. I'm also building the site parallelly & seeking approval from the CC Design Team. I've gotten myself involved in multiple other community contributions to CC as well across multiple of our repositories.
23+
24+
### What I've learnt
25+
- Knowing the previously existing code in your project is of serious essence. It's important to understand the code styles, structure & activity of the code that you are dealing with.
26+
- Be patient! Its fine to delay something if it makes sense to have it logically accomplished only after certain other tasks are done & dusted with.
27+
- How essential it is to write _neat code_ is something that's not spoken too often. (I wonder why...)
28+
- I always thought VueJS sets up SPA's by default. I'm surprised you need to configure it additionally to do just that!
29+
- Storybook is just a really nifty OSS with great community support!
30+
31+
### Other community work tidbits
32+
- I've been working on the Dark Mode (a much awaited feature, at least for me!) for our storybooks with some support from our community. It should be up and running shortly!
33+
- Fixed some formatting bugs in the `README.md` & suggested changes wrt to `npm v7` considerations.
34+
- Fixed storybook components docs for 2 features.
35+
- Raised a ticket for a component to render markdown text within vocabulary itself.
36+
- Raised a few other issues for potential hacktoberfest contributions.
37+
38+
<p align="center">
39+
<strong>Thank you for your time! To be continued...</strong>
40+
</p>

‎content/blog/entries/cc-vocabulary-docs-updates-2/contents.lr

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
title: Vocabulary Site Mid-Internship Update (v2)
2+
---
3+
categories:
4+
cc-vocabulary
5+
gsod
6+
gsod-2020
7+
---
8+
author: nimishbongale
9+
---
10+
series: gsod-2020-vocabulary-usage-guide
11+
---
12+
pub_date: 2020-11-09
13+
---
14+
body:
15+
This is a mid-internship blog post. Wait. what!? Already? Let's glance over my progress, shall we?
16+
17+
## Vocabulary Site Updates (Edition 2/many more to come)
18+
19+
Oh boy! 1.5 months have passed since I've been investing time in building a landing site & usage guide for CC Vocabulary. A lot has changed since the time of posting my last blog post. **A lot**.
20+
21+
<center>
22+
<img alt"Halfway There" src="speed.gif"/><br>
23+
<small class="muted">Hitting "the point of no return" has never been this exciting! Time to step on the throttle! Source: <a href="https://cliply.co">Cliply</a></small>
24+
</center>
25+
26+
### What I've been up to
27+
28+
> **Designing** ⇨ **Drafting** ⇨ **Developing** ⇨ **Debugging** ⇨ **Deploying**
29+
30+
And the cycle contrinues. I guess it sums it all up very nicely. _Can somebody appreciate the alliteration though?_
31+
32+
Here's a gist of what I've achieved so far:
33+
34+
- I've gone through **2** iterations of the design. I'm happy with how the new site looks (and I genuinely hope the design team does too!).
35+
- I've drafted around **5+** writeups dealing with Monorepo Migration, Getting Started guide, Vocabulary Overview and of course these blog posts.
36+
- My branch on the vocabulary repository now has over **50+** commits & over **13,000** lines of code (not that I've written all of them, but you know, just for the stats)
37+
- The first draft of the vocabulary site is now live! I'm expecting a whole bunch of changes still, but here it is if you want to have a sneak peek: [https://cc-vocab-draft.surge.sh](https://cc-vocab-draft.surge.sh)
38+
- I've consumed the [Github API](https://docs.github.com/en/free-pro-team@latest/rest) to get live release history, forks and starrers count. I think it adds a really nice touch to the site in general.
39+
- I've used [surge.sh](https://surge.sh) to deploy the draft site. I believe it's a really simple tool to have your site deployed within seconds!
40+
41+
<center>
42+
<img alt"Github commit gif" src="github.png"/><br>
43+
<small class="muted">My github contribution chart is filling up!</small>
44+
</center>
45+
46+
### What I've learnt
47+
48+
Some say it's hard to learn through virtual internships. Well, let me prove you wrong. Here are my leanings in the past few weeks:
49+
50+
- It's surprising how subjective (& yet objective) designing really is.
51+
- Vue.js is _fantastic_. Maybe I'm a Vue.js fan now. Should I remain loyal to React? I don't know.
52+
- Making a site responsive isn't the _easiest_ of tasks, but it's certainly doable after a lot of stretching & compressing; lets say that.
53+
- "Code formatting is essential" would be an _understatement_ to make.
54+
- Monorepo's have their own pro's and con's. But in our case the con's were negligible, thankfully!
55+
- I'll be following up with some performance & accessibility testing this coming week, so let's see how that plays out!
56+
- A mentor plays a vital role in any project. My mentor `@dhruvkb` has been very supportive and has made sure I stick to my timeline!
57+
58+
### Other community work tidbits
59+
60+
I believe apart from the internship work that I'm engaged in, I should also help around with some community PR work. I've been told I'm always welcome to, which is great!
61+
62+
- I got the opportunity to speak at a CCOS event alongwith fellow speakers [dhruvkb](https://opensource.creativecommons.org/blog/authors/dhruvkb/) & [dhruvi16](https://opensource.creativecommons.org/blog/authors/dhruvi16/). I had a blast talking to budding students from DSC-IIT Surat & DSC-RIT.
63+
- The dark mode (as promised) should be out before my next blog post.
64+
- Deployed the vocabulary storybook on [Chromatic](https://chromatic.com) and compared & contrasted the pros & cons. Snapshot testing in the near future maybe?
65+
- Completed the hacktoberfest challenge.
66+
67+
### Bonus content
68+
Not many of you may know this, but this site uses the [Lektor](https://getlektor.com) CMS. I needed to have it installed on my system (windows 10 OS) to run the code in our site repository.
69+
Lektor suggests running the following code in powershell as an installation step:
70+
```powershell
71+
(new-object net.webclient).DownloadString('https://www.getlektor.com/installer.py') | python
72+
```
73+
74+
I just didn't think this is a very elegant way. Being an ardent [chocolatey.org](chocolatey.org) fan, I just had to have it up on there! Now the installation step for lektor is simply:
75+
76+
```powershell
77+
choco install lektor
78+
```
79+
on the Windows PowerShell!
80+
81+
Have a look at the package here:
82+
83+
[https://chocolatey.org/packages/lektor](https://chocolatey.org/packages/lektor)
84+
85+
<p align="center">
86+
<strong>Thank you for your time! Stay put for the next Vocabulary site update!</strong>
87+
</p>

‎content/blog/entries/cc-vocabulary-docs-updates-2/github.png

37.5 KB
Loading

‎content/blog/entries/cc-vocabulary-docs-updates-2/speed.gif

59.2 KB
Loading

‎content/blog/entries/cc-vocabulary-docs-updates-3/contents.lr

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
2+
title: Vocabulary Site Updates (Part 3/n)
3+
---
4+
categories:
5+
cc-vocabulary
6+
gsod
7+
gsod-2020
8+
---
9+
author: nimishbongale
10+
---
11+
series: gsod-2020-vocabulary-usage-guide
12+
---
13+
pub_date: 2020-11-25
14+
---
15+
body:
16+
Excited to know more about this week's vocabulary site updates? Read on to find out!
17+
18+
## Vocabulary Site Updates (Edition 3/many more to come)
19+
20+
### What I've been up to
21+
22+
<center>
23+
<img alt"Halfway There" src="merged.png"/><br>
24+
<small class="muted">The surreal feeling...</small>
25+
</center>
26+
27+
Merged? Yes. **Merged**. Here's my story!
28+
29+
- After getting a thumbs up from the UX Designer, I put up my [GSoD Website PR](https://github.com/creativecommons/vocabulary/pull/747) for review.
30+
- I was confident there would be changes, and I let them roll in. It's important to note here that what seems perfect to you may not be so to others, and only experience teaches you the right from the wrong.
31+
- There were a few of them, mainly dealing with spacing, textual content and colors. I resolved them as soon as I could.
32+
- [zackkrida](https://opensource.creativecommons.org/blog/authors/zackkrida/) has been kind enough to point and enumerate all of them for me!
33+
- After receiving a final approval from the engineering team, my PR was finally merged!
34+
- The final draft of the vocabulary site is live! It will soon be deployed (on [Netlify](https://netlify,com)) and be made available for public viewing.
35+
- For my readers, here's [exclusive preview](https://cc-vocab-draft.web.app) of the final draft.
36+
- I've tried making it as optimised as possible, but if you have any inputs whatsoever feel free to raise issues over on our [GitHub repository](https://github.com/creativecommons/vocabulary).
37+
- The famed [Lighthouse report](https://developers.google.com/web/tools/lighthouse) suggests that it's a pretty good start! I've also taken care of the [accessibility aspect](https://www.w3.org/standards/webdesign/accessibility) wherever applicable.
38+
39+
<center>
40+
<img alt"Halfway There" src="light.png"/><br>
41+
<small class="muted">Aiming high!</small>
42+
</center>
43+
44+
### What I've learnt
45+
46+
- GSoD isn't just about documentation; there's some serious amount of coding too!
47+
- You don't have to sit and write code for hours together. Take breaks, come back, and the fix will strike you sooner than ever.
48+
- Timelines change; improvisation being an essential aspect of any project!
49+
- [MDX](https://mdxjs.com/) is a neat little format to code in! Documenting code is just so much easier.
50+
- Things become obsolete. Versions become outdated. Code maintaining is therefore, easier said than done!
51+
52+
### Other community work tidbits
53+
54+
Being a part of an open source organisation also means that I must try to bring in contributions from existing & first time contributors. Here's a peek into my efforts for the same:
55+
56+
- The [dark mode PR](https://github.com/creativecommons/vocabulary/pull/806) started off as a hacktoberfest contribution, and it is now complete!
57+
- Created a `/shared` package to house common files between packages (such as the dark & light theme after referring to the [React](https://reactjs.org/) documentation.
58+
- The automated npm [README.md customisation](https://github.com/creativecommons/vocabulary/pull/746) is now up and running. (really had a blast solving that issue!)
59+
- If the snapshot testing stands approved, we'll have it running on chromatic!
60+
- Raised issues to add multiple badges to the root README.md file; namely `maintained with Lerna` & custom badges for package sizes from [packagephobia](https://packagephobia.com/).
61+
62+
<p align="center">
63+
<strong>Thank you for your time! Stay put for the season finale!</strong>
64+
</p>

‎content/blog/entries/cc-vocabulary-docs-updates-3/light.png

19 KB
Loading

‎content/blog/entries/cc-vocabulary-docs-updates-3/merged.png

16.9 KB
Loading

0 commit comments

Comments
 (0)