Skip to content

Commit 44e2f7f

Browse files
committed
Updated to table, fix images
1 parent 5be5423 commit 44e2f7f

File tree

1 file changed

+131
-51
lines changed
  • content/blog/entries/cc-vocabulary-docs-updates-closing

1 file changed

+131
-51
lines changed

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

Lines changed: 131 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -113,50 +113,59 @@ Here's a list of all the weekly goals that I met:
113113

114114
### The Vocabulary Site
115115

116-
Link to [the landing site](https://cc-vocab-draft.web.app)
116+
Here's the link to [the landing site](https://cc-vocab-draft.web.app).
117117

118118
- Went through **3** Design Iterations
119119
- Designed the mockups in [Figma](https://figma.com).
120120
- Wrote the content filling up the landing page.
121121
- After approval from the UX Designer, waited for an approval from the Frontend Engineer.
122122
- Sought continuous approval from my mentor
123-
- Used [Vuejs](https://vuejs.org) + [CC Vocabulary](https://www.npmjs.com/package/@creativecommons/vocabulary) to build a highly modularised site.
123+
- Used [Vue.js](https://vuejs.org) + [CC Vocabulary](https://www.npmjs.com/package/@creativecommons/vocabulary) to build a highly modularised site.
124124
- Went through a couple of iterations of the website itself.
125125
- Made about **112** commits (**15,000** lines of code) in my *gsod-nimish* branch.
126126

127+
<pre>
127128
<center>
128129
<img alt"Contributions to CC" src="github.png"/><br>
129-
<small class="muted">All my contributions to Creative Commons</small>
130+
<small class="muted">All my contributions to Creative Commons!</small>
130131
</center>
132+
</pre>
131133

132134
- Used Github API to display repository statistics.
133135

136+
<pre>
134137
<center>
135138
<img alt"Fetch stats from Github API" src="stats.png"/><br>
136-
<small class="muted">All my contributions to Creative Commons</small>
139+
<small class="muted">Fetching dynamic stats from the GitHub API</small>
137140
</center>
141+
</pre>
138142

139143
- PR was reviewed and merged on the **25th of November**.
140144

145+
<pre>
141146
<center>
142147
<img alt"The final website!" src="website.png"/><br>
143148
<small class="muted">Snapshot of the final website!</small>
144149
</center>
150+
</pre>
145151

146152
- Used [surge](https://surge.sh) & [firebase](https://web.app) for draft deploys.
147153
- Carried out [lighthouse](https://developers.google.com/web/tools/lighthouse) testing.
148154

155+
<pre>
149156
<center>
150157
<img alt="Lighthouse reports" src="light.png"/><br>
151158
<small class="muted">Lighthouse reports for our live site</small>
152159
</center>
160+
</pre>
153161

154162
- Prompted changes to improve accessibility, SEO and PWA characteristics.
155163

156164
### Core Documentation
157165

158-
Link to the [documentation site](https://cc-vocabulary.netlify.app)
166+
Here's the link to the [documentation site](https://cc-vocabulary.netlify.app).
159167

168+
- Used [StorybookJS](https://storybook.js.org/).
160169
- Modified the existing overview page.
161170
- Removed highly verbose sections from the docs.
162171
- Documented Vocabulary sprint planning workflow.
@@ -167,70 +176,141 @@ Link to the [documentation site](https://cc-vocabulary.netlify.app)
167176

168177
### Issues & PR's raised during GSoD period
169178

170-
On the [creativecommons/vocabulary](https://github.com/creativecommons/vocabulary)
171-
172-
- https://github.com/creativecommons/vocabulary/pull/747 - GSoD Vocabulary Landing Page
173-
179+
<table>
180+
<thead>
181+
<tr>
182+
<th>Repository</th>
183+
<th>Contribution</th>
184+
<th>Relevant links</th>
185+
</tr>
186+
</thead>
187+
<tbody>
188+
<tr>
189+
<td rowspan=14><a href="https://github.com/creativecommons/vocabulary">@creativecommons/vocabulary</a></td>
190+
<td>Developed the CC Vocabulary Landing Page</td>
191+
<td><a href="https://github.com/creativecommons/vocabulary/pull/747">https://github.com/creativecommons/vocabulary/pull/747<br><a href="https://cc-vocab-draft.web.app">https://cc-vocab-draft.web.app</a></td>
192+
</tr>
193+
<tr>
194+
<td>Implemented dark mode for our storybooks</td>
195+
<td><a href="https://github.com/creativecommons/vocabulary/pull/806">https://github.com/creativecommons/vocabulary/pull/806</a><br><a href="https://cc-vocabulary.netlify.app">https://cc-vocabulary.netlify.app</a></td>
196+
</tr>
197+
<tr>
198+
<td>Carried out a monorepo wide documentation revamp</td>
199+
<td><a href="https://github.com/creativecommons/vocabulary/pull/813">https://github.com/creativecommons/vocabulary/pull/813</a></td>
200+
</tr>
201+
<tr>
202+
<td>Wrote the Monorepo Documentation Story</td>
203+
<td><a href="https://github.com/creativecommons/vocabulary/pull/785">https://github.com/creativecommons/vocabulary/pull/785</a><br><a href="https://cc-vocabulary.netlify.app/?path=/docs/vocabulary-structure--page#why-is-vocabulary-a-monorepo">https://cc-vocabulary.netlify.app/?path=/docs/vocabulary-structure--page#why-is-vocabulary-a-monorepo</a></td>
204+
</tr>
205+
<tr>
206+
<td>Wrote the Grid Documentation Story</td>
207+
<td><a href="https://github.com/creativecommons/vocabulary/pull/802">https://github.com/creativecommons/vocabulary/pull/802</a><br><a href="https://cc-vocabulary.netlify.app/?path=/docs/layouts-grid--fullhd#grid-system">https://cc-vocabulary.netlify.app/?path=/docs/layouts-grid--fullhd#grid-system</a></td>
208+
</tr>
209+
<tr>
210+
<td>Wrote the "Getting Started" Usage Guide</td>
211+
<td><a href="https://github.com/creativecommons/vocabulary/pull/774">https://github.com/creativecommons/vocabulary/pull/774</a><br><a href="https://cc-vocabulary.netlify.app/?path=/story/vocabulary-getting-started--page#getting-started">https://cc-vocabulary.netlify.app/?path=/story/vocabulary-getting-started--page#getting-started</a></td>
212+
</tr>
213+
<tr>
214+
<td>Added a CHANGELOG.md to adhere to OSS conventions</td>
215+
<td><a href=https://github.com/creativecommons/vocabulary/pull/671">https://github.com/creativecommons/vocabulary/pull/671</a><br><a href="https://github.com/creativecommons/vocabulary/blob/master/CHANGELOG.md">https://github.com/creativecommons/vocabulary/blob/master/CHANGELOG.md</a></td>
216+
</tr>
217+
<tr>
218+
<td>Unified README.md and updated monorepo build process</td>
219+
<td><a href="https://github.com/creativecommons/vocabulary/pull/649">https://github.com/creativecommons/vocabulary/pull/649</a><br><a href="https://www.npmjs.com/package/@creativecommons/vocabulary">https://www.npmjs.com/package/@creativecommons/vocabulary</a><br><a href="https://www.npmjs.com/package/@creativecommons/fonts">https://www.npmjs.com/package/@creativecommons/fonts</a><br><a href="https://www.npmjs.com/package/@creativecommons/vue-vocabulary">https://www.npmjs.com/package/@creativecommons/vue-vocabulary</a></td>
220+
</tr>
221+
<tr>
222+
<td>Configured GitHub native dependabot</td>
223+
<td><a href="https://github.com/creativecommons/vocabulary/pull/452">https://github.com/creativecommons/vocabulary/pull/452</a></td>
224+
</tr>
225+
<tr>
226+
<td>Added phone screen backgrounds</td>
227+
<td><a href="https://github.com/creativecommons/vocabulary/pull/445">https://github.com/creativecommons/vocabulary/pull/445</a></td>
228+
</tr>
229+
<tr>
230+
<td>Introduce Snapshot Testing to Vocabulary using Chromatic</td>
231+
<td><a href="https://github.com/creativecommons/vocabulary/issues/735">https://github.com/creativecommons/vocabulary/issues/735</a></td>
232+
</tr>
233+
<tr>
234+
<td>Add a maintained with Lerna badge</td>
235+
<td><a href="https://github.com/creativecommons/vocabulary/issues/807">https://github.com/creativecommons/vocabulary/issues/807</a><br><a href="https://github.com/creativecommons/vocabulary/blob/master/README.md">https://github.com/creativecommons/vocabulary/blob/master/README.md</a></td>
236+
</tr>
237+
<tr>
238+
<td>Add new install size badges for our packages</td>
239+
<td><a href="https://github.com/creativecommons/vocabulary/issues/776">https://github.com/creativecommons/vocabulary/issues/776</a><br><a href="https://github.com/creativecommons/vocabulary/blob/master/README.md">https://github.com/creativecommons/vocabulary/blob/master/README.md</a</td>
240+
</tr>
241+
<tr>
242+
<td>Customise individual README's for our packages</td>
243+
<td><a href="https://github.com/creativecommons/vocabulary/issues/736">https://github.com/creativecommons/vocabulary/issues/736</a></td>
244+
</tr>
245+
<tr>
246+
<td rowspan=5><a href="https://github.com/creativecommons/creativecommons.github.io-source">@creativecommons/creativecommons.github.io-source</a></td>
247+
<td>Introductory First Blog Post</td>
248+
<td><a href="https://github.com/creativecommons/creativecommons.github.io-source/pull/530">https://github.com/creativecommons/creativecommons.github.io-source/pull/530</a><br><a href="https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-intro/">https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-intro/</a></td>
249+
</tr>
250+
<tr>
251+
<td>Vocabulary Site Update v1</td>
252+
<td><a href="https://github.com/creativecommons/creativecommons.github.io-source/pull/549">https://github.com/creativecommons/creativecommons.github.io-source/pull/549</a><br><a href="https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-updates-1/">https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-updates-1/</a></td>
253+
</tr>
254+
<tr>
255+
<td>Vocabulary Mid Internship Update v2</td>
256+
<td><a href="https://github.com/creativecommons/creativecommons.github.io-source/pull/555">https://github.com/creativecommons/creativecommons.github.io-source/pull/555</a><br><a href="https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-updates-2/">https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-updates-2/</a></td>
257+
</tr>
258+
<tr>
259+
<td>Vocabulary Site Update v3</td>
260+
<td><a href="https://github.com/creativecommons/creativecommons.github.io-source/pull/561">https://github.com/creativecommons/creativecommons.github.io-source/pull/561</a><br><a href="https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-updates-3/">https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-updates-3/</a></td>
261+
</tr>
262+
<tr>
263+
<td>Vocabulary Site Final Update</td>
264+
<td><a href="https://github.com/creativecommons/creativecommons.github.io-source/pull/564">https://github.com/creativecommons/creativecommons.github.io-source/pull/564</a><br><a href="/">https://opensource.creativecommons.org/blog/entries/cc-vocabulary-docs-updates-closing/</a></td>
265+
</tr>
266+
<tr>
267+
<td><a href="https://github.com/creativecommons/cccatalog-api">@creativecommons/cccatalog-api</a></td>
268+
<td>Configured GitHub native dependabot</td>
269+
<td><a href="https://github.com/creativecommons/cccatalog-api/pull/53">https://github.com/creativecommons/cccatalog-api/pull/53</a></td>
270+
</tr>
271+
<tr>
272+
<td><a href="https://github.com/creativecommons/ccos-scripts">@creativecommons/ccos-scripts</a></td>
273+
<td>Fix file extension in README.md docs</td>
274+
<td><a href="https://github.com/creativecommons/ccos-scripts/pull/100">https://github.com/creativecommons/ccos-scripts/pull/100</a></td>
275+
</tr>
276+
</tbody>
277+
</table>
278+
279+
Follow along my complete GSoD journey through [these series of posts](https://opensource.creativecommons.org/blog/series/gsod-2020-vocabulary-usage-guide/).
280+
281+
### Memorable Milestones Screenshots
282+
283+
<pre>
174284
<center>
175285
<img alt"Merged!" src="merged747.png"/><br>
176286
<small class="muted">GSoD PR merged!</small>
177287
</center>
178-
179-
- https://github.com/creativecommons/vocabulary/pull/813 - Documentation revamp
180-
- https://github.com/creativecommons/vocabulary/pull/806 - Dark mode for our storybooks
181-
288+
</pre>
289+
<br>
290+
<pre>
182291
<center>
183292
<img alt"Dark Mode" src="darkmode.png"/><br>
184-
<small class="muted">Behold, the dark theme!</small>
293+
<small class="muted">Behold the dark theme!</small>
185294
</center>
186-
187-
- https://github.com/creativecommons/vocabulary/pull/802 - [Grid Documentation Story](https://cc-vocabulary.netlify.app/?path=/docs/layouts-grid--fullhd#grid-system)
188-
295+
</pre>
296+
<br>
297+
<pre>
189298
<center>
190299
<img alt"Grid Docs" src="grid.png"/><br>
191300
<small class="muted">Grid Documenation Story</small>
192301
</center>
193-
194-
- https://github.com/creativecommons/vocabulary/pull/785 - [Monorepo Document Story](https://cc-vocabulary.netlify.app/?path=/docs/vocabulary-structure--page#why-is-vocabulary-a-monorepo)
195-
302+
</pre>
303+
<br>
304+
<pre>
196305
<center>
197306
<img alt"Monorepo Document Story" src="structure.png"/><br>
198307
<small class="muted">Monorepo Structure Story</small>
199308
</center>
200-
201-
- https://github.com/creativecommons/vocabulary/pull/774 - [Getting Started Story](https://cc-vocabulary.netlify.app/?path=/story/vocabulary-getting-started--page#getting-started)
202-
203-
- https://github.com/creativecommons/vocabulary/pull/734 - README.md customisation
204-
- https://github.com/creativecommons/vocabulary/pull/671 - Add a CHANGELOG.md to fit conventions
205-
- https://github.com/creativecommons/vocabulary/pull/649 - Unified README.md and updated build process
206-
- https://github.com/creativecommons/vocabulary/pull/452 - Configured native dependabot
207-
- https://github.com/creativecommons/vocabulary/pull/445 - Phone Screen backgrounds
208-
- https://github.com/creativecommons/vocabulary/issues/757 - Snapshot testing on Vocabulary
209-
- https://github.com/creativecommons/vocabulary/issues/735 - Document Component Capable of rendering markdown
210-
- https://github.com/creativecommons/vocabulary/issues/807 - Add a Maintained with lerna badge to README.md
211-
- https://github.com/creativecommons/vocabulary/issues/776 - Add a new Install size badge
212-
- https://github.com/creativecommons/vocabulary/issues/736 - Customize npm README.md for individual packages
213-
214-
215-
On the [creativecommons/creativecommons.github.io-source](https://github.com/creativecommons/creativecommons.github.io-source) repository:
216-
- https://github.com/creativecommons/creativecommons.github.io-source/pull/530 - Introductory first blog post
217-
- https://github.com/creativecommons/creativecommons.github.io-source/pull/549 - Vocabulary Site Update v1
218-
- https://github.com/creativecommons/creativecommons.github.io-source/pull/555 - Vocabulary Site Mid-Internship Update v2
219-
- https://github.com/creativecommons/creativecommons.github.io-source/pull/561 - Vocabulary Site Update v3
220-
221-
On the [creativecommons/ccos-scripts](https://github.com/creativecommons/ccos-scripts) repository:
222-
223-
- https://github.com/creativecommons/ccos-scripts/pull/100 - Fix file extension in README.md
224-
225-
On the [creativecommons/cccatalog-api](https://github.com/creativecommons/cccatalog-api) repository:
226-
227-
- https://github.com/creativecommons/cccatalog-api/pull/533 - Configured Dependabot
228-
229-
Follow along my full GSoD journey through [these series of posts](https://opensource.creativecommons.org/blog/series/gsod-2020-vocabulary-usage-guide/).
309+
</pre>
230310

231311
### Conclusion
232312

233-
My GSoD period has been by far, a very successful and a fruitful one. I thank the the GSoD team for all their efforts in oragnising it this year. I would also like to thank the entire Creative Commons team for all their motivation and support. The onboarding & see-off was very smooth indeed!
313+
My GSoD internship has been by far, a very successful and a fruitful one. I thank the the GSoD team for all their efforts in oragnising it this year. I would also like to thank the entire Creative Commons team for all their motivation and support. The onboarding & see-off was very smooth indeed!
234314

235315
<p align="center">
236316
<strong>Thank you for all your time! This was the final blog post under the Vocabulary docs series. I'll be around for times to come, but until then, sayonara!</strong>

0 commit comments

Comments
 (0)