Merge branch 'master' of https://github.com/creativecommons/creativecommons.github.io-source into add_reactivity_menu

Author: Dhruvi16

content/blog/entries/add-new-sections-descriptions-help-texts-code-examples-schemas-and-serializers/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-response-samples-and-descriptions-for-api-endpoints/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/contributing-code/python-guidelines/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/