Merge pull request creativecommons#153 from creativecommons/add_blog_series

mathemancer · web-flow · commit 8cc118721b87 · 2020-01-02T17:48:19.000+01:00
Add blog series to GSoC posts, change style &amp; display of blog series
diff --git a/content/blog/entries/cc-browser-extension-a-gsoc-project/contents.lr b/content/blog/entries/cc-browser-extension-a-gsoc-project/contents.lr
@@ -10,6 +10,8 @@ open-source
 ---
 author: makkoncept
 ---
+series: gsoc-2019-browser-extension
+---
 pub_date: 2019-06-20
 ---
 body:
diff --git a/content/blog/entries/cc-browser-extension-week5-6/contents.lr b/content/blog/entries/cc-browser-extension-week5-6/contents.lr
@@ -8,6 +8,8 @@ open-source
 ---
 author: makkoncept
 ---
+series: gsoc-2019-browser-extension
+---
 pub_date: 2019-07-04
 ---
 body:
diff --git a/content/blog/entries/cc-browser-extension-week7-8/contents.lr b/content/blog/entries/cc-browser-extension-week7-8/contents.lr
@@ -8,6 +8,8 @@ open-source
 ---
 author: makkoncept
 ---
+series: gsoc-2019-browser-extension
+---
 pub_date: 2019-07-19
 ---
 body:
