Skip to content

Commit 99155e9

Browse files
ariessaariessa
committed
Merge remote-tracking branch 'upstream/master'
2 parents d4a7024 + 7921291 commit 99155e9

File tree

8 files changed

+147
-73
lines changed

8 files changed

+147
-73
lines changed

‎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

‎databags/issues.json

+15-28
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
{
22
"issues": [
3+
{
4+
"createdAt": 1597429171,
5+
"labels": [
6+
"Hacktoberfest",
7+
"help wanted",
8+
"\ud83d\udcaa skill: python",
9+
"\ud83d\udee0 goal: fix",
10+
"\ud83e\udd16 aspect: dx"
11+
],
12+
"number": 60,
13+
"repo": "ccos-scripts",
14+
"title": "Code organisation can be improved",
15+
"updatedAt": 1601578230,
16+
"url": "https://github.com/creativecommons/ccos-scripts/issues/60"
17+
},
318
{
419
"createdAt": 1596741568,
520
"labels": [
@@ -303,19 +318,6 @@
303318
"updatedAt": 1601490653,
304319
"url": "https://github.com/creativecommons/creativecommons.github.io-source/issues/159"
305320
},
306-
{
307-
"createdAt": 1579285909,
308-
"labels": [
309-
"Hacktoberfest",
310-
"good first issue",
311-
"help wanted"
312-
],
313-
"number": 405,
314-
"repo": "cccatalog-api",
315-
"title": "Document error schemas",
316-
"updatedAt": 1606390369,
317-
"url": "https://github.com/creativecommons/cccatalog-api/issues/405"
318-
},
319321
{
320322
"createdAt": 1578954773,
321323
"labels": [
@@ -731,21 +733,6 @@
731733
"title": "Improvements to logging",
732734
"updatedAt": 1606560369,
733735
"url": "https://github.com/creativecommons/ccos-scripts/issues/63"
734-
},
735-
{
736-
"createdAt": 1597429171,
737-
"labels": [
738-
"Hacktoberfest",
739-
"help wanted",
740-
"\ud83d\udcaa skill: python",
741-
"\ud83d\udee0 goal: fix",
742-
"\ud83e\udd16 aspect: dx"
743-
],
744-
"number": 60,
745-
"repo": "ccos-scripts",
746-
"title": "Code organisation can be improved",
747-
"updatedAt": 1601578230,
748-
"url": "https://github.com/creativecommons/ccos-scripts/issues/60"
749736
}
750737
]
751738
}

‎databags/repos.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@
646646
"PostgreSQL"
647647
],
648648
"url": "https://github.com/creativecommons/legaldb",
649-
"website": ""
649+
"website": "https://legaldb.creativecommons.org/"
650650
},
651651
{
652652
"created": "2013-10-28T02:42:48",

‎webpack/js/components.js

+38-35
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import VueSelect from 'vue-select';
22
import {Octokit} from '@octokit/rest';
3+
import yaml from 'js-yaml'
34

45
import {hydrateAppWithData} from "./hydration";
56

@@ -98,40 +99,40 @@ export const App = {
9899
:clearable="false"/>
99100
<br/>
100101
<template v-if="filters.aim === 'contribute'">
101-
<label for="skills">
102-
<strong>Skill set*</strong><br/>
103-
Choose up to three skills that you would like to see issues for.
104-
</label>
105-
<VueSelect
106-
v-model="filters.skills"
107-
id="skills"
108-
name="skills"
109-
placeholder="No preference"
110-
:options="options.skills"
111-
:reduce="skill => skill.toLocaleLowerCase()"
112-
:selectable="() => filters.skills.length < 3"
113-
multiple/>
114-
<br/>
115-
<label for="experience">
116-
<strong>Experience</strong><br/>
117-
Is this your first time contributing to CC?
118-
</label>
119-
<VueSelect
120-
v-model="filters.experience"
121-
id="experience"
122-
name="experience"
123-
:options="options.experiences"
124-
label="name"
125-
:reduce="experience => experience.code"
126-
:clearable="false"/>
102+
<label for="skills">
103+
<strong>Skill set*</strong><br/>
104+
Choose up to three skills that you would like to see issues for.
105+
</label>
106+
<VueSelect
107+
v-model="filters.skills"
108+
id="skills"
109+
name="skills"
110+
placeholder="No preference"
111+
:options="options.skills"
112+
:reduce="skill => skill.toLocaleLowerCase()"
113+
:selectable="() => filters.skills.length < 3"
114+
multiple/>
115+
<br/>
116+
<label for="experience">
117+
<strong>Experience</strong><br/>
118+
Is this your first time contributing to CC?
119+
</label>
120+
<VueSelect
121+
v-model="filters.experience"
122+
id="experience"
123+
name="experience"
124+
:options="options.experiences"
125+
label="name"
126+
:reduce="experience => experience.code"
127+
:clearable="false"/>
128+
<p class="disclaimer">
129+
*Not all issues have skills marked on them, especially if they are
130+
simple issues that do not require proficiency in any specific
131+
framework or language. Those issues will not appear when filtering by
132+
skill.
133+
</p>
127134
</template>
128135
</form>
129-
<p class="disclaimer">
130-
*Not all issues have skills marked on them, especially if they are
131-
simple issues that do not require proficiency in any specific
132-
framework or language. Those issues will not appear when filtering by
133-
skill.
134-
</p>
135136
<div v-else>
136137
Loading filters, please wait...
137138
</div>
@@ -236,19 +237,21 @@ export const App = {
236237
},
237238
mounted() {
238239
const BASE_URL = 'https://raw.githubusercontent.com/creativecommons/ccos-scripts/master/normalize_repos'
239-
const FILE_URL = name => `${BASE_URL}/${name}.json`
240+
const FILE_URL = name => `${BASE_URL}/${name}.yml`
240241

241242
this.octokit = new Octokit()
242243
this.loadIssues()
243244

244245
Promise
245246
.all([
246247
fetch(FILE_URL('skills'))
247-
.then(response => response.json()),
248+
.then(response => response.text()),
248249
fetch(FILE_URL('labels'))
249-
.then(response => response.json())
250+
.then(response => response.text())
250251
])
251252
.then(([skillResponse, labelResponse]) => {
253+
skillResponse = yaml.safeLoad(skillResponse)
254+
labelResponse = yaml.safeLoad(labelResponse)
252255
const [skills, categories] = hydrateAppWithData(skillResponse, labelResponse)
253256
this.categories = categories
254257
this.options.skills = skills

‎webpack/package-lock.json

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

‎webpack/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
},
2828
"dependencies": {
2929
"@octokit/rest": "^18.0.6",
30+
"js-yaml": "^3.14.0",
3031
"vue": "^2.6.12",
3132
"vue-select": "^3.10.8"
3233
},

0 commit comments

Comments
 (0)