Skip to content

Commit 9659475

Browse files
committed
Synchronized build
1 parent 9dfeb71 commit 9659475

File tree

2 files changed

+52
-12
lines changed

2 files changed

+52
-12
lines changed

blog/entries/cc-vocabulary-docs-updates-closing/index.html

+26-6
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ <h3 id="proposed-improvised-timelines-deliverables">Proposed &amp; Improvised Ti
316316
<p><strong>Week 2</strong>
317317
(09/22 - 09/28)</p>
318318
<ul>
319-
<li>Tackled queries regarding the choice of design, page structure etc. , and sought approval from CC’s UX Designer.</li>
319+
<li>Tackled queries regarding the choice of design, page structure etc., and sought approval from CC’s UX Designer.</li>
320320
<li>Began to write the content which will need to fill up the main landing page.</li>
321321
</ul>
322322
<p><strong>Week 3</strong>
@@ -397,11 +397,11 @@ <h3 id="proposed-improvised-timelines-deliverables">Proposed &amp; Improvised Ti
397397
</ul>
398398
<h3 id="the-vocabulary-site">The Vocabulary Site</h3><p>Here's the link to <a href="https://cc-vocab-draft.web.app">the landing site</a>.</p>
399399
<ul>
400-
<li>Went through <strong>3</strong> Design Iterations</li>
400+
<li>Went through <strong>3</strong> Design Iterations.</li>
401401
<li>Designed the mockups in <a href="https://figma.com">Figma</a>.</li>
402402
<li>Wrote the content filling up the landing page.</li>
403403
<li>After approval from the UX Designer, waited for an approval from the Frontend Engineer.</li>
404-
<li>Sought continuous approval from my mentor</li>
404+
<li>Sought continuous approval from my mentor <a href="https://opensource.creativecommons.org/blog/authors/dhruvkb/">dhruvkb</a>.</li>
405405
<li>Used <a href="https://vuejs.org">Vue.js</a> + <a href="https://www.npmjs.com/package/@creativecommons/vocabulary">CC Vocabulary</a> to build a highly modularised site.</li>
406406
<li>Went through a couple of iterations of the website itself.</li>
407407
<li>Made about <strong>112</strong> commits (<strong>15,000</strong> lines of code) in my <em>gsod-nimish</em> branch.</li>
@@ -422,6 +422,7 @@ <h3 id="the-vocabulary-site">The Vocabulary Site</h3><p>Here's the link to <a hr
422422
</pre><ul>
423423
<li>PR was reviewed and merged on the <strong>25th of November</strong>.</li>
424424
</ul>
425+
<p>Here's how the site looks right now:</p>
425426
<pre>
426427
<center>
427428
<img alt"The final website!" src="website.png"/><br>
@@ -445,10 +446,29 @@ <h3 id="core-documentation">Core Documentation</h3><p>Here's the link to the <a
445446
<li>Modified the existing overview page.</li>
446447
<li>Removed highly verbose sections from the docs. </li>
447448
<li>Documented Vocabulary sprint planning workflow.</li>
448-
<li>Documents how to use a markdown component with CC Vocabulary</li>
449+
<li>Documented how to use a markdown component with CC Vocabulary.</li>
449450
<li>Embedded hyperlink to other open source projects to improve SEO.</li>
450-
<li>Increased uniformity across documentation present in the storybooks</li>
451-
<li>Adds alt descriptions &amp; aria labels for certain images to improve accessibility.</li>
451+
<li>Increased uniformity across documentation present in the storybooks.</li>
452+
<li>Added alt descriptions &amp; aria labels for certain images to improve accessibility.</li>
453+
</ul>
454+
<h3 id="my-learnings-and-challenges">My Learnings And Challenges</h3><ul>
455+
<li>Design is more than just picking colors and placing components on a grey screen.</li>
456+
<li>It's important to read your own writings from an unbiased perspective to actually understand how well it would be perceived.</li>
457+
<li>Publishing to npmjs is not difficult!</li>
458+
<li>Knowing the previously existing code in your project is of serious essence. It's important to understand the code styles, structure &amp; activity of the code that you are dealing with.</li>
459+
<li>Be patient! Its fine to delay something if it makes sense to have it logically accomplished only after certain other tasks are done &amp; dusted with.</li>
460+
<li>How essential it is to write neat code is something that's not spoken too often. (I wonder why...)</li>
461+
<li>I always thought Vue.js sets up SPA's by default. I'm surprised you need to configure it additionally to do just that!</li>
462+
<li>Storybook is just a really nifty OSS with great community support!</li>
463+
<li>Vue.js is fantastic. Maybe I'm a Vue.js fan now. Should I remain loyal to React? I don't know.</li>
464+
<li>Making a site responsive isn't the easiest of tasks, but it's certainly doable after a lot of stretching &amp; compressing; lets say that.</li>
465+
<li>"Code formatting is essential" would be an understatement to make.</li>
466+
<li>Monorepo's have their own pro's and con's. But in our case the con's were negligible, thankfully!</li>
467+
<li>GSoD isn't just about documentation; there's some serious amount of coding too!</li>
468+
<li>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.</li>
469+
<li>Timelines change; improvisation being an essential aspect of any project!</li>
470+
<li>MDX is a neat little format to code in! Documenting code is just so much easier.</li>
471+
<li>Things become obsolete. Versions become outdated. Code maintaining is therefore, easier said than done!</li>
452472
</ul>
453473
<h3 id="issues-pr-s-raised-during-gsod-period">Issues &amp; PR's raised during GSoD period</h3><table>
454474
<thead>