diff --git a/content/blog/entries/cc-browser-extension-week9-10/contents.lr b/content/blog/entries/cc-browser-extension-week9-10/contents.lr
@@ -1,39 +1,42 @@
-title: CC Browser Extension Week 9, 10
----
-categories:
-gsoc
-gsoc-2019
-cc-browser-extension
-open-source
----
-author: makkoncept
----
-pub_date: 2019-08-12
----
-body:
-
-For the context, I am working on my GSoC project that is to make a browser-extension to search CC Licensed content in the public domain by interacting with CC Catalog API.
-
-**Previous Blogs**:
--  [CC Browser Extension - A GSoC Project](https://opensource.creativecommons.org/blog/entries/cc-browser-extension-a-gsoc-project/)
--  [CC Browser Extension Week 5, 6](https://opensource.creativecommons.org/blog/entries/cc-browser-extension-week5-6/)
--  [CC Browser Extension Week 7, 8](https://opensource.creativecommons.org/blog/entries/cc-browser-extension-week7-8/)
-
-### Work Done
-These weeks were spent on adding bookmarking feature to the extension and writing some unit tests.
-
-On clicking the bookmark icon, that appears when the image thumbnail is hovered on, the image will be bookmarked. Under the hood, the unique image identifier is saved in the local storage of the extension. The images ids are enough to get all the required image and attribution data needed using the `/image/{identifier}` endpoint of [CC Catalog API]([https://github.com/creativecommons/cccatalog-api](https://github.com/creativecommons/cccatalog-api).
-
-Bookmarked images persist even when the extension session terminates. User can view, inspect, delete the bookmarked images in the _'Bookmarks'_ section. There is also a button to delete all the bookmarks at once. 
-
-To let the users organize and share bookmarks, importing and exporting feature is also added. The buttons to export and import the bookmarks are in the options page. Simple `json` files are used for this feature.
-
-The rest of the time was spent on writing tests for the extension. One positive side-effect of this was cleaner and modular code. Finally, the CircleCi config file was modified to let the tests to run in CI pipeline.
-### Coming Up
-- Write more tests.
-- Test and fix bugs.
-- Modifying webpack config to spit out code for production.
-
-You can check out the project on [Github](https://github.com/creativecommons/ccsearch-browser-extension) and join the discussion on `#gsoc-browser-ext` channel on [slack](https://opensource.creativecommons.org/community/#slack).
-
-*Special Thanks*:  [Alden](https://creativecommons.org/author/aldencreativecommons-org/), [Timid](https://creativecommons.org/author/timidcreativecommons-org/) and [Kriti](https://creativecommons.org/author/kriticreativecommons-org/).
+title: CC Browser Extension Week 9, 10
+---
+categories:
+
+gsoc
+gsoc-2019
+cc-browser-extension
+open-source
+---
+author: makkoncept
+---
+series: gsoc-2019-browser-extension
+---
+pub_date: 2019-08-12
+---
+body:
+
+For the context, I am working on my GSoC project that is to make a browser-extension to search CC Licensed content in the public domain by interacting with CC Catalog API.
+
+**Previous Blogs**:
+-  [CC Browser Extension - A GSoC Project](https://opensource.creativecommons.org/blog/entries/cc-browser-extension-a-gsoc-project/)
+-  [CC Browser Extension Week 5, 6](https://opensource.creativecommons.org/blog/entries/cc-browser-extension-week5-6/)
+-  [CC Browser Extension Week 7, 8](https://opensource.creativecommons.org/blog/entries/cc-browser-extension-week7-8/)
+
+### Work Done
+These weeks were spent on adding bookmarking feature to the extension and writing some unit tests.
+
+On clicking the bookmark icon, that appears when the image thumbnail is hovered on, the image will be bookmarked. Under the hood, the unique image identifier is saved in the local storage of the extension. The images ids are enough to get all the required image and attribution data needed using the `/image/{identifier}` endpoint of [CC Catalog API]([https://github.com/creativecommons/cccatalog-api](https://github.com/creativecommons/cccatalog-api).
+
+Bookmarked images persist even when the extension session terminates. User can view, inspect, delete the bookmarked images in the _'Bookmarks'_ section. There is also a button to delete all the bookmarks at once. 
+
+To let the users organize and share bookmarks, importing and exporting feature is also added. The buttons to export and import the bookmarks are in the options page. Simple `json` files are used for this feature.
+
+The rest of the time was spent on writing tests for the extension. One positive side-effect of this was cleaner and modular code. Finally, the CircleCi config file was modified to let the tests to run in CI pipeline.
+### Coming Up
+- Write more tests.
+- Test and fix bugs.
+- Modifying webpack config to spit out code for production.
+
+You can check out the project on [Github](https://github.com/creativecommons/ccsearch-browser-extension) and join the discussion on `#gsoc-browser-ext` channel on [slack](https://opensource.creativecommons.org/community/#slack).
+
+*Special Thanks*:  [Alden](https://creativecommons.org/author/aldencreativecommons-org/), [Timid](https://creativecommons.org/author/timidcreativecommons-org/) and [Kriti](https://creativecommons.org/author/kriticreativecommons-org/).
diff --git a/content/blog/entries/cc-chooser-lastweek/contents.lr b/content/blog/entries/cc-chooser-lastweek/contents.lr
@@ -5,6 +5,8 @@
  gsoc-2019
 ---
  author: akmadian
+---
+series: gsoc-2019-chooser
 ---
  pub_date: 2019-08-22
 ---
diff --git a/content/blog/entries/cc-chooser-week2/contents.lr b/content/blog/entries/cc-chooser-week2/contents.lr
@@ -5,6 +5,8 @@
  gsoc-2019
 ---
  author: akmadian
+---
+series: gsoc-2019-chooser
 ---
  pub_date: 2019-06-14
 ---
diff --git a/content/blog/entries/cc-chooser-week4/contents.lr b/content/blog/entries/cc-chooser-week4/contents.lr
@@ -5,6 +5,8 @@
  gsoc-2019
 ---
  author: akmadian
+---
+series: gsoc-2019-chooser
 ---
  pub_date: 2019-06-24
 ---
diff --git a/content/blog/entries/cc-datacatalog-data-processing-2/contents.lr b/content/blog/entries/cc-datacatalog-data-processing-2/contents.lr
@@ -10,6 +10,8 @@ open-source
 ---
 author: soccerdroid
 ---
+series: gsoc-2019-dataviz
+---
 pub_date: 2019-07-26 
 ---
 body:
diff --git a/content/blog/entries/cc-datacatalog-data-processing-3/contents.lr b/content/blog/entries/cc-datacatalog-data-processing-3/contents.lr
@@ -10,6 +10,8 @@ open-source
 ---
 author: soccerdroid
 ---
+series: gsoc-2019-dataviz
+---
 pub_date: 2019-08-12 
 ---
 body:
diff --git a/content/blog/entries/cc-datacatalog-data-processing/contents.lr b/content/blog/entries/cc-datacatalog-data-processing/contents.lr
@@ -10,6 +10,8 @@ open-source
 ---
 author: soccerdroid
 ---
+series: gsoc-2019-dataviz
+---
 pub_date: 2019-07-10
 ---
 body:
diff --git a/content/blog/entries/cc-datacatalog-data-thelinkedcommons/contents.lr b/content/blog/entries/cc-datacatalog-data-thelinkedcommons/contents.lr
@@ -10,6 +10,8 @@ open-source
 ---
 author: soccerdroid
 ---
+series: gsoc-2019-dataviz
+---
 pub_date: 2019-09-03 
 ---
 body:
diff --git a/content/blog/entries/cc-datacatalog-visualization/contents.lr b/content/blog/entries/cc-datacatalog-visualization/contents.lr
@@ -10,6 +10,8 @@ open-source
 ---
 author: soccerdroid
 ---
+series: gsoc-2019-dataviz
+---
 pub_date: 2019-06-17
 ---
 body:
diff --git a/content/blog/entries/cc-vocabulary-new-design-system/contents.lr b/content/blog/entries/cc-vocabulary-new-design-system/contents.lr
@@ -9,6 +9,8 @@ gsoc-2019
 ---
 author: dhruvkb
 ---
+series: gsoc-2019-vocabulary
+---
 pub_date: 2019-06-15
 ---
 body:
diff --git a/content/blog/entries/cc-vocabulary-so-far/contents.lr b/content/blog/entries/cc-vocabulary-so-far/contents.lr
@@ -9,6 +9,8 @@ gsoc-2019
 ---
 author: dhruvkb
 ---
+series: gsoc-2019-vocabulary
+---
 pub_date: 2019-07-05
 ---
 body:
diff --git a/content/blog/entries/cc-vocabulary-the-main-course/contents.lr b/content/blog/entries/cc-vocabulary-the-main-course/contents.lr
@@ -9,6 +9,8 @@ gsoc-2019
 ---
 author: dhruvkb
 ---
+series: gsoc-2019-vocabulary
+---
 pub_date: 2019-07-19
 ---
 body:
diff --git a/content/blog/entries/cc-wp-plugin-final-phase/contents.lr b/content/blog/entries/cc-wp-plugin-final-phase/contents.lr
@@ -9,6 +9,8 @@ wordpress
 ---
 author: ahmadbilaldev
 ---
+series: gsoc-2019-wp-plugin
+---
 pub_date: 2019-08-23
 ---
 body:
diff --git a/content/blog/entries/cc-wp-plugin-first-phase/contents.lr b/content/blog/entries/cc-wp-plugin-first-phase/contents.lr
@@ -8,6 +8,8 @@ wordpress
 ---
 author: ahmadbilaldev
 ---
+series: gsoc-2019-wp-plugin
+---
 pub_date: 2019-06-20
 ---
 body:
diff --git a/content/blog/entries/cc-wp-plugin-second-phase/contents.lr b/content/blog/entries/cc-wp-plugin-second-phase/contents.lr
@@ -9,6 +9,8 @@ wordpress
 ---
 author: ahmadbilaldev
 ---
+series: gsoc-2019-wp-plugin
+---
 pub_date: 2019-07-20
 ---
 body:
diff --git a/content/blog/entries/introducing-cc-search-extension/contents.lr b/content/blog/entries/introducing-cc-search-extension/contents.lr
@@ -10,6 +10,8 @@ product
 ---
 author: makkoncept
 ---
+series: gsoc-2019-browser-extension
+---
 pub_date: 2019-09-03
 ---
 body:
diff --git a/content/blog/entries/vocabulary-so-long/contents.lr b/content/blog/entries/vocabulary-so-long/contents.lr
@@ -9,6 +9,8 @@ gsoc-2019
 ---
 author: dhruvkb
 ---
+series: gsoc-2019-vocabulary
+---
 pub_date: 2019-08-19
 ---
 body:
diff --git a/content/blog/series/gsoc-2019-browser-extension/contents.lr b/content/blog/series/gsoc-2019-browser-extension/contents.lr
@@ -0,0 +1 @@
+name: GSoC 2019: CC Search Browser Extension
diff --git a/content/blog/series/gsoc-2019-chooser/contents.lr b/content/blog/series/gsoc-2019-chooser/contents.lr
@@ -0,0 +1 @@
+name: GSoC 2019: Human Centered Education of CC Licenses
diff --git a/content/blog/series/gsoc-2019-dataviz/contents.lr b/content/blog/series/gsoc-2019-dataviz/contents.lr
@@ -0,0 +1 @@
+name: GSoC 2019: The Linked Commons
diff --git a/content/blog/series/gsoc-2019-vocabulary/contents.lr b/content/blog/series/gsoc-2019-vocabulary/contents.lr
@@ -0,0 +1 @@
+name: GSoC 2019: CC Vocabulary
diff --git a/content/blog/series/gsoc-2019-wp-plugin/contents.lr b/content/blog/series/gsoc-2019-wp-plugin/contents.lr
@@ -0,0 +1 @@
+name: GSoC 2019: CC WordPress Plugin
diff --git a/content/community/write-a-blog-post/contents.lr b/content/community/write-a-blog-post/contents.lr
@@ -52,6 +52,8 @@ Once you have written your post, you can either send it to us (Markdown is easie
       ---
       author: Replace this text with author's GitHub username. There should be no spaces in the name.
       ---
+      series: optional-field-for-example-series-name
+      ---
       pub_date: Replace this text with the publication date in YYYY-MM-DD format.
       ---
       body:
@@ -69,6 +71,9 @@ Once you have written your post, you can either send it to us (Markdown is easie
   * Your author folder must have **the exact username** as the author field of the blog post and have a `contents.lr` file within.
   * The `username` field in the `contents.lr` file should also use the same exact username.
   * The author's `contents.lr` file within should follow the same format as the other authors. Here's an [example author content file](https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/master/content/blog/authors/TimidRobot/contents.lr).
+1. If your blog is part of a connected series, you'll need to make a file with series information. Each series has a subdirectory in the [content/blog/series](https://github.com/creativecommons/creativecommons.github.io-source/tree/master/content/blog/series) directory.
+  * Create a folder that uses the **the exact series name** as the blog post with its own `contents.lr` file within.
+  * The new `contents.lr` file within should follow the same format as the other series. Here's an [example series content file](https://raw.githubusercontent.com/creativecommons/creativecommons.github.io-source/master/content/blog/series/gsoc-2019-vocabulary/contents.lr).
 1. Build the `creativecommons.github.io-source` project locally (instructions are in the `README` in the repository) and ensure your blog post shows up correctly locally. If you have not created the appropriate category or author files, you will see a build error in this step.
 1. Push your code and make a pull request.
 1. Wait for a member of CC's fulltime staff to merge the post into the `master` branch.
diff --git a/templates/blog-post.html b/templates/blog-post.html
@@ -18,12 +18,30 @@ <h2 class="mb-0">{{ this.title }}</h2>
   <div class="card bg-light mb-2">
     <div class="card-body p-2">
     <p class="meta my-0"><span class="mr-2"><strong>This blog is part of the series:</strong></span>
-       <a href="#series">{{ this.series }}</a>
+       <a href="#series">{{ series.name }}</a>
     </p>
     </div>
   </div>
  {% endif %}
   <div class="body">{{ this.body }}</div>
+  {% if this.series|length %}
+  <div class="mt-3 bg-light" id="series">
+    <hr/>
+    <h5 class="font-weight-bold">Posts in the <em>{{ series.name }}</em> series</h5>
+    <ul class="toc list-unstyled">
+      {% for post in series.children.order_by('pub_date') %}
+        <li>
+        {% if post.path==this.path %}
+          <strong>{{ post.title }}</strong>
+        {% else %}
+          <a href="{{ post|url }}">{{ post.title }}</a>
+        {% endif %}
+        </li>
+      {% endfor %}
+    </ul>
+    <hr/>
+  </div>
+  {% endif %}
   <div class="card bg-light">
     <div class="card-body p-2">
       <p class="meta my-0"><span class="mr-2"><strong>Categories:</strong></span>
@@ -39,31 +57,6 @@ <h2 class="mb-0">{{ this.title }}</h2>
       </p>
     </div>
   </div>
-{% if this.series|length %}
-<table class="table table-striped table-sm mt-3" id="series">
-<thead>
-<tr>
-<th>
-All posts in this series "<span style="font-size:1.15rem">{{ this.series }}<span>"
-</th>
-</tr>
-</thead>
-<tbody>
-{% for post in series.children %}
-      <tr>
-        <td>
-         {% if post.path==this.path %}
-           {{ post.title }}
-         {% else %}
-           <a href="{{ post|url }}">{{ post.title }}</a>
-        {% endif %}
-        </td>
-     </tr>
-    {% endfor %}
-</tbody>
-</table>
-  <hr>
-  Check out  <strong><a href="/blog/series/">All Series</a></strong>
-{% endif %}
+
   <div class="comments">{{ render_disqus_comments() }}</div>
 {% endblock %}
diff --git a/templates/blog-series.html b/templates/blog-series.html
@@ -5,7 +5,7 @@
 {% block title %}{{ this.name + ' - ' + this.parent.parent.children.get('entries').title }}{% endblock %}
 {% block header %}{{ this.parent.parent.children.get('entries').title }}{% endblock %}
 {% block body %}
-  <h2>All posts in Series "{{ this.name }}"</h2>
+  <h2>All posts in series "{{ this.name }}"</h2>
   {{ render_posts(this.children) }}
   <hr>
   <strong><a href="{{ this.parent|url }}">All Series</a></strong>
