You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
15
+
Hey 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
16
17
17
## But what is GSoD?
18
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).
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 in by the participating Open Source Organisations. 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
20
21
21
## Vocabulary Site & Usage Guide
22
22
23
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.
24
+
[CC Vocabulary](https://github.com/creativecommons/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
25
26
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.
27
+
Documentation is one of the primary reasons which determines how successful a certain open source library will be. The major question that developers think of while choosing a suitable tech stack to build their applications is:
28
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.
29
+
- Is the library _well documented_?
30
+
- Is it _well maintained_?
31
+
- Does it have some _considerable usage and error support_?”
32
+
33
+
These are exactly the questions I should be asking myself while going about this project idea.
34
+
35
+
As aforementioned, there is an immanent need to have a concise and consolidated documentation. 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
36
31
37
### 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.
38
+
We have decided to move forward 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 in recent times, 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
39
34
40
### 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.
41
+
I have contributed to CC in the past. It would now be my first time contributing to a specific project within CC, while being a member of CC Open Source. Some tasks that I've been able to initiate/accomplish so far:
36
42
43
+
- Look at Open Source documentation conventions, and see if we violate any.
44
+
- Understand the level of existing documentation currently present in our storybooks.
45
+
- Discuss about the Monorepo migration and help out with the implementation.
46
+
- Migrate `storybookjs` to the latest version.
47
+
- Implement `addon-controls` for vocabulary.
48
+
- Design the vocabulary site.
49
+
- Promote the involvement of CC Open Source in [Hacktoberfest](https://hacktoberfest.digitalocean.com/) 2020.
37
50
38
51
### What did I learn?
39
52
53
+
- Design is more than just picking colors and placing components on a grey screen.
54
+
- It's important to read your own writings from an unbiased perspective to actually understand how well it would be perceived.
55
+
- Interacting with your mentor on a regular basis is of the absolute essence.
56
+
- Publishing to [npmjs](npmjs.com) is not difficult!
0 commit comments