Skip to content

Commit 01eb8b2

Browse files
authored
Merge branch 'master' into open-graph-image-generation
2 parents 22a7d69 + 126accf commit 01eb8b2

File tree

23 files changed

+829
-232
lines changed

23 files changed

+829
-232
lines changed

content/blog/authors/krysal/contents.lr

Lines changed: 1 addition & 1 deletion
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.
Lines changed: 87 additions & 0 deletions
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>
Loading
Loading
Lines changed: 64 additions & 0 deletions
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>
Loading
Loading
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
title: Presenting CC Base docs - A WordPress Base Theme Usage Guide for the CC Base Theme
2+
---
3+
categories:
4+
cc-wp-base-theme
5+
gsod
6+
gsod-2020
7+
---
8+
author: JackieBinya
9+
---
10+
series: gsod-2020-wordpress-base-theme-usage-guide
11+
---
12+
pub_date: 2020-11-27
13+
---
14+
body:
15+
16+
We are live 🎉
17+
18+
The CC Base documentation is live and its available on this [link](https://cc-wp-theme-base.netlify.app/).
19+
20+
The docs were successfully migrated from Google Docs to the site! One of the most notable changes in the theme and consequently reflected in the documentation is the product name change. The CC WP Theme Base has been renamed to CC Base.
21+
22+
But the old adage says good documentation is never complete, we hope to engage the Creative Commons Community and perform usability tests. Any feed back gathered from the usability tests will then be used to further improve the CC Base docs.
23+
24+
25+
In future iterations of the docs development we hope to include the following features:
26+
- Increase the quantity of illustrative media so as to make the docs more intuitive this will be marked by adding video tutorials on how to use certain features of the CC Base theme and also adding illustrative tree diagrams to explain hierarchy of key directories and files in the CC Base project structure.
27+
- Integration of [Algolia](https://www.algolia.com/) a software tool used to power search functionality in static generated sites.
28+
- We also hope to improve SEO for the site.
29+
30+
All the above mentioned improvements are geared at improving the overall user experience of the docs as well as ensure faster onboarding for our community members to get started on using the CC Base theme.
31+
32+
In conclusion I would like to thank all members of the Creative Commons engineering team, with special mention to Hugo Solar and Kriti Godey. Thank you for your guidance and faith in my abilities as a technical writer and software developer.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
title: Finish GSoD Tasks and Explore CC Catalog Documentation
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-11-20
16+
---
17+
body:
18+
19+
Today marks my fifth blog entry on Creative Commons.
20+
For week 9 and 10, I explored CC Catalog documentation and began improving the documentation by removing keys and generalizing instructions.
21+
22+
### Week 9
23+
24+
I had completed all GSoD tasks by week 9.
25+
So, I took a couple of days off and fixed last week's PR.
26+
Kriti assigned me with new tasks, which is to port CC Catalog documentation from the internal wiki into GitHub repository.
27+
Brent, the CC Catalog maintainer explained to me about what needs to be done.
28+
29+
### Week 10
30+
31+
For week 10, I started exploring CC Catalog and its documentation.
32+
Reminds me a lot about the first and second weeks of GSoD.
33+
Trying to understand new stuff and having an "aha" moment when the dots finally connect.
34+
I started to move the documentation from the internal wiki to CC Catalog’s GitHub repository.
35+
I also wrote and published this blog post.
36+
37+
----
38+
39+
End of blog entry.
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/legal-database-a-new-beginning/contents.lr

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ It has only been a week so we're just starting, so next task to do sooner are:
5353
### How you can help
5454

5555
We are still discussing the new image before start coding so these are some options if you want to get involved:
56-
- Suggest improvements to designs/UX or new features joining the discussion on the [`#cc-dev-legal-database`](https://creativecommons.slack.com/channels/cc-dev-legal-database) Slack channel or on the [github](https://github.com/creativecommons/caselaw) project.
56+
- Suggest improvements to designs/UX or new features joining the discussion on the [`#cc-dev-legal-database`](https://creativecommons.slack.com/channels/cc-dev-legal-database) Slack channel or on the [github](https://github.com/creativecommons/legaldb) project.
5757
- Contribute directly to the CC's Vocabulary design system on [github](https://github.com/creativecommons/vocabulary).
5858
- Submit a case or a scholarship related to CC licenses on the [current site](https://labs.creativecommons.org/caselaw/contribute/).
5959

6060
**CC Legal Database** is my Outreachy project for this summer, under the guidance of Director of Engineering [Kriti Godey](https://creativecommons.org/author/kriticreativecommons-org/) and Core Systems Manager [Timid Robot Zehta](https://creativecommons.org/author/timidcreativecommons-org/), they are very supportive and the CC community is notable welcoming.
6161

62-
This is the first post of a series so stay tuned if you're interested to know more.
62+
This is the first post of a series so stay tuned if you're interested to know more.

content/blog/entries/legal-database-features/contents.lr

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ While developing the mentioned functionalities I was also in charge of adding au
3939
<figcaption>Example of page obtained when requesting a case detail that is not published or doesn't exist.</figcaption>
4040
</figure>
4141

42-
In this process of adding automated tests I wanted them to run on every pull request created, so I learned how to write a GitHub Action with a PostgreSQL service, the DBMS used in this case. Previously, I had already created a job for linting, so I needed to add another one to run in parallel to save time. This service provided by GitHub is pretty cool and useful, it opens up a world of possibilities, from running third party services like [Lighthouse test](https://github.com/GoogleChrome/lighthouse-ci) to even [send tweets](https://github.com/gr2m/twitter-together)! If you want to see the GitHub Action file configurated for this project, check it out: [`.github/workflows/main.yml`](https://github.com/creativecommons/caselaw/blob/31c3002a7860d78f3fdb464150c5c1b2f8bb86fc/.github/workflows/main.yml).
42+
In this process of adding automated tests I wanted them to run on every pull request created, so I learned how to write a GitHub Action with a PostgreSQL service, the DBMS used in this case. Previously, I had already created a job for linting, so I needed to add another one to run in parallel to save time. This service provided by GitHub is pretty cool and useful, it opens up a world of possibilities, from running third party services like [Lighthouse test](https://github.com/GoogleChrome/lighthouse-ci) to even [send tweets](https://github.com/gr2m/twitter-together)! If you want to see the GitHub Action file configurated for this project, check it out: [`.github/workflows/main.yml`](https://github.com/creativecommons/legaldb/blob/31c3002a7860d78f3fdb464150c5c1b2f8bb86fc/.github/workflows/main.yml).
4343

4444
### Accessibility
4545

@@ -67,4 +67,4 @@ Some other features were implemented but only relevant to our registered users,
6767

6868
After reviewing all done this last month I see significant progress has been made, I have learned many things along the way: more of what Django and its ecosystem offers, about accessibility, continuous integration in Heroku and GitHub, and more. One of the things that makes me most happy is being able to be contributing and being part of an Open Source organization, knowing how it moves and works inside, something I never imagine before.
6969

70-
Time flies and there are less than two weeks left to finish, so if you want to follow the project here is the repository to suggest improvements or report bugs, or if you prefer something less technical you can join us on the [slack channel](https://creativecommons.slack.com/channels/cc-dev-legal-database).
70+
Time flies and there are less than two weeks left to finish, so if you want to follow the project here is the repository to suggest improvements or report bugs, or if you prefer something less technical you can join us on the [slack channel](https://creativecommons.slack.com/channels/cc-dev-legal-database).
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
title: Restructure README and Add Documentation Guidelines
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-11-5
16+
---
17+
body:
18+
19+
This is my fourth blog entry on Creative Commons.
20+
For week 7 and 8, I restructured the file README to be more digestible to new users and created Documentation Guidelines for CC Catalog API documentation.
21+
22+
### Week 7
23+
For this week, I restructured the file README in CC Catalog API repository.
24+
I added a step by step guide on how to run the server locally.
25+
I hope new users will be less intimidated to contribute to this project with the updated guide on how to run the server locally.
26+
27+
### Week 8
28+
29+
For week 8, I created Documentation Guidelines which provides steps on how to contribute to CC Catalog API documentation, documentation styles, and cheat sheet for drf-yasg.
30+
I also wrote and published this blog post.
31+
32+
----
33+
34+
Finis.

0 commit comments

Comments
 (0)