Merge pull request #29 from creativecommons/master

hugosolar · web-flow · commit c558f341e558 · 2020-01-22T08:44:25.000-04:00
Update dev branch to v2019.8.1
diff --git a/.cc-metadata.yml b/.cc-metadata.yml
@@ -0,0 +1,4 @@
+# Whether this GitHub repo is for a CC-led engineering project
+engineering_project: true
+# Whether this repository should be featured on the CC Open Source site's "Projects" page
+featured: false
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,2 @@
+# https://help.github.com/en/articles/about-code-owners
+* @creativecommons/web
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+The Creative Commons team is committed to fostering a welcoming community. This
+project and all other Creative Commons open source projects are governed by our
+[Code of Conduct][code_of_conduct]. Please report unacceptable behavior to
+[conduct@creativecommons.org](mailto:conduct@creativecommons.org) per our
+[reporting guidelines][reporting_guide].
+
+For a history of updates, see the [page history here][updates].
+
+[code_of_conduct]:https://opensource.creativecommons.org/community/code-of-conduct/
+[reporting_guide]:https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
+[updates]:https://github.com/creativecommons/creativecommons.github.io-source/commits/master/content/community/code-of-conduct/contents.lr
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# Contributing to CC Open Source
+
+Thank you for your interest in contributing to CC Open Source! This document is
+a set of guidelines to help you contribute to this project.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our [Code of
+Conduct][code_of_conduct].
+
+[code_of_conduct]:https://opensource.creativecommons.org/community/code-of-conduct/
+
+## Project Documentation
+
+The `README` in the root of the repository should contain or link to
+project documentation. If you cannot find the documentation you're
+looking for, please file a GitHub issue with details of what
+you'd like to see documented.
+
+## How to Contribute
+
+Please follow the processes in our general [Contributing Code][contributing]
+guidelines on the Creative Common Open Source website.
+
+[contributing]:https://opensource.creativecommons.org/contributing-code/
+
+## Questions or Thoughts?
+
+Talk to us on [one of our community forums][community].
+
+[community]:https://opensource.creativecommons.org/community/
diff --git a/README.md b/README.md
@@ -0,0 +1,95 @@
+# Creative Commons - Chapter WordPress theme
+
+- Contributors: quentinrogers, mackaffinity, cctimidrobot, hugosolar
+- Tags: CreativeCommons
+- Requires at least: 4.5+
+- Tested up to: 5.0.3
+- Requires PHP: 7.0
+- License: GPLv2 or later
+- License URI: https://www.gnu.org/licenses/gpl-2.0.html
+
+Creative Commons Chapter site theme (including chapter sites setup,
+taxonomies, and widget code)
+
+## Development Installation
+
+This theme uses npm, gulp, and browserify to manage dependencies.
+
+Versions of node and npm we know work:
+
+- `npm 3.3.12`
+- `node 5.4.1`
+
+To install gulp:
+
+- run `npm install -g gulp`
+
+To build the js/css:
+
+- run `npm install` to download the 3rd party libs in `package.json`
+- during development:
+  - run `gulp` in the background, i.e. run `gulp` in a terminal and leave it
+    running. It will automatically recompile `css/app.css` files as you edit
+    the src files.
+- when preparing for production:
+  - run `gulp dist` to create minified `css/app.css` files.
+- also update the CC_CSS_RELEASE_SERIAL_NUMBER at the top of functions.php to
+  purge the caches.
+
+## Standalone installation 
+
+### Requirements
+- Composer 
+- node / npm (yarn also works)
+- git
+
+Clone the repository into your `wp-content/themes`
+
+```
+> git clone git@github.com:creativecommons/wp-theme-cc-chapter.git
+``` 
+
+then, go to the directory (`cd wp-theme-cc-chapter` ) and execute composer install
+```
+> composer install
+```
+Composer will install the required dependencies such as
+- Queulat
+- Twentysixteen
+
+Once composer finished to install dependencies a new directory called `queulat` will be created in `wp-content/mu-plugins` 
+To enable this plugin you should create a `queulat.php` file in `wp-content/mu-plugins` with the following content:
+```php
+<?php
+/**
+ * Plugin Name: Queulat Loader
+ * Description: Load Queulat mu-plugin
+ */
+
+// Load Composer autoloader
+require_once __DIR__ .'/../themes/wp-theme-cc-chapter/vendor/autoload.php';
+
+// Load Queulat main file.
+require_once __DIR__ .'/queulat/queulat.php';
+```
+*note: if you chose a different directory name for theme repository you should replace `wp-theme-cc-chapter` for the chosen folder name*
+
+Once queulat ins installed, you should install its `javascript` dependencies by executing
+```
+> npm install --production
+```
+or
+
+```
+> yarn install --prod
+```
+
+## Zip install
+
+You can download the zip of this theme and dependencies in the [last release](https://github.com/creativecommons/wp-theme-cc-chapter/releases) in the repository
+
+Please unzip the downloaded file and copy/upload directories to the wordpress install in the following order:
+
+- zip > `wp-theme-cc-chapter` > `mu-plugins` -> `wp-content/mu-plugins/`
+- zip > `wp-theme-cc-chapter` > `themes/wp-theme-cc-chapter` -> `wp-content/themes/wp-theme-cc-chapter`
+- zip > `wp-theme-cc-chapter` > `themes/twentysixteen` -> `wp-content/themes/twentysixteen`
diff --git a/composer.json b/composer.json
@@ -26,6 +26,10 @@
             "type":"vcs",
             "url":"https://github.com/creativecommons/queulat",
             "no-api":true
+        },
+        {
+            "type":"composer",
+            "url":"https://wpackagist.org"
         }
     ],
     "require": {
@@ -34,7 +38,11 @@
         "wpackagist-theme/twentysixteen":"1.9"
     },
     "extra": {
-        "installer-name":"cc-chapter"
+        "installer-name":"cc-chapter",
+		"installer-paths" : {
+			"../../mu-plugins/{$name}" : ["type:wordpress-muplugin"],
+            "../../themes/{$name}" : ["wpackagist-theme/twentysixteen"]
+		}
     },
     "scripts": {
         "compat":"phpcs -p --standard=PHPCompatibility --runtime-set testVersion 7.0 -n . --extensions=php --cache",
diff --git a/functions.php b/functions.php
@@ -5,7 +5,7 @@
  * Release serial number - Used to bust the cache. Please update
  *                         any time you change CSS or JS.
  */
-define( 'CC_CSS_RELEASE_SERIAL_NUMBER', 'v2019.6.2' );
+define( 'CC_CSS_RELEASE_SERIAL_NUMBER', '2019.8.1' );
 /**
  * Include telated files
 */
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "CC Chapters theme",
-  "version": "v2019.6.2",
+  "name": "cc-chapters-theme",
+  "version": "2019.8.1",
   "description": "Creative Commons Chapter websites WordPress theme",
   "directories": {},
   "author": "Creative Commons",
diff --git a/style.css b/style.css
@@ -5,7 +5,7 @@ Author: Creative Commons
 Author URI: https://creativecommons.org/
 Description: The Creative Commons Chapter theme
 Template: twentysixteen
-Version: v2019.6.2
+Version: 2019.8.1
 License: GPL2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# https://help.github.com/en/articles/about-code-owners`
	`2`	`+* @creativecommons/web`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`		`- "name": "CC Chapters theme",`
`3`		`- "version": "v2019.6.2",`
	`2`	`+ "name": "cc-chapters-theme",`
	`3`	`+ "version": "2019.8.1",`
`4`	`4`	`"description": "Creative Commons Chapter websites WordPress theme",`
`5`	`5`	`"directories": {},`
`6`	`6`	`"author": "Creative Commons",`