Merge branch 'master' into master

Author: nimishbongale

content/blog/entries/finish-gsod-tasks-and-explore-cc-catalog-documentation/contents.lr

@@ -0,0 +1,39 @@
+title: Finish GSoD Tasks and Explore CC Catalog Documentation
+
+---
+categories:
+cc-catalog
+gsod
+gsod-2020
+open-source
+community
+---
+author: ariessa
+---
+series: gsod-2020-cccatalog-api-usage-guide
+---
+pub_date: 2020-11-20
+---
+body:
+
+Today marks my fifth blog entry on Creative Commons. 
+For week 9 and 10, I explored CC Catalog documentation and began improving the documentation by removing keys and generalizing instructions.
+
+### Week 9
+
+I had completed all GSoD tasks by week 9. 
+So, I took a couple of days off and fixed last week's PR. 
+Kriti assigned me with new tasks, which is to port CC Catalog documentation from the internal wiki into GitHub repository. 
+Brent, the CC Catalog maintainer explained to me about what needs to be done.
+
+### Week 10
+
+For week 10, I started exploring CC Catalog and its documentation. 
+Reminds me a lot about the first and second weeks of GSoD. 
+Trying to understand new stuff and having an "aha" moment when the dots finally connect. 
+I started to move the documentation from the internal wiki to CC Catalog’s GitHub repository. 
+I also wrote and published this blog post.
+
+----
+
+End of blog entry.

content/blog/entries/restructure-readme-and-add-documentation-guidelines/contents.lr

@@ -0,0 +1,34 @@
+title: Restructure README and Add Documentation Guidelines
+
+---
+categories:
+cc-catalog-api
+gsod
+gsod-2020
+open-source
+community
+---
+author: ariessa
+---
+series: gsod-2020-cccatalog-api-usage-guide
+---
+pub_date: 2020-11-5
+---
+body:
+
+This is my fourth blog entry on Creative Commons. 
+For week 7 and 8, I restructured the file README to be more digestible to new users and created Documentation Guidelines for CC Catalog API documentation.
+
+### Week 7
+For this week, I restructured the file README in CC Catalog API repository. 
+I added a step by step guide on how to run the server locally. 
+I hope new users will be less intimidated to contribute to this project with the updated guide on how to run the server locally. 
+
+### Week 8
+
+For week 8, I created Documentation Guidelines which provides steps on how to contribute to CC Catalog API documentation, documentation styles, and cheat sheet for drf-yasg. 
+I also wrote and published this blog post.
+
+----
+
+Finis.

databags/issues.json

