Skip to content

Commit 7344000

Browse files
authored
Merge pull request creativecommons#567 from nimishbongale/master
Update final report to adhere to GSoD work report guidelines
2 parents 7a2b90a + 4b4b18c commit 7344000

File tree

1 file changed

+46
-24
lines changed
  • content/blog/entries/cc-vocabulary-docs-updates-closing

1 file changed

+46
-24
lines changed

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

+46-24
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Here's a list of all the weekly goals that I met:
4444

4545
**Week 2**
4646
(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.
4848
- Began to write the content which will need to fill up the main landing page.
4949

5050
**Week 3**
@@ -74,52 +74,52 @@ Here's a list of all the weekly goals that I met:
7474

7575
**Week 8**
7676
(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.
7878

7979
**Week 9**
8080
(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.
8484

8585
**Week 10**
8686
(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.
9191

9292
**Week 11**
9393
(11/30 - 12/05)
9494
- 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.
9696

9797
**Week 12**
9898
(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.
101101

102102
**Week 13**
103103
(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.
107107

108108
**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.
113113

114114
### The Vocabulary Site
115115

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

118-
- Went through **3** Design Iterations
118+
- 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.
122-
- Sought continuous approval from my mentor
122+
- Sought continuous approval from my mentor [dhruvkb](https://opensource.creativecommons.org/blog/authors/dhruvkb/).
123123
- 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.
@@ -142,6 +142,8 @@ Here's the link to [the landing site](https://cc-vocab-draft.web.app).
142142

143143
- PR was reviewed and merged on the **25th of November**.
144144

145+
Here's how the site looks right now:
146+
145147
<pre>
146148
<center>
147149
<img alt"The final website!" src="website.png"/><br>
@@ -169,10 +171,30 @@ Here's the link to the [documentation site](https://cc-vocabulary.netlify.app).
169171
- Modified the existing overview page.
170172
- Removed highly verbose sections from the docs.
171173
- 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.
173175
- 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!
176198

177199
### Issues & PR's raised during GSoD period
178200

0 commit comments

Comments
 (0)