Merge branch 'master' into issue_finder_dyn

Author: dhruvkb

Pipfile.lock

@@ -5,4 +5,4 @@ name: Krystle Salazar
 md5_hashed_email: f36bcb2678c0c0845f8adf634c4d764b
 ---
 about:
-Krystle is a Software Developer from Venezuela, working on **Reimplement [CC’s Legal Database](https://github.com/creativecommons/caselaw) using Django** as part of Outreachy Summer round of 2020. You can find her as `@krysal` on the CC Slack.
+Krystle is a Software Developer from Venezuela, working on **Reimplement [CC’s Legal Database](https://github.com/creativecommons/legaldb) using Django** as part of Outreachy Summer round of 2020. You can find her as `@krysal` on the CC Slack.

content/blog/authors/krysal/contents.lr

@@ -0,0 +1,38 @@
+title: Add New Sections, Descriptions, Help Texts, Code Examples, Schemas, and Serializers
+
+---
+categories:
+cc-catalog-api
+gsod
+gsod-2020
+open-source
+community
+---
+author: ariessa
+---
+series: gsod-2020-cccatalog-api-usage-guide
+---
+pub_date: 2020-10-21
+---
+body:
+
+Welcome to my third blog entry! For week 5 and 6, I added new sections, descriptions, help texts, code examples, schemas, and serializers. I was so productive these past two weeks.
+
+
+### Week 5
+For this week, I managed to add a lot of stuff into the documentation. 
+I figured out how to add help texts to classes and how to create serializers. 
+I also managed to move all code examples under response samples. 
+In order to do this, I created a new class called CustomAutoSchema to add [x-code-samples](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-codesamples). 
+Other stuff that I did include creating new sections such as “Register and Authenticate” and “Glossary”. 
+The hardest part of this week is probably trying to figure out how to add request body examples and move code examples.
+
+
+### Week 6
+
+For week 6, I added another section called Contribute that provides a todolist to start contributing on Github. 
+I also wrote and published this blog post.
+
+----
+
+All caught up!

content/blog/entries/add-new-sections-descriptions-help-texts-code-examples-schemas-and-serializers/contents.lr

@@ -0,0 +1,38 @@
+title: Add Response Samples and Descriptions for API Endpoints
+---
+categories:
+cc-catalog-api
+gsod
+gsod-2020
+open-source
+community
+---
+author: ariessa
+---
+series: gsod-2020-cccatalog-api-usage-guide
+---
+pub_date: 2020-10-09
+---
+body:
+
+Well, hello again 👋! For week 3 and week 4, I added response samples and descriptions for API endpoints. Writing documentation feels a bit like coding at this point because I need to read a lot about drf-yasg, dig through issues and questions at Github / Stackoverflow to ensure that I don’t ask redundant (or even stupid) questions.
+
+### Week 3
+
+Week 3 was quite hectic. I moved back to my hometown during week 3. 
+Took 3 days off to settle my stuff and set up a workspace. 
+I worked on my GSoD project for only 2 days, Monday and Tuesday. 
+I managed to create response samples for most API endpoints. 
+Had a monthly video call with Kriti this week.
+
+### Week 4
+
+For this week, I reviewed what I’ve done and what I haven’t to estimate new completion time. 
+Thank god, I have a buffer week in my GSoD timeline and deliverables. 
+So yeah, all is good in terms of completion time. 
+I started to write descriptions for API endpoints.
+Submitted first PR and published blog entry.
+
+----
+
+Over and out.

content/blog/entries/add-response-samples-and-descriptions-for-api-endpoints/contents.lr

@@ -0,0 +1,40 @@
+title: Vocabulary Site Updates (v1)
+---
+categories:
+cc-vocabulary
+gsod
+gsod-2020
+---
+author: nimishbongale
+---
+series: gsod-2020-vocabulary-usage-guide
+---
+pub_date: 2020-10-26
+---
+body:
+
+Hello there! Well well well. It has been an eventful first few weeks, to say the least! Let's gauge my progress, shall we?
+
+## Vocabulary Site Updates (Edition 1/many more to come)
+
+### What I've been upto
+
+I've mainly got myself invested in a survey of the existing documentation that vocabulary currently possesses, and find places where it could be made better. After clearing those issues out, I began building the main landing site for `Vocabulary`, `Vue-vocabulary` and `Fonts`. It wasn't particularly difficult to establish the necessary workflows as I had done something similar before. During the process of designing the basic structure of the site, I came across a few instances where I felt we needed new/improved components & I discussed the same with my team over on the sprint calls. The design of the site is nearly done. I'm also building the site parallelly & seeking approval from the CC Design Team. I've gotten myself involved in multiple other community contributions to CC as well across multiple of our repositories.
+
+### What I've learnt
+- Knowing the previously existing code in your project is of serious essence. It's important to understand the code styles, structure & activity of the code that you are dealing with.
+- Be patient! Its fine to delay something if it makes sense to have it logically accomplished only after certain other tasks are done & dusted with.
+- How essential it is to write _neat code_ is something that's not spoken too often. (I wonder why...)
+- I always thought VueJS sets up SPA's by default. I'm surprised you need to configure it additionally to do just that!
+- Storybook is just a really nifty OSS with great community support! 
+
+### Other community work tidbits
+- I've been working on the Dark Mode (a much awaited feature, at least for me!) for our storybooks with some support from our community. It should be up and running shortly!
+- Fixed some formatting bugs in the `README.md` & suggested changes wrt to `npm v7` considerations.
+- Fixed storybook components docs for 2 features.
+- Raised a ticket for a component to render markdown text within vocabulary itself.
+- Raised a few other issues for potential hacktoberfest contributions.
+
+<p align="center">
+    <strong>Thank you for your time! To be continued...</strong>
+</p>

content/blog/entries/cc-vocabulary-docs-updates-1/contents.lr

@@ -0,0 +1,59 @@
+title: Content Creation Phase: WordPress Base Theme Usage Guide
+---
+categories:
+cc-wp-base-theme
+gsod
+gsod-2020
+---
+author: JackieBinya
+---
+series: gsod-2020-wordpress-base-theme-usage-guide
+---
+pub_date: 2020-11-10
+---
+body:
+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.
+
+## Our Strategy
+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. 
+
+In alignment with the defined goal, our core focus is to create the docs collaboratively.
+
+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.
+
+Diversity is important as we hope to create a high quality product that caters for everyone.
+
+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.
+
+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.
+
+## Tech Stack
+As it was mentioned we used [Gridsome](https://gridsome.org/) a static generator for [Vuejs](https://vuejs.org/). We chose Gridsome because:
+
+- We wanted to lower the barrier of entry to contributing:
+    - Gridsome/Vuejs community is very active, help is but a click away.
+    - The Gridsome official documentation is very resourceful and well maintained.
+
+- 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.
+
+- 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.
+
+- 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.
+
+## Tools Used
+- [Figma](https://www.figma.com/):
+
+![An example of illustrative media](image.png)
+
+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.
+
+- [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.
+
+- [ShortCut](https://shotcut.org/): an open source video editing tool.
+
+## What comes next ?
+
+After the final review is completed and all feedback implemented we will migrate all the content to the main docs site. 
+
+_Stay tuned for an update about the launch of the CC WP Base Theme Docs site._
+

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

@@ -53,10 +53,10 @@ It has only been a week so we're just starting, so next task to do sooner are:
 ### How you can help
 
 We are still discussing the new image before start coding so these are some options if you want to get involved:
-- Suggest improvements to designs/UX or new features joining the discussion on the [`#cc-dev-legal-database`](https://creativecommons.slack.com/channels/cc-dev-legal-database) Slack channel or on the [github](https://github.com/creativecommons/caselaw) project.
+- Suggest improvements to designs/UX or new features joining the discussion on the [`#cc-dev-legal-database`](https://creativecommons.slack.com/channels/cc-dev-legal-database) Slack channel or on the [github](https://github.com/creativecommons/legaldb) project.
 - Contribute directly to the CC's Vocabulary design system on [github](https://github.com/creativecommons/vocabulary).
 - Submit a case or a scholarship related to CC licenses on the [current site](https://labs.creativecommons.org/caselaw/contribute/).
 
 **CC Legal Database** is my Outreachy project for this summer, under the guidance of Director of Engineering [Kriti Godey](https://creativecommons.org/author/kriticreativecommons-org/) and Core Systems Manager [Timid Robot Zehta](https://creativecommons.org/author/timidcreativecommons-org/), they are very supportive and the CC community is notable welcoming.
 
-This is the first post of a series so stay tuned if you're interested to know more.
+This is the first post of a series so stay tuned if you're interested to know more.

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

@@ -39,7 +39,7 @@ While developing the mentioned functionalities I was also in charge of adding au
     <figcaption>Example of page obtained when requesting a case detail that is not published or doesn't exist.</figcaption>
 </figure>
 
-In this process of adding automated tests I wanted them to run on every pull request created, so I learned how to write a GitHub Action with a PostgreSQL service, the DBMS used in this case. Previously, I had already created a job for linting, so I needed to add another one to run in parallel to save time. This service provided by GitHub is pretty cool and useful, it opens up a world of possibilities, from running third party services like [Lighthouse test](https://github.com/GoogleChrome/lighthouse-ci) to even [send tweets](https://github.com/gr2m/twitter-together)! If you want to see the GitHub Action file configurated for this project, check it out: [`.github/workflows/main.yml`](https://github.com/creativecommons/caselaw/blob/31c3002a7860d78f3fdb464150c5c1b2f8bb86fc/.github/workflows/main.yml).
+In this process of adding automated tests I wanted them to run on every pull request created, so I learned how to write a GitHub Action with a PostgreSQL service, the DBMS used in this case. Previously, I had already created a job for linting, so I needed to add another one to run in parallel to save time. This service provided by GitHub is pretty cool and useful, it opens up a world of possibilities, from running third party services like [Lighthouse test](https://github.com/GoogleChrome/lighthouse-ci) to even [send tweets](https://github.com/gr2m/twitter-together)! If you want to see the GitHub Action file configurated for this project, check it out: [`.github/workflows/main.yml`](https://github.com/creativecommons/legaldb/blob/31c3002a7860d78f3fdb464150c5c1b2f8bb86fc/.github/workflows/main.yml).
 
 ### Accessibility
 
@@ -67,4 +67,4 @@ Some other features were implemented but only relevant to our registered users,
 
 After reviewing all done this last month I see significant progress has been made, I have learned many things along the way: more of what Django and its ecosystem offers, about accessibility, continuous integration in Heroku and GitHub, and more. One of the things that makes me most happy is being able to be contributing and being part of an Open Source organization, knowing how it moves and works inside, something I never imagine before.
 
-Time flies and there are less than two weeks left to finish, so if you want to follow the project here is the repository to suggest improvements or report bugs, or if you prefer something less technical you can join us on the [slack channel](https://creativecommons.slack.com/channels/cc-dev-legal-database).
+Time flies and there are less than two weeks left to finish, so if you want to follow the project here is the repository to suggest improvements or report bugs, or if you prefer something less technical you can join us on the [slack channel](https://creativecommons.slack.com/channels/cc-dev-legal-database).

content/blog/entries/legal-database-a-new-beginning/contents.lr

@@ -42,8 +42,8 @@ The channels most relevant to CC's developer community are:
       <td><a href="https://github.com/creativecommons/cccatalog-dataviz">CC Catalog visualizations.</a></td>
     </tr>
     <tr>
-      <td><code>#cc-dev-legal-database</code></td>
-      <td><a href="https://labs.creativecommons.org/caselaw/">CC Legal Database.</a></td>
+      <td><code>#cc-dev-legaldb</code></td>
+      <td><a href="https://github.com/creativecommons/legaldb">CC Legal Database.</a></td>
     </tr>
     <tr>
       <td><code>#cc-dev-license-chooser</code></td>

content/blog/entries/legal-database-features/contents.lr

@@ -0,0 +1,102 @@
+_model: page
+---
+_template: page-with-toc.html
+---
+title: Python Guidelines
+---
+description: These Python Guidelines (style guide) empower the community to
+focus on the intent of the code and work together with a minimum of friction.
+---
+body:
+
+
+## Code Formatting
+
+### Overview
+
+All Python code must be formatted using [Black][black], *the uncompromising
+Python code formatter*. Each project should contain a `pyproject.toml`
+configuration file that limits line length to 79 characters.
+
+[black]: https://github.com/psf/black
+
+### Examples
+
+- Black configuration (`pyproject.toml`): [GitHub Search · org:creativecommons
+  filename:pyproject.toml][blackconfig]
+- GitHub Actions workflow: [GitHub Search · org:creativecommons "pipenv run
+  black"][blackactions]
+
+[blackconfig]: https://github.com/search?q=org%3Acreativecommons+filename:pyproject.toml
+[blackactions]: https://github.com/search?q=org%3Acreativecommons+%22pipenv+run+black%22&type=code
+
+
+## Style and Quality
+
+### Overview
+
+All Python code must be checked using [flake8][flake8], *a python tool that
+glues together pep8, pyflakes, mccabe, and third-party plugins to check
+the style and quality of some python code.*
+
+[flake8]: https://gitlab.com/pycqa/flake8
+
+###  Conflicts with Black
+
+Where flake8 conflicts with Black, the flake8 check should be skipped. For
+example, there are instances where black formats code that generates flake8
+warning for [Whitespace before ':' (E203)][e203].
+
+[e203]: https://www.flake8rules.com/rules/E203.html
+
+
+### Examples
+
+- flake8 configuration (`.flake8`): [GitHub Search · org:creativecommons
+  filename:.flake8][flake8conf]
+- flake8 skip E203 warning: [GitHub Search · org:creativecommons "noqa:
+  E203"][skipe203]
+- GitHub Actions workflow: [GitHub Search · org:creativecommons "pipenv run
+  flake8"][flake8actions]
+
+[flake8conf]: https://github.com/search?q=org%3Acreativecommons+filename:.flake8
+[skipe203]: https://github.com/search?q=org%3Acreativecommons+%22noqa%3A+E203%22&type=code
+[flake8actions]: https://github.com/search?q=org%3Acreativecommons+%22pipenv+run+flake8%22&type=code
+
+
+## Development Environment
+
+### Overview
+
+Please work to minimize the number of development related technologies. This
+helps minimize the overhead of contributing to multiple projects. Most of our
+projects use either [Pipenv][pipenv], the Python Development Workflow for
+Humans, or [docker-compose][dockercompose], a tool for defining and running
+multi-container Docker applications.
+
+[pipenv]: https://github.com/pypa/pipenv
+[dockercompose]: https://docs.docker.com/compose/
+
+
+### Examples
+
+- Pipenv configuration: [GitHub Search · org:creativecommons
+  filename:Pipfile][pipenvconf]
+- Docker-compose example: [docker-compose.yml for cccatalog][dockercomposeconf]
+  and the [related README.md][relatedreadme]
+
+[pipenvconf]: https://github.com/search?q=org%3Acreativecommons+filename:Pipfile
+[dockercomposeconf]: https://github.com/creativecommons/cccatalog/blob/master/src/cc_catalog_airflow/docker-compose.yml
+[relatedreadme]: https://github.com/creativecommons/cccatalog#development-setup-for-airflow-and-api-puller-scripts
+
+
+## Additional Guidance
+
+Thankfully, Black removes a lot of style work and worry. Where there is room
+for developer discretion, the following guides are excellent resources:
+
+- [Google Python Style Guide][googlestyle]
+- [Code Style — The Hitchhiker's Guide to Python][hitchhikers]
+
+[googlestyle]: https://google.github.io/styleguide/pyguide.html
+[hitchhikers]: https://docs.python-guide.org/writing/style/

content/community/contents.lr

@@ -187,7 +187,7 @@
                 }
             ],
             "name": "Legal Database",
-            "repos": "caselaw"
+            "repos": "legaldb"
         },
         {
             "members": [