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
Copy file name to clipboardExpand all lines: content/blog/entries/cc-vocabulary-docs-updates-closing/contents.lr
+46-24
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ Here's a list of all the weekly goals that I met:
44
44
45
45
**Week 2**
46
46
(09/22 - 09/28)
47
-
- Tackled queries regarding the choice of design, page structure etc., and sought approval from CC’s UX Designer.
47
+
- Tackled queries regarding the choice of design, page structure etc., and sought approval from CC’s UX Designer.
48
48
- Began to write the content which will need to fill up the main landing page.
49
49
50
50
**Week 3**
@@ -74,52 +74,52 @@ Here's a list of all the weekly goals that I met:
74
74
75
75
**Week 8**
76
76
(11/08 - 11/15)
77
-
-Finished writing the Vocabulary usage guide and seek initial approval.
77
+
- Finished writing the Vocabulary usage guide and seek initial approval.
78
78
79
79
**Week 9**
80
80
(11/16 - 11/23)
81
-
-Finalized on the guides and the main page contents.
82
-
-Carried out the necessary landing page to doc integration.
83
-
-Published a sample build using surge for viewing and surveying purposes.
81
+
- Finalized on the guides and the main page contents.
82
+
- Carried out the necessary landing page to doc integration.
83
+
- Published a sample build using surge for viewing and surveying purposes.
84
84
85
85
**Week 10**
86
86
(11/24 - 11/30)
87
-
-Surveyed development builds for Accessibility using WAVE and Accessibility Insights for Web.
88
-
-Surveyed the site for responsiveness using Chrome Dev Tools.
89
-
-Generated Lighthouse reports.
90
-
-Optimised for Search Engines using meta tags and external links.
87
+
- Surveyed development builds for Accessibility using WAVE and Accessibility Insights for Web.
88
+
- Surveyed the site for responsiveness using Chrome Dev Tools.
89
+
- Generated Lighthouse reports.
90
+
- Optimised for Search Engines using meta tags and external links.
91
91
92
92
**Week 11**
93
93
(11/30 - 12/05)
94
94
- Worked towards improving the report statistics until they reach a respectable target.
95
-
-Wrote a blog post summarizing everything, and about my performance cum involvement in CC.
95
+
- Wrote a blog post summarizing everything, and about my performance cum involvement in CC.
96
96
97
97
**Week 12**
98
98
(12/06 - 12/12)
99
-
-Sought daily approvals until everything is finalised.
100
-
-Go through my writings and code upteen times for any miniscule errors.
99
+
- Sought daily approvals until everything is finalised.
100
+
- Go through my writings and code upteen times for any miniscule errors.
101
101
102
102
**Week 13**
103
103
(12/13 - 12/19)
104
-
-Cleaned code, make sure everything is properly linted and ready before the final closing commits.
105
-
-Published the “Concluding Internship” blog post, rounding up my wholesome journey.
106
-
-Sought final closing approval.
104
+
- Cleaned code, make sure everything is properly linted and ready before the final closing commits.
105
+
- Published the “Concluding Internship” blog post, rounding up my wholesome journey.
106
+
- Sought final closing approval.
107
107
108
108
**Post-Internship**
109
-
-Promote the use of CC attributed works.
110
-
-Interact with the community, answer queries or doubts regarding CC.
111
-
-Carry out community work of the repositories I’ve contributed to.
112
-
-Leverage experience gained during this internship for future endeavours.
109
+
- Promote the use of CC attributed works.
110
+
- Interact with the community, answer queries or doubts regarding CC.
111
+
- Carry out community work of the repositories I’ve contributed to.
112
+
- Leverage experience gained during this internship for future endeavours.
113
113
114
114
### The Vocabulary Site
115
115
116
116
Here's the link to [the landing site](https://cc-vocab-draft.web.app).
117
117
118
-
- Went through **3** Design Iterations
118
+
- Went through **3** Design Iterations.
119
119
- Designed the mockups in [Figma](https://figma.com).
120
120
- Wrote the content filling up the landing page.
121
121
- After approval from the UX Designer, waited for an approval from the Frontend Engineer.
122
-
- Sought continuous approval from my mentor
122
+
- Sought continuous approval from my mentor[dhruvkb](https://opensource.creativecommons.org/blog/authors/dhruvkb/).
123
123
- Used [Vue.js](https://vuejs.org) + [CC Vocabulary](https://www.npmjs.com/package/@creativecommons/vocabulary) to build a highly modularised site.
124
124
- Went through a couple of iterations of the website itself.
125
125
- Made about **112** commits (**15,000** lines of code) in my *gsod-nimish* branch.
@@ -142,6 +142,8 @@ Here's the link to [the landing site](https://cc-vocab-draft.web.app).
142
142
143
143
- PR was reviewed and merged on the **25th of November**.
144
144
145
+
Here's how the site looks right now:
146
+
145
147
<pre>
146
148
<center>
147
149
<imgalt"Thefinalwebsite!"src="website.png"/><br>
@@ -169,10 +171,30 @@ Here's the link to the [documentation site](https://cc-vocabulary.netlify.app).
169
171
- Modified the existing overview page.
170
172
- Removed highly verbose sections from the docs.
171
173
- Documented Vocabulary sprint planning workflow.
172
-
-Documents how to use a markdown component with CC Vocabulary
174
+
-Documented how to use a markdown component with CC Vocabulary.
173
175
- Embedded hyperlink to other open source projects to improve SEO.
174
-
- Increased uniformity across documentation present in the storybooks
175
-
- Adds alt descriptions & aria labels for certain images to improve accessibility.
176
+
- Increased uniformity across documentation present in the storybooks.
177
+
- Added alt descriptions & aria labels for certain images to improve accessibility.
178
+
179
+
### My Learnings And Challenges
180
+
181
+
- Design is more than just picking colors and placing components on a grey screen.
182
+
- It's important to read your own writings from an unbiased perspective to actually understand how well it would be perceived.
183
+
- Publishing to npmjs is not difficult!
184
+
- Knowing the previously existing code in your project is of serious essence. It's important to understand the code styles, structure & activity of the code that you are dealing with.
185
+
- Be patient! Its fine to delay something if it makes sense to have it logically accomplished only after certain other tasks are done & dusted with.
186
+
- How essential it is to write neat code is something that's not spoken too often. (I wonder why...)
187
+
- I always thought Vue.js sets up SPA's by default. I'm surprised you need to configure it additionally to do just that!
188
+
- Storybook is just a really nifty OSS with great community support!
189
+
- Vue.js is fantastic. Maybe I'm a Vue.js fan now. Should I remain loyal to React? I don't know.
190
+
- Making a site responsive isn't the easiest of tasks, but it's certainly doable after a lot of stretching & compressing; lets say that.
191
+
- "Code formatting is essential" would be an understatement to make.
192
+
- Monorepo's have their own pro's and con's. But in our case the con's were negligible, thankfully!
193
+
- GSoD isn't just about documentation; there's some serious amount of coding too!
194
+
- You don't have to sit and write code for hours together. Take breaks, come back, and the fix will strike you sooner than ever.
195
+
- Timelines change; improvisation being an essential aspect of any project!
196
+
- MDX is a neat little format to code in! Documenting code is just so much easier.
197
+
- Things become obsolete. Versions become outdated. Code maintaining is therefore, easier said than done!
0 commit comments