Skip to content

Commit 825237a

Browse files
nimishbongalenimishbongale
committed
2 parents 0c640f2 + 6ff31c0 commit 825237a

File tree

4 files changed

+118
-105
lines changed

4 files changed

+118
-105
lines changed

‎content/blog/entries/cc-wp-base-theme-docs-content-creation/contents.lr

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
title: Content Creation Phase: WordPress Base Theme Usage Guide
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-10
13+
---
14+
body:
15+
For the past couple of weeks we have been actively creating content for the Creative Commons WordPress Base Theme Usage Guide. Currently the draft content is under final review before it is migrated to the main docs site.
16+
17+
## Our Strategy
18+
Our main goal in creating the docs is to create rich, intuitive, engaging, and beautifully presented community facing documentation for the Creative Commons WordPress Base Theme.
19+
20+
In alignment with the defined goal, our core focus is to create the docs collaboratively.
21+
22+
The CC WordPress team consists of I, Jacqueline Binya, Hugo Solar and Timid Robot Zehta. Although our team is small it is quite diverse. It consists of a diverse mix of technical skills: I am a junior developer whereas Hugo and Timid are way senior. We also have non-native and native English speakers.
23+
24+
Diversity is important as we hope to create a high quality product that caters for everyone.
25+
26+
My role as the tech writer/frontend developer is to create the content: write the documentation, build the docs site and also to create all illustrative media.
27+
28+
During the content creation phase, the first step involved creating the skeleton of the actual docs site. We created a git branch called _docs_ within the [creative-commons/wp-base-theme](https://github.com/creativecommons/wp-theme-base) repository. All content related to the documentation is persisted in that branch. So,please feel free to contribute. We then used [JamDocs](https://gridsome.org/starters/jamdocs/), a [Gridsome](https://gridsome.org/) theme to quickly scaffold the site. We had to adapt the theme so as to make it meet our own specific needs, this involved overhauling the styles and changing the functionality of some of the features in the theme. After that was completed, we then created a [Google Doc](https://docs.google.com/document/d/1yfAQGG70T8BUhZYWglAlQ_lTo4_tYpyjhPN5FsZnSvI/edit?usp=sharing) we use for collaboratively writing the draft content for the docs site.
29+
30+
## Tech Stack
31+
As it was mentioned we used [Gridsome](https://gridsome.org/) a static generator for [Vuejs](https://vuejs.org/). We chose Gridsome because:
32+
33+
- We wanted to lower the barrier of entry to contributing:
34+
- Gridsome/Vuejs community is very active, help is but a click away.
35+
- The Gridsome official documentation is very resourceful and well maintained.
36+
37+
- Gridsome is highly flexible: The content for the actual documentation is written in [Markdown](https://www.markdownguide.org/getting-started/) but using [@gridsome/vue-remark](https://gridsome.org/plugins/@gridsome/vue-remark), which is a Gridsome plugin, we are able to use javascript in Markdown. We intend to include a copy to the clipboard Vuejs component in the site.
38+
39+
- Time Constraint: This project is a short running project which has to be completed in a 3 month period. Through the use of JamDocs, a Gridsome templating theme as well various plugins it was easy and fast to get started we were able to add more functionality to the theme with minimal effort.
40+
41+
- Ease of integrating [CC Vocabulary](https://cc-vocabulary.netlify.app/) with Gridsome: it is a requirement that the general aesthetics of all front facing Creative Commons applications is derived from the CC Vocabulary Design System. Major cons for using a design system include the ensuring uniformity in design for all front facing CC products.
42+
43+
## Tools Used
44+
- [Figma](https://www.figma.com/):
45+
46+
![An example of illustrative media](image.png)
47+
48+
Figma was used to make assets(banners, logos and illustrations) in the theme. The illustrative media was created with accessibility in mind and all the topography used in the illustrative assets was derived from the CC Vocabulary.
49+
50+
- [VokoScreenNG](https://linuxecke.volkoh.de/vokoscreen/vokoscreen.html): an open source screencast recording tool used to record all the screen cast demos available in the docs site.
51+
52+
- [ShortCut](https://shotcut.org/): an open source video editing tool.
53+
54+
## What comes next ?
55+
56+
After the final review is completed and all feedback implemented we will migrate all the content to the main docs site.
57+
58+
_Stay tuned for an update about the launch of the CC WP Base Theme Docs site._
59+

‎content/blog/entries/cc-wp-base-theme-docs-content-creation/image.png

22.6 KB
Loading

‎databags/issues.json

Lines changed: 15 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"number": 583,
1212
"repo": "cccatalog-api",
1313
"title": "Invalidate filter cache after updates to content provider table",
14-
"updatedAt": 1601086515,
14+
"updatedAt": 1605736595,
1515
"url": "https://github.com/creativecommons/cccatalog-api/issues/583"
1616
},
1717
{
@@ -357,7 +357,7 @@
357357
"number": 91,
358358
"repo": "wp-plugin-creativecommons",
359359
"title": "image being loaded in network",
360-
"updatedAt": 1601000324,
360+
"updatedAt": 1605813434,
361361
"url": "https://github.com/creativecommons/wp-plugin-creativecommons/issues/91"
362362
},
363363
{
@@ -400,7 +400,7 @@
400400
"number": 967,
401401
"repo": "creativecommons.org",
402402
"title": "Missing Full name of the license on the \"choose\" page",
403-
"updatedAt": 1604170862,
403+
"updatedAt": 1605123321,
404404
"url": "https://github.com/creativecommons/creativecommons.org/issues/967"
405405
},
406406
{
@@ -431,22 +431,6 @@
431431
"updatedAt": 1603376723,
432432
"url": "https://github.com/creativecommons/creativecommons.org/issues/940"
433433
},
434-
{
435-
"createdAt": 1604644111,
436-
"labels": [
437-
"good first issue",
438-
"help wanted",
439-
"\u2728 goal: improvement",
440-
"\ud83c\udfc1 status: ready for work",
441-
"\ud83d\udcbb aspect: code",
442-
"\ud83d\udfe8 priority: medium"
443-
],
444-
"number": 770,
445-
"repo": "vocabulary",
446-
"title": "Remove fontawesome packages from Vue-Vocabulary",
447-
"updatedAt": 1604829020,
448-
"url": "https://github.com/creativecommons/vocabulary/issues/770"
449-
},
450434
{
451435
"createdAt": 1604609253,
452436
"labels": [
@@ -463,19 +447,21 @@
463447
"url": "https://github.com/creativecommons/creativecommons.github.io-source/issues/553"
464448
},
465449
{
466-
"createdAt": 1604537824,
450+
"createdAt": 1604518405,
467451
"labels": [
468452
"good first issue",
469453
"help wanted",
470454
"\ud83c\udf1f goal: addition",
455+
"\ud83c\udfc1 status: ready for work",
456+
"\ud83d\udcaa skill: sass",
471457
"\ud83d\udd79 aspect: interface",
472458
"\ud83d\udfe7 priority: high"
473459
],
474-
"number": 763,
460+
"number": 759,
475461
"repo": "vocabulary",
476-
"title": "Component: Radio Button",
477-
"updatedAt": 1604757522,
478-
"url": "https://github.com/creativecommons/vocabulary/issues/763"
462+
"title": "Add two new text styles",
463+
"updatedAt": 1605624402,
464+
"url": "https://github.com/creativecommons/vocabulary/issues/759"
479465
},
480466
{
481467
"createdAt": 1603813791,
@@ -507,7 +493,7 @@
507493
"number": 545,
508494
"repo": "creativecommons.github.io-source",
509495
"title": "The header is not accessible by keyboard completely.",
510-
"updatedAt": 1604042628,
496+
"updatedAt": 1605043493,
511497
"url": "https://github.com/creativecommons/creativecommons.github.io-source/issues/545"
512498
},
513499
{
@@ -555,7 +541,7 @@
555541
"number": 635,
556542
"repo": "cccatalog-api",
557543
"title": "Research for Audio APIs",
558-
"updatedAt": 1601916855,
544+
"updatedAt": 1605900955,
559545
"url": "https://github.com/creativecommons/cccatalog-api/issues/635"
560546
},
561547
{
@@ -585,7 +571,7 @@
585571
"number": 292,
586572
"repo": "ccsearch-browser-extension",
587573
"title": "Add license explanation tool tip in the filter section",
588-
"updatedAt": 1604630934,
574+
"updatedAt": 1605850819,
589575
"url": "https://github.com/creativecommons/ccsearch-browser-extension/issues/292"
590576
},
591577
{
@@ -672,7 +658,7 @@
672658
"number": 34,
673659
"repo": "licensebuttons",
674660
"title": "Create smaller \"icon\" files",
675-
"updatedAt": 1600999216,
661+
"updatedAt": 1605831479,
676662
"url": "https://github.com/creativecommons/licensebuttons/issues/34"
677663
},
678664
{
@@ -691,23 +677,6 @@
691677
"updatedAt": 1601038933,
692678
"url": "https://github.com/creativecommons/licensebuttons/issues/32"
693679
},
694-
{
695-
"createdAt": 1599539123,
696-
"labels": [
697-
"help wanted",
698-
"\ud83c\udf1f goal: addition",
699-
"\ud83c\udfc1 status: ready for work",
700-
"\ud83d\udcaa skill: javascript/vue",
701-
"\ud83d\udcbb aspect: code",
702-
"\ud83d\udd79 aspect: interface",
703-
"\ud83e\udd16 aspect: dx"
704-
],
705-
"number": 642,
706-
"repo": "vocabulary",
707-
"title": "[Vue] Header Component and general component style discussion",
708-
"updatedAt": 1601916544,
709-
"url": "https://github.com/creativecommons/vocabulary/issues/642"
710-
},
711680
{
712681
"createdAt": 1598845438,
713682
"labels": [
@@ -725,21 +694,6 @@
725694
"updatedAt": 1602683499,
726695
"url": "https://github.com/creativecommons/cccatalog/issues/492"
727696
},
728-
{
729-
"createdAt": 1598462581,
730-
"labels": [
731-
"Hacktoberfest",
732-
"help wanted",
733-
"\u2728 goal: improvement",
734-
"\ud83d\udd79 aspect: interface",
735-
"\ud83d\udfe7 priority: high"
736-
],
737-
"number": 620,
738-
"repo": "vocabulary",
739-
"title": "Update the header component",
740-
"updatedAt": 1602328010,
741-
"url": "https://github.com/creativecommons/vocabulary/issues/620"
742-
},
743697
{
744698
"createdAt": 1598461505,
745699
"labels": [
@@ -793,7 +747,7 @@
793747
"number": 63,
794748
"repo": "ccos-scripts",
795749
"title": "Improvements to logging",
796-
"updatedAt": 1601413927,
750+
"updatedAt": 1605714773,
797751
"url": "https://github.com/creativecommons/ccos-scripts/issues/63"
798752
},
799753
{

‎databags/repos.json

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,50 @@
492492
"url": "https://github.com/creativecommons/commoners",
493493
"website": "https://network.creativecommons.org/"
494494
},
495+
{
496+
"created": "2019-12-06T19:44:21",
497+
"description": "Base WordPress theme for Creative Commons websites.",
498+
"engineering_project": true,
499+
"english_name": "WordPress base theme",
500+
"featured": false,
501+
"id": 226397839,
502+
"language": "PHP",
503+
"license": {
504+
"name": "MIT License",
505+
"url": "https://github.com/creativecommons/creativecommons-base/blob/master/LICENSE"
506+
},
507+
"name": "creativecommons-base",
508+
"slack": "cc-dev-wordpress",
509+
"technologies": [
510+
"PHP",
511+
"WordPress"
512+
],
513+
"url": "https://github.com/creativecommons/creativecommons-base",
514+
"website": ""
515+
},
516+
{
517+
"created": "2020-06-11T17:20:52",
518+
"description": "WordPress theme for the CC Certificate Website",
519+
"engineering_project": true,
520+
"english_name": "Creative Commons Certificates program child theme",
521+
"featured": false,
522+
"id": 271605671,
523+
"language": "PHP",
524+
"license": {
525+
"name": "MIT License",
526+
"url": "https://github.com/creativecommons/creativecommons-certificate/blob/master/LICENSE"
527+
},
528+
"name": "creativecommons-certificate",
529+
"slack": "",
530+
"technologies": [
531+
"CSS",
532+
"HTML",
533+
"PHP",
534+
"WordPress"
535+
],
536+
"url": "https://github.com/creativecommons/creativecommons-certificate",
537+
"website": ""
538+
},
495539
{
496540
"created": "2019-01-27T02:29:18",
497541
"description": "Source files for CC Open Source website",
@@ -1035,27 +1079,6 @@
10351079
"url": "https://github.com/creativecommons/wp-plugin-vocabulary-blocks",
10361080
"website": null
10371081
},
1038-
{
1039-
"created": "2019-12-06T19:44:21",
1040-
"description": "New base WordPress theme for Creative Commons websites",
1041-
"engineering_project": true,
1042-
"english_name": "WordPress base theme",
1043-
"featured": false,
1044-
"id": 226397839,
1045-
"language": "PHP",
1046-
"license": {
1047-
"name": "MIT License",
1048-
"url": "https://github.com/creativecommons/wp-theme-base/blob/master/LICENSE"
1049-
},
1050-
"name": "wp-theme-base",
1051-
"slack": "cc-dev-wordpress",
1052-
"technologies": [
1053-
"PHP",
1054-
"WordPress"
1055-
],
1056-
"url": "https://github.com/creativecommons/wp-theme-base",
1057-
"website": null
1058-
},
10591082
{
10601083
"created": "2019-02-11T15:51:29",
10611084
"description": "Creative Commons Chapter site theme (including chapter sites setup, taxonomies, and widget code)",
@@ -1131,29 +1154,6 @@
11311154
"url": "https://github.com/creativecommons/wp-theme-cctoolkit",
11321155
"website": ""
11331156
},
1134-
{
1135-
"created": "2020-06-11T17:20:52",
1136-
"description": "WordPress theme for the CC Certificates website",
1137-
"engineering_project": true,
1138-
"english_name": "Creative Commons Certificates program child theme",
1139-
"featured": false,
1140-
"id": 271605671,
1141-
"language": "PHP",
1142-
"license": {
1143-
"name": "MIT License",
1144-
"url": "https://github.com/creativecommons/wp-theme-certificates/blob/master/LICENSE"
1145-
},
1146-
"name": "wp-theme-certificates",
1147-
"slack": "",
1148-
"technologies": [
1149-
"CSS",
1150-
"HTML",
1151-
"PHP",
1152-
"WordPress"
1153-
],
1154-
"url": "https://github.com/creativecommons/wp-theme-certificates",
1155-
"website": null
1156-
},
11571157
{
11581158
"created": "2020-04-21T17:01:56",
11591159
"description": "New WordPress theme for Creative Commons website",

0 commit comments

Comments
 (0)