blog/feed.xml

+26-6
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
&lt;p&gt;&lt;strong&gt;Week 2&lt;/strong&gt;
4040
(09/22 - 09/28)&lt;/p&gt;
4141
&lt;ul&gt;
42-
&lt;li&gt;Tackled queries regarding the choice of design, page structure etc. , and sought approval from CC’s UX Designer.&lt;/li&gt;
42+
&lt;li&gt;Tackled queries regarding the choice of design, page structure etc., and sought approval from CC’s UX Designer.&lt;/li&gt;
4343
&lt;li&gt;Began to write the content which will need to fill up the main landing page.&lt;/li&gt;
4444
&lt;/ul&gt;
4545
&lt;p&gt;&lt;strong&gt;Week 3&lt;/strong&gt;
@@ -120,11 +120,11 @@
120120
&lt;/ul&gt;
121121
&lt;h3 id=&quot;the-vocabulary-site&quot;&gt;The Vocabulary Site&lt;/h3&gt;&lt;p&gt;Here's the link to &lt;a href=&quot;https://cc-vocab-draft.web.app&quot;&gt;the landing site&lt;/a&gt;.&lt;/p&gt;
122122
&lt;ul&gt;
123-
&lt;li&gt;Went through &lt;strong&gt;3&lt;/strong&gt; Design Iterations&lt;/li&gt;
123+
&lt;li&gt;Went through &lt;strong&gt;3&lt;/strong&gt; Design Iterations.&lt;/li&gt;
124124
&lt;li&gt;Designed the mockups in &lt;a href=&quot;https://figma.com&quot;&gt;Figma&lt;/a&gt;.&lt;/li&gt;
125125
&lt;li&gt;Wrote the content filling up the landing page.&lt;/li&gt;
126126
&lt;li&gt;After approval from the UX Designer, waited for an approval from the Frontend Engineer.&lt;/li&gt;
127-
&lt;li&gt;Sought continuous approval from my mentor&lt;/li&gt;
127+
&lt;li&gt;Sought continuous approval from my mentor &lt;a href=&quot;https://opensource.creativecommons.org/blog/authors/dhruvkb/&quot;&gt;dhruvkb&lt;/a&gt;.&lt;/li&gt;
128128
&lt;li&gt;Used &lt;a href=&quot;https://vuejs.org&quot;&gt;Vue.js&lt;/a&gt; + &lt;a href=&quot;https://www.npmjs.com/package/@creativecommons/vocabulary&quot;&gt;CC Vocabulary&lt;/a&gt; to build a highly modularised site.&lt;/li&gt;
129129
&lt;li&gt;Went through a couple of iterations of the website itself.&lt;/li&gt;
130130
&lt;li&gt;Made about &lt;strong&gt;112&lt;/strong&gt; commits (&lt;strong&gt;15,000&lt;/strong&gt; lines of code) in my &lt;em&gt;gsod-nimish&lt;/em&gt; branch.&lt;/li&gt;
@@ -145,6 +145,7 @@
145145
&lt;/pre&gt;&lt;ul&gt;
146146
&lt;li&gt;PR was reviewed and merged on the &lt;strong&gt;25th of November&lt;/strong&gt;.&lt;/li&gt;
147147
&lt;/ul&gt;
148+
&lt;p&gt;Here's how the site looks right now:&lt;/p&gt;
148149
&lt;pre&gt;
149150
&lt;center&gt;
150151
&lt;img alt&quot;The final website!&quot; src=&quot;website.png&quot;/&gt;&lt;br&gt;
@@ -168,10 +169,29 @@
168169
&lt;li&gt;Modified the existing overview page.&lt;/li&gt;
169170
&lt;li&gt;Removed highly verbose sections from the docs. &lt;/li&gt;
170171
&lt;li&gt;Documented Vocabulary sprint planning workflow.&lt;/li&gt;
171-
&lt;li&gt;Documents how to use a markdown component with CC Vocabulary&lt;/li&gt;
172+
&lt;li&gt;Documented how to use a markdown component with CC Vocabulary.&lt;/li&gt;
172173
&lt;li&gt;Embedded hyperlink to other open source projects to improve SEO.&lt;/li&gt;
173-
&lt;li&gt;Increased uniformity across documentation present in the storybooks&lt;/li&gt;
174-
&lt;li&gt;Adds alt descriptions &amp;amp; aria labels for certain images to improve accessibility.&lt;/li&gt;
174+
&lt;li&gt;Increased uniformity across documentation present in the storybooks.&lt;/li&gt;
175+
&lt;li&gt;Added alt descriptions &amp;amp; aria labels for certain images to improve accessibility.&lt;/li&gt;
176+
&lt;/ul&gt;
177+
&lt;h3 id=&quot;my-learnings-and-challenges&quot;&gt;My Learnings And Challenges&lt;/h3&gt;&lt;ul&gt;
178+
&lt;li&gt;Design is more than just picking colors and placing components on a grey screen.&lt;/li&gt;
179+
&lt;li&gt;It's important to read your own writings from an unbiased perspective to actually understand how well it would be perceived.&lt;/li&gt;
180+
&lt;li&gt;Publishing to npmjs is not difficult!&lt;/li&gt;
181+
&lt;li&gt;Knowing the previously existing code in your project is of serious essence. It's important to understand the code styles, structure &amp;amp; activity of the code that you are dealing with.&lt;/li&gt;
182+
&lt;li&gt;Be patient! Its fine to delay something if it makes sense to have it logically accomplished only after certain other tasks are done &amp;amp; dusted with.&lt;/li&gt;
183+
&lt;li&gt;How essential it is to write neat code is something that's not spoken too often. (I wonder why...)&lt;/li&gt;
184+
&lt;li&gt;I always thought Vue.js sets up SPA's by default. I'm surprised you need to configure it additionally to do just that!&lt;/li&gt;
185+
&lt;li&gt;Storybook is just a really nifty OSS with great community support!&lt;/li&gt;
186+
&lt;li&gt;Vue.js is fantastic. Maybe I'm a Vue.js fan now. Should I remain loyal to React? I don't know.&lt;/li&gt;
187+
&lt;li&gt;Making a site responsive isn't the easiest of tasks, but it's certainly doable after a lot of stretching &amp;amp; compressing; lets say that.&lt;/li&gt;
188+
&lt;li&gt;&quot;Code formatting is essential&quot; would be an understatement to make.&lt;/li&gt;
189+
&lt;li&gt;Monorepo's have their own pro's and con's. But in our case the con's were negligible, thankfully!&lt;/li&gt;
190+
&lt;li&gt;GSoD isn't just about documentation; there's some serious amount of coding too!&lt;/li&gt;
191+
&lt;li&gt;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.&lt;/li&gt;
192+
&lt;li&gt;Timelines change; improvisation being an essential aspect of any project!&lt;/li&gt;
193+
&lt;li&gt;MDX is a neat little format to code in! Documenting code is just so much easier.&lt;/li&gt;
194+
&lt;li&gt;Things become obsolete. Versions become outdated. Code maintaining is therefore, easier said than done!&lt;/li&gt;
175195
&lt;/ul&gt;
176196
&lt;h3 id=&quot;issues-pr-s-raised-during-gsod-period&quot;&gt;Issues &amp;amp; PR's raised during GSoD period&lt;/h3&gt;&lt;table&gt;
177197
&lt;thead&gt;

0 commit comments

Comments
 (0)