Skip to content

Commit a4d4410

Browse files
mathemancermathemancer
authored
Merge branch 'master' into dataviz-blog
2 parents 472b3fe + d675386 commit a4d4410

File tree

8 files changed

+106
-55
lines changed

8 files changed

+106
-55
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# These owners will be the default owners for everything in
22
# the repo. Unless a later match takes precedence, they will
33
# be requested for review when someone opens a pull request.
4-
* @creativecommons/engineering @creativecommons/ct-cc-open-source-core-committers
4+
* @creativecommons/engineering @creativecommons/ct-cc-open-source-core-committers @creativecommons/ct-cc-open-source-collaborators
55

66
# These users own any files in the specified directory and
77
# any of its subdirectories.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ name: María Belén Guaranda Cabezas
55
md5_hashed_email: a177edcce952c2c82ac8716a4586a28f
66
---
77
about:
8-
Maria is an undergraduate Computer Science student from ESPOL, in Ecuador. She has worked for the past 2 years as a research assistant. She has worked in projects including computer vision, the estimation of socio-economic indexes through CDRs analysis, and a machine learning model with sensors data. During her spare time, she likes to watch animes and read. She loves sports, especially soccer. She is also committed to environmental causes, and she is a huge fan of cats and dogs (she has 4 and 1 respectively).
8+
Maria is a Bachelor of Computer Science from Ecuador. As a research assistant, she worked in projects including computer vision, the estimation of socio-economic indexes through CDRs analysis, and a machine learning model with sensors data. During her spare time, she likes to watch animes and read. She loves sports, especially soccer. She is also committed to environmental causes, and she is a huge fan of cats and dogs (she has 4 and 1 respectively).
99