@@ -1,5 +1,20 @@
 {
     "issues": [
+        {
+            "createdAt": 1597429171,
+            "labels": [
+                "Hacktoberfest",
+                "help wanted",
+                "\ud83d\udcaa skill: python",
+                "\ud83d\udee0 goal: fix",
+                "\ud83e\udd16 aspect: dx"
+            ],
+            "number": 60,
+            "repo": "ccos-scripts",
+            "title": "Code organisation can be improved",
+            "updatedAt": 1601578230,
+            "url": "https://github.com/creativecommons/ccos-scripts/issues/60"
+        },
         {
             "createdAt": 1596741568,
             "labels": [
@@ -303,19 +318,6 @@
             "updatedAt": 1601490653,
             "url": "https://github.com/creativecommons/creativecommons.github.io-source/issues/159"
         },
-        {
-            "createdAt": 1579285909,
-            "labels": [
-                "Hacktoberfest",
-                "good first issue",
-                "help wanted"
-            ],
-            "number": 405,
-            "repo": "cccatalog-api",
-            "title": "Document error schemas",
-            "updatedAt": 1606390369,
-            "url": "https://github.com/creativecommons/cccatalog-api/issues/405"
-        },
         {
             "createdAt": 1578954773,
             "labels": [
@@ -430,36 +432,37 @@
             "url": "https://github.com/creativecommons/creativecommons.org/issues/940"
         },
         {
-            "createdAt": 1605704389,
+            "createdAt": 1606659007,
             "labels": [
                 "good first issue",
                 "help wanted",
                 "\ud83c\udfc1 status: ready for work",
-                "\ud83d\udcc4 aspect: text",
+                "\ud83d\udcbb aspect: code",
                 "\ud83d\udee0 goal: fix",
-                "\ud83d\udfe7 priority: high"
+                "\ud83d\udfe8 priority: medium",
+                "\ud83e\udd16 aspect: dx"
             ],
-            "number": 207,
-            "repo": "chooser",
-            "title": "Correct the attribution information for the CC0 license",
-            "updatedAt": 1606284360,
-            "url": "https://github.com/creativecommons/chooser/issues/207"
+            "number": 105,
+            "repo": "ccos-scripts",
+            "title": "TypeError: Item in __all__ must be str, not function",
+            "updatedAt": 1606659105,
+            "url": "https://github.com/creativecommons/ccos-scripts/issues/105"
         },
         {
-            "createdAt": 1605704042,
+            "createdAt": 1605704389,
             "labels": [
                 "good first issue",
                 "help wanted",
                 "\ud83c\udfc1 status: ready for work",
-                "\ud83d\udcbb aspect: code",
+                "\ud83d\udcc4 aspect: text",
                 "\ud83d\udee0 goal: fix",
                 "\ud83d\udfe7 priority: high"
             ],
-            "number": 206,
+            "number": 207,
             "repo": "chooser",
-            "title": "Copy action is not working in plain text tab",
-            "updatedAt": 1606041470,
-            "url": "https://github.com/creativecommons/chooser/issues/206"
+            "title": "Correct the attribution information for the CC0 license",
+            "updatedAt": 1606284360,
+            "url": "https://github.com/creativecommons/chooser/issues/207"
         },
         {
             "createdAt": 1604609253,
@@ -490,7 +493,7 @@
             "number": 759,
             "repo": "vocabulary",
             "title": "Add two new text styles",
-            "updatedAt": 1606142607,
+            "updatedAt": 1606601290,
             "url": "https://github.com/creativecommons/vocabulary/issues/759"
         },
         {
@@ -607,24 +610,6 @@
             "updatedAt": 1606498685,
             "url": "https://github.com/creativecommons/vocabulary/issues/689"
         },
-        {
-            "createdAt": 1601003812,
-            "labels": [
-                "Hacktoberfest",
-                "good first issue",
-                "help wanted",
-                "\u2728 goal: improvement",
-                "\ud83c\udfc1 status: ready for work",
-                "\ud83d\udcbb aspect: code",
-                "\ud83d\udfe9 priority: low",
-                "\ud83e\udd16 aspect: dx"
-            ],
-            "number": 85,
-            "repo": "ccos-scripts",
-            "title": "Increase readability of label data files",
-            "updatedAt": 1602076855,
-            "url": "https://github.com/creativecommons/ccos-scripts/issues/85"
-        },
         {
             "createdAt": 1600925457,
             "labels": [
@@ -748,21 +733,6 @@
             "title": "Improvements to logging",
             "updatedAt": 1606560369,
             "url": "https://github.com/creativecommons/ccos-scripts/issues/63"
-        },
-        {
-            "createdAt": 1597429171,
-            "labels": [
-                "Hacktoberfest",
-                "help wanted",
-                "\ud83d\udcaa skill: python",
-                "\ud83d\udee0 goal: fix",
-                "\ud83e\udd16 aspect: dx"
-            ],
-            "number": 60,
-            "repo": "ccos-scripts",
-            "title": "Code organisation can be improved",
-            "updatedAt": 1601578230,
-            "url": "https://github.com/creativecommons/ccos-scripts/issues/60"
         }
     ]
 }

themes/vocabulary_theme/templates/issue_finder.html

@@ -39,9 +39,4 @@ <h1>{{ this.title }}</h1>
       </div>
     </div>
   </div>
-  <script>
-    // Transfer all issues to the JavaScript domain
-    window.issues =
-    {{ bag('issues.issues')|tojson }}
-  </script>
 {% endblock %}

webpack/js/components.js

@@ -1,4 +1,5 @@
 import VueSelect from 'vue-select';
+import {Octokit} from '@octokit/rest';
 
 import {hydrateAppWithData} from "./hydration";
 
@@ -40,7 +41,7 @@ export const IssueCard = {
   </h4>
   <p class="is-size-6">
     <a
-      :href="issue.url"
+      :href="issue.html_url"
       target="_blank">
       <span class="has-color-forest-green">
         {{ issue.repo }}#{{ issue.number }}
@@ -70,8 +71,7 @@ export const IssueCard = {
   },
   computed: {
     dateCreated() {
-      const dateCreated = new Date(this.issue.createdAt * 1000)
-      const [dateComponent,] = dateCreated.toISOString().split("T")
+      const [dateComponent,] = this.issue.created_at.split("T")
       return dateComponent
     }
   }
@@ -84,6 +84,20 @@ export const App = {
   <div class="columns">
     <div class="column is-one-quarter">
       <form id="filters" v-if="options.skills.length">
+        <label for="aim">
+          <strong>Aim</strong><br/>
+          I am interested in...
+        </label>
+        <VueSelect
+          v-model="filters.aim"
+          id="aim"
+          name="aim"
+          :options="options.aims"
+          label="name"
+          :reduce="aim => aim.code"
+          :clearable="false"/>
+        <br/>
+        <template v-if="filters.aim === 'contribute'">
         <label for="skills">
           <strong>Skill set*</strong><br/>
           Choose up to three skills that you would like to see issues for.
@@ -110,6 +124,7 @@ export const App = {
           label="name"
           :reduce="experience => experience.code"
           :clearable="false"/>
+        </template>
       </form>
       <p class="disclaimer">
         *Not all issues have skills marked on them, especially if they are 
@@ -144,18 +159,24 @@ export const App = {
   data() {
     return {
       options: {
+        aims: [
+          {name: 'Contributing code', code: 'contribute'},
+          {name: 'Triaging issues', code: 'triage'}
+        ],
         skills: [],
         experiences: [
           {name: 'Yes, it is', code: 'beginner'},
           {name: 'No, it isn\'t', code: 'experienced'}
         ]
       },
       filters: {
+        aim: 'contribute',
         skills: [],
         experience: 'experienced'
       },
       categories: {},
-      issues: []
+      issues: [],
+      octokit: null
     }
   },
   computed: {
@@ -165,26 +186,61 @@ export const App = {
      * @returns {array} the array of filtered issues
      */
     filteredIssues() {
-      return window.issues.filter(issue => {
+      return this.issues.filter(issue => {
+        // If aim is to triage issues
+        if (this.filters.aim === 'triage') {
+          // Show all issues as they all have the label "🚦 status: awaiting triage"
+          return true
+        }
+
         // Check experience match
         if (this.filters.experience === 'beginner' && !issue.labels.includes('good first issue')) {
           return false
         }
 
         // Check skill set match
         const joinedLabels = issue.labels.join(',')
-        if (this.filters.skills.length && !this.filters.skills.some(skill => joinedLabels.includes(skill))) {
-          return false
-        }
-
-        return true
+        return !(this.filters.skills.length && !this.filters.skills.some(skill => joinedLabels.includes(skill)));
       }).sort((a, b) => b.createdAt - a.createdAt)
     }
   },
+  watch: {
+    'filters.aim' (to, from) {
+      if (to !== from) {
+        this.loadIssues()
+      }
+    }
+  },
+  methods: {
+    loadIssues () {
+      const q = ['org:creativecommons', 'is:open', 'is:issue']
+      if (this.filters.aim === 'contribute') {
+        q.push('label:"help wanted"')
+      } else if (this.filters.aim === 'triage') {
+        q.push('label:"🚦 status: awaiting triage"')
+      }
+      this.octokit.search.issuesAndPullRequests({
+        q: q.join(' '),
+        per_page: 100,
+        sort: 'updated'
+      }).then(res => {
+        this.issues = res.data.items
+        this.issues.forEach(issue => {
+          issue.labels = issue.labels.map(label => label.name)
+
+          const repoUrl = issue.repository_url
+          issue.repo = repoUrl.slice(repoUrl.lastIndexOf('/') + 1)
+        })
+      })
+    }
+  },
   mounted() {
     const BASE_URL = 'https://raw.githubusercontent.com/creativecommons/ccos-scripts/master/normalize_repos'
     const FILE_URL = name => `${BASE_URL}/${name}.json`
 
+    this.octokit = new Octokit()
+    this.loadIssues()
+
     Promise
         .all([
           fetch(FILE_URL('skills'))