Skip to content

Commit f920ca2

Browse files
committed
Add Blog Post Content - 1
1 parent 2c9abe3 commit f920ca2

File tree

3 files changed

+51
-0
lines changed

3 files changed

+51
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
username: nimishbongale
2+
---
3+
name: Nimish Bongale
4+
---
5+
md5_hashed_email: 966c6091b47be539edc00210f36d2f65
6+
---
7+
about:
8+
9+
[Nimish Bongale](https://nimishbongale.github.io/) is a Technical Writing Intern at Creative Commons. He goes by `@nimishnb` on the CC Community Slack workspace. Nimish is currently developing the website and documentation for [CC Vocabulary](https://opensource.creativecommons.org/cc-vocabulary/) as part of [Google Season of Docs 2020](https://developers.google.com/season-of-docs).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
title: Vocabulary Site & Usage Guide Introduction (GSoD'20)
2+
---
3+
categories:
4+
cc-wp-base-theme
5+
gsod
6+
gsod-2020
7+
---
8+
author: nimishbongale
9+
---
10+
series: gsod-2020-vocabulary-usage-guide
11+
---
12+
pub_date: 2020-10-02
13+
---
14+
body:
15+
Hello there! I'm Nimish Bongale, a technical writer & software developer based out of Bangalore, India. My other hobbies include playing chess and the guitar. I look forward to build the CC Vocabulary site and usage guides as a part of GSoD'20.
16+
17+
## But what is GSoD?
18+
19+
GSoD, or Google Season of Docs, is a program that stresses on the importance of the documentation aspect of Open Source projects. It invites technical writers from across the world to submit proposals based on projects floated by the participating Open Source Organisation. The selected technical writers then work with the their respective organisations and look to complete their work by the end of their internship period. More information about the same can be found [here](https://developers.google.com/season-of-docs).
20+
21+
## Vocabulary Site & Usage Guide
22+
23+
### Introduction
24+
CC Vocabulary is a cohesive design system & Vue component library to unify the web-facing Creative Commons. It's currently comprised of 3 packages, namely Vocabulary, Vue-Vocabulary & Fonts. My contribution to this project would majorly involve building the landing site for CC Vocabulary, and writing & improving the documentation wherever necessary.
25+
26+
### What drives me
27+
Documentation is one of the primary reasons that determines how successful a certain open source library will be. The major question which developers think of while choosing a suitable tech stack to build their applications is “Is the library well documented? Is it well maintained? Does it have some considerable usage and error support?”. These are exactly the questions we should be asking ourselves while going about this project idea.
28+
29+
There is an immanent need to have a concise and consolidated documentation for our needs. The lack of documentation hurts the future perspectives of open source applications, and is by far, an essential and non-negligible component. Linking to these documentations should be an appealing home page, which captures the interest of the people in an instant. The documentation should be well organised thereby enabling a seamless flow through it.
30+
31+
### Tech stack of the project
32+
We have decided to move forwad with [Vuejs](https://vuejs.org/) for building the site, and continue work on the existing [storybooks](https://storybook.js.org/) of Vocabulary, Vue-Vocabulary and Fonts. Storybookjs has had some great improvements recently, and the new addons that are offered will greatly support my work. Besides these, I will also be using [StackEdit](https://stackedit.io/) for writing and sharing Markdown files of my writings.
33+
34+
### Progress - Baby Steps
35+
I have contributed to CC in the past before. Now it would be my first time contributing to a specific project, while being a member of CC Open Source.
36+
37+
38+
### What did I learn?
39+
40+
41+
_Thank you for your time!_
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
name: GSOD-2020: Vocabulary Usage Guide

0 commit comments

Comments
 (0)