Skip to content

Commit 78ab503

Browse files
authored
Merge branch 'master' into master
2 parents 99155e9 + bab9b29 commit 78ab503

File tree

4 files changed

+96
-0
lines changed

4 files changed

+96
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
2+
title: Vocabulary Site Updates (Part 3/n)
3+
---
4+
categories:
5+
cc-vocabulary
6+
gsod
7+
gsod-2020
8+
---
9+
author: nimishbongale
10+
---
11+
series: gsod-2020-vocabulary-usage-guide
12+
---
13+
pub_date: 2020-11-25
14+
---
15+
body:
16+
Excited to know more about this week's vocabulary site updates? Read on to find out!
17+
18+
## Vocabulary Site Updates (Edition 3/many more to come)
19+
20+
### What I've been up to
21+
22+
<center>
23+
<img alt"Halfway There" src="merged.png"/><br>
24+
<small class="muted">The surreal feeling...</small>
25+
</center>
26+
27+
Merged? Yes. **Merged**. Here's my story!
28+
29+
- After getting a thumbs up from the UX Designer, I put up my [GSoD Website PR](https://github.com/creativecommons/vocabulary/pull/747) for review.
30+
- I was confident there would be changes, and I let them roll in. It's important to note here that what seems perfect to you may not be so to others, and only experience teaches you the right from the wrong.
31+
- There were a few of them, mainly dealing with spacing, textual content and colors. I resolved them as soon as I could.
32+
- [zackkrida](https://opensource.creativecommons.org/blog/authors/zackkrida/) has been kind enough to point and enumerate all of them for me!
33+
- After receiving a final approval from the engineering team, my PR was finally merged!
34+
- The final draft of the vocabulary site is live! It will soon be deployed (on [Netlify](https://netlify,com)) and be made available for public viewing.
35+
- For my readers, here's [exclusive preview](https://cc-vocab-draft.web.app) of the final draft.
36+
- I've tried making it as optimised as possible, but if you have any inputs whatsoever feel free to raise issues over on our [GitHub repository](https://github.com/creativecommons/vocabulary).
37+
- The famed [Lighthouse report](https://developers.google.com/web/tools/lighthouse) suggests that it's a pretty good start! I've also taken care of the [accessibility aspect](https://www.w3.org/standards/webdesign/accessibility) wherever applicable.
38+
39+
<center>
40+
<img alt"Halfway There" src="light.png"/><br>
41+
<small class="muted">Aiming high!</small>
42+
</center>
43+
44+
### What I've learnt
45+
46+
- GSoD isn't just about documentation; there's some serious amount of coding too!
47+
- 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.
48+
- Timelines change; improvisation being an essential aspect of any project!
49+
- [MDX](https://mdxjs.com/) is a neat little format to code in! Documenting code is just so much easier.
50+
- Things become obsolete. Versions become outdated. Code maintaining is therefore, easier said than done!
51+
52+
### Other community work tidbits
53+
54+
Being a part of an open source organisation also means that I must try to bring in contributions from existing & first time contributors. Here's a peek into my efforts for the same:
55+
56+
- The [dark mode PR](https://github.com/creativecommons/vocabulary/pull/806) started off as a hacktoberfest contribution, and it is now complete!
57+
- Created a `/shared` package to house common files between packages (such as the dark & light theme after referring to the [React](https://reactjs.org/) documentation.
58+
- The automated npm [README.md customisation](https://github.com/creativecommons/vocabulary/pull/746) is now up and running. (really had a blast solving that issue!)
59+
- If the snapshot testing stands approved, we'll have it running on chromatic!
60+
- Raised issues to add multiple badges to the root README.md file; namely `maintained with Lerna` & custom badges for package sizes from [packagephobia](https://packagephobia.com/).
61+
62+
<p align="center">
63+
<strong>Thank you for your time! Stay put for the season finale!</strong>
64+
</p>
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
title: Presenting CC Base docs - A WordPress Base Theme Usage Guide for the CC Base Theme
2+
---
3+
categories:
4+
cc-wp-base-theme
5+
gsod
6+
gsod-2020
7+
---
8+
author: JackieBinya
9+
---
10+
series: gsod-2020-wordpress-base-theme-usage-guide
11+
---
12+
pub_date: 2020-11-27
13+
---
14+
body:
15+
16+
We are live 🎉
17+
18+
The CC Base documentation is live and its available on this [link](https://cc-wp-theme-base.netlify.app/).
19+
20+
The docs were successfully migrated from Google Docs to the site! One of the most notable changes in the theme and consequently reflected in the documentation is the product name change. The CC WP Theme Base has been renamed to CC Base.
21+
22+
But the old adage says good documentation is never complete, we hope to engage the Creative Commons Community and perform usability tests. Any feed back gathered from the usability tests will then be used to further improve the CC Base docs.
23+
24+
25+
In future iterations of the docs development we hope to include the following features:
26+
- Increase the quantity of illustrative media so as to make the docs more intuitive this will be marked by adding video tutorials on how to use certain features of the CC Base theme and also adding illustrative tree diagrams to explain hierarchy of key directories and files in the CC Base project structure.
27+
- Integration of [Algolia](https://www.algolia.com/) a software tool used to power search functionality in static generated sites.
28+
- We also hope to improve SEO for the site.
29+
30+
All the above mentioned improvements are geared at improving the overall user experience of the docs as well as ensure faster onboarding for our community members to get started on using the CC Base theme.
31+
32+
In conclusion I would like to thank all members of the Creative Commons engineering team, with special mention to Hugo Solar and Kriti Godey. Thank you for your guidance and faith in my abilities as a technical writer and software developer.

0 commit comments

Comments
 (0)