10-
Maria is working on [data visualizations of the CC Catalog](https://github.com/creativecommons/cccatalog-dataviz) as part of [Google Summer of Code 2019](/gsoc-2019).
10+
Maria worked in the [data visualizations of the CC Catalog](https://github.com/creativecommons/cccatalog-dataviz) as part of [Google Summer of Code 2019](/gsoc-2019), and is currently a mentor in this year's edition of the program.

‎content/blog/entries/integration-vocabulary-ccos/contents.lr‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
title: Integration of Vocabulary with CCOS.
2+
---
3+
categories:
4+
outreachy
5+
tech
6+
open-source
7+
---
8+
author: dhruvi16
9+
---
10+
series: outreachy-2020-CCOS
11+
---
12+
pub_date: 2020-07-08
13+
---
14+
body:
15+
16+
17+
This blog demonstrates the project I am working on during the course of my Outreachy internship. My project involves redesigning and reimplementing one of the web products of the CC network using our new cohesive design library — [Vocabulary](https://cc-vocabulary.netlify.app/?path=/docs/vocabulary-introduction--page). After my internship is completed, the [Creative Commons Open Source](https://opensource.creativecommons.org/) website will have a complete revamped interface that will extensively use Vocabulary components.
18+
19+
## The Problem -
20+
21+
There exists a large variety of web products across the Creative Commons network. These products serve different purposes for the network and so do they vary in the way of presenting the existing content. So, to conquer the inconsistency across the different products we have our coherent design system called Vocabulary.
22+
23+
If we come to the current CC Open Source website, it is quite off-track considering our new design system Vocabulary. The styles and components of the website are not well aligned with the components of the Vocabulary. And thus it lacks harmony and consistency concerning the brand.
24+
25+
The purpose of a design system gets dissolved if it is not well incorporated with the products and we do have this problem with the CC Open Source website. Hence, there was a need for a redesign of CCOS as per the new Design Library. This project aims to rectify the problems and inconsistencies of the CCOS website and build a completely new website (as per Vocabulary).
26+
27+
## The Solution -
28+
29+
I started with trying out different mock-ups for the new website in Figma. You can see what I tried to make [here](https://www.figma.com/file/ka3zs1iYnqJvyLnvAV3cW7/Home-proposals). And then with the help of our UX designer Francisco, we created all the mock-ups and finalized how the website will look in a couple of weeks, here is the [link](https://www.figma.com/file/mttcugI1UxvCJRKE5sdpbO/Mockups?node-id=759%3A516) for that.
30+
31+
I started my internship with going through the website’s tech stack, the website is made using [Lektor](https://www.getlektor.com/), with which I was not very familiar. I read the official docs, went through projects, tried making demo projects, and took help from mentors wherever I got stuck.
32+
33+
To keep the project clean I added a theme that only has templates for the project and alters no content (as per aim). While updating templates, some components were not available in the Vocabulary yet, so I worked on adding those components to the library. And then used them in my new templates.
34+
35+
I have thoroughly enjoyed contributing to this project as I got to learn so much. And I am excited for what’s next to come in the upcoming weeks.

‎content/blog/entries/legal-database-coding-mid-term/contents.lr‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
title: CC Legal Database: Coding and Mid-term status
2+
---
3+
categories:
4+
cc-legal-database
5+
product
6+
outreachy
7+
---
8+
author: krysal
9+
---
10+
series: outreachy-may-2020-legal-database
11+
---
12+
pub_date: 2020-07-08
13+
---
14+
body:
15+
We are already in the second half of the time stipulated for the project and it is time to pause for review the initial plan, celebrate the objectives achieved and think about what remains to be done.
16+
17+
## Initial plan
18+
19+
Initially, two weeks were allocated to do the redesign for the new site. I thought there would be plenty of time here, _is just design_ I said to myself, despite not having done any serious project in Figma before beyond a few sketches. Later we will see I was wrong here. This included creating new Vocabulary components if necessary. Between the second and third weeks, I would create the data models (for Django and therefore for the database as well) and from the fourth week onwards it would start to implement all this in code: make the Homepage, listing, details pages and the others.
20+
21+
## Issues in the way
22+
23+
One task that took longer than expected was to finish the designs, a key point because the other tasks depended on this. Though the initial scheme was ready on time, as it was discussed with the stakeholders new requirements became evident, so more modifications had to be made. For example, on the [current site](https://labs.creativecommons.org/caselaw/), the way to explore cases and scholarship is by country, and in principle, this would stay the same way and I designed with that in mind, but talking to our internal user (which acts as a _product owner_ here) was better to change this scheme to one for labels or categories that are more related with both entities. Highlighting the case of the Scholarship model, in which the attribute of the country was eliminated because it is not so relevant, and although it seemed somewhat a small thing, this also caused changes in the design of the home page, the listings and how the content of the database will be explored in general. Design for a good user experience is not so easy as a non-designer may think. There were times when there was a lack of ideas but the important thing is to make decisions and move forward, in later iterations it will be improved.
24+
25+
As in all software development, unexpected things happen and errors will appear no matter how much you plan ahead, for the fourth week I had planned to build a continuous integration system to have a server where anyone can see the progress of my changes, however, there were a few inconveniences that had me googling for a couple of days, publishing a Django project in Heroku can be tricky, specially regarding static files (assets like style sheets and scripts) if they are generated by Heroku at some point in the deployment pipeline, depending on the phase in which it is carried out, they can be lost in the ephemeral file system of Heroku, a process that I will not delve into here but that seems important to me to highlight if anyone else has similar problems.
26+
27+
## Progress so far
28+
29+
I have managed to finish the main tasks and I would say that even the initially expected result has been improved. So I can list the following achievements:
30+
- Redesigned the entire website using the Figma Design Library
31+
- Built first pages: Home, listing and details pages for both Cases and Scholarship, and one for the FAQs.
32+
- Create a GitHub Action to lint every PR and check if it follows the project's code style
33+
- Deployment of the Django project on Heroku with a CI process linked to a GitHub repository, see the live development site [here](https://cc-caselaw.herokuapp.com/).
34+
35+
It is said quickly but each task carries its considerable workload. It's been a good result so far, I've learned a lot of things along the way, like basic use of Figma, use of Storybook (related to Vocabulary components), good code security practices, some accessibility details, and more.
36+
37+
## Plan for the second half of the timeline
38+
39+
There are some tasks due from past weeks, such as build forms for Case and Scholarship submissions, but I am confident that now that the project has reached a stable state I can do it quickly in the next days. Other tasks were moved for later: searching records and filtering by tags moved after forms are created, so I can finish the visual parts of the site first and focus on functional work without shifting between types of tasks.
40+
41+
The tasks and they order have changed, like I mentioned earlier, requirements were modified (a bit) so some tasks I planned for last weeks are not necessary anymore or are done already out-of-box with Django admin (benefits of choosing a batteries included framework!). In general, I don't think the initial plan was wrong, we just went through the natural evolution of a product software. Mentors have also been very helpful in keeping a reasonable scope and adjusting priorities.
42+
43+
After main functionalities are done we can start making improvements, as we already identified some nice to have features but not so important at the moment. Stay tuned for more to come.

‎content/blog/series/outreachy-2020-CCOS/contents.lr‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
name: Outreachy May 2020 round: CC Open source

‎databags/community_team_members.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@
6060
"name": "Ayan Choudhary",
6161
"role": "Project Core Committer"
6262
},
63+
{
64+
"name": "Tanuj Agarwal",
65+
"role": "Project Collaborator"
66+
},
6367
{
6468
"name": "Abhishek Naidu",
6569
"role": "Project Member"
@@ -92,6 +96,10 @@
9296
"name": "Dhruv Bhanushali",
9397
"role": "Project Core Committer"
9498
},
99+
{
100+
"name": "Mayank Nader",
101+
"role": "Project Collaborator"
102+
},
95103
{
96104
"name": "Shubham Pandey",
97105
"role": "Project Contributor"
@@ -204,7 +212,7 @@
204212
},
205213
{
206214
"name": "Tanuj Agarwal",
207-
"role": "Project Contributor"
215+
"role": "Project Member"
208216
},
209217
{
210218
"name": "Jahnvi Gupta",

‎databags/repos.json‎

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -103,22 +103,6 @@
103103
"url": "https://github.com/creativecommons/cc-link-checker",
104104
"website": null
105105
},
106-
{
107-
"created": "2019-01-29T21:17:39",
108-
"description": "Temporary microsite for mx.creativecommons.org",
109-
"engineering_project": true,
110-
"featured": false,
111-
"id": 168230429,
112-
"language": null,
113-
"license": {
114-
"name": "MIT License",
115-
"url": "https://github.com/creativecommons/cc-mexico-micro/blob/master/LICENSE"
116-
},
117-
"name": "cc-mexico-micro",
118-
"slack": "",
119-
"url": "https://github.com/creativecommons/cc-mexico-micro",
120-
"website": "https://mx.creativecommons.org/"
121-
},
122106
{
123107
"created": "2014-01-08T18:49:45",
124108
"description": "Collection of resources on CC tools and other open topics",
@@ -314,7 +298,7 @@
314298
"Vue.js"
315299
],
316300
"url": "https://github.com/creativecommons/cccatalog-frontend",
317-
"website": "https://search.creativecommons.org/"
301+
"website": "https://search.creativecommons.org"
318302
},
319303
{
320304
"created": "2014-10-06T22:07:52",
@@ -642,7 +626,7 @@
642626
"id": 47291677,
643627
"language": "HTML",
644628
"license": {
645-
"name": "Creative Commons Zero v1.0 Universal",
629+
"name": "MIT License",
646630
"url": "https://github.com/creativecommons/mp/blob/master/LICENSE"
647631
},
648632
"name": "mp",

‎databags/search_roadmap.json‎

Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"quarters": [
33
{
4-
"name": "Q2 2020",
4+
"name": "Q3 2020",
55
"tasks": [
66
{
77
"description": "Make changes to the search algorithm that incorporate image popularity data gathered from sources that provide it. ",
@@ -12,16 +12,6 @@
1212
"description": "Move our data cleaning code from the ingestion step of the API to the initial data processing step of the Catalog to eliminate unnecessary repetitive data cleaning.",
1313
"gid": "1167425798148805",
1414
"name": "Move data cleaning pipeline from API to Catalog"
15-
}
16-
]
17-
},
18-
{
19-
"name": "Q3 2020",
20-
"tasks": [
21-
{
22-
"description": "Designing and prototyping an upcoming user interface for searching for audio on CC Search.",
23-
"gid": "1163392248010945",
24-
"name": "Design Sprint: Audio UI for CC Search"
2515
},
2616
{
2717
"description": "Manage Catalog deployment and provisioning entirely through infrastructure as code.",
@@ -53,16 +43,16 @@
5343
"gid": "1149385618454685",
5444
"name": "Improved Support Pages"
5545
},
56-
{
57-
"description": "Offline Old Search (oldsearch.creativecommons.org) and redirect traffic to CC Search. Prior to this, build in messaging on Old Search, and support similar functionality on CC Search. See \"Meta Search Integration\" for related work.",
58-
"gid": "1149456632174214",
59-
"name": "Offline old CC Search"
60-
},
6146
{
6247
"description": "Integrating meta search functionality into CC Search for sources that are not currently indexed, and content types we do not currently support.",
6348
"gid": "1174575887784290",
6449
"name": "Design Sprint: Meta Search Integration"
6550
},
51+
{
52+
"description": "Offline Old Search (oldsearch.creativecommons.org) and redirect traffic to CC Search. Prior to this, build in messaging on Old Search, and support similar functionality on CC Search. See \"Meta Search Integration\" for related work.",
53+
"gid": "1149456632174214",
54+
"name": "Offline old CC Search"
55+
},
6656
{
6757
"description": "Make accessibility improvements to the UI.",
6858
"gid": "1171784517466065",
@@ -73,16 +63,16 @@
7363
"gid": "1149456632174198",
7464
"name": "Internationalization Infrastructure"
7565
},
66+
{
67+
"description": "Designing and prototyping an upcoming user interface for searching for audio on CC Search.",
68+
"gid": "1163392248010945",
69+
"name": "Design Sprint: Audio UI for CC Search"
70+
},
7671
{
7772
"description": "Design and user test UIs for audio. Ingest a pilot collection of audio to the Catalog, build support in the API. Integrate design to frontend to allow users to search for CC licensed audio.",
7873
"gid": "1171015130050099",
7974
"name": "Audio Support and Integration"
8075
},
81-
{
82-
"description": "Develop metrics for and select a set of ~100 million high quality images for which we'll generate additional metadata through AWS Rekognition.",
83-
"gid": "1154270978154715",
84-
"name": "Image Selection for Rekognition [AWS Grant]"
85-
},
8676
{
8777
"description": "Update our Common Crawl provider infrastructure to:\n(1) use Apache Airflow instead of AWS tools like Data Pipeline & Glue for processing data\n(2) unify provider processing to use the same base classes as API providers",
8878
"gid": "1167425798148813",
@@ -94,14 +84,9 @@
9484
"name": "Use Data Dumps for Wikimedia Ingestion"
9585
},
9686
{
97-
"description": "Plan for potential integration of OER into CC Search through research and consideration of potential issues.",
98-
"gid": "1147157859839985",
99-
"name": "OER Planning"
100-
},
101-
{
102-
"description": "Research, mock up, and user test potential integrations for Web Monetization into CC Search and other CC web properties.",
87+
"description": "Research and test potential integrations for Web Monetization into CC Search and other CC web properties.",
10388
"gid": "1153114910798067",
104-
"name": "Web Monetization: Research Phase"
89+
"name": "Web Monetization: Phase 1"
10590
},
10691
{
10792
"description": "Build a UI for the Catalog API, where users can sign up, manage access, see usage metrics and statistics.",
@@ -173,11 +158,6 @@
173158
"gid": "1168725971351188",
174159
"name": "CC Search HTML Embed"
175160
},
176-
{
177-
"description": "Do a pilot integration of text-based content that is considered educational. Requires selection of source, Catalog and API structuring, frontend designs and integration.",
178-
"gid": "1144967092198600",
179-
"name": "Text Support and Integration"
180-
},
181161
{
182162
"description": "Plan out the usage of scraping ccREL metadata from the internet to index new content into the CC Catalog.",
183163
"gid": "1164969092703371",

0 commit comments

Comments
 (0)