Skip to content

Commit

Permalink
Merge pull request #240 from openedx/feanil/re-rule
Browse files Browse the repository at this point in the history
refactor: Re-rule the RST files in this repo.
  • Loading branch information
Feanil Patel authored Aug 11, 2022
2 parents 9033bf3 + 0d16e05 commit 499514a
Show file tree
Hide file tree
Showing 25 changed files with 212 additions and 209 deletions.
143 changes: 75 additions & 68 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,45 +1,53 @@
Change Log
==========
##########

..
This file loosely adheres to the structure of https://keepachangelog.com/,
but in reStructuredText instead of Markdown.
2020-08-08
**********

Changed
=======

- Re-ruled all the RST files to match the new docs guidance.

2022-07-17
----------
**********

Fixed
~~~~~
=====

- Update the cookiecutter for XBlocks to use the supported Docker image rather than a legacy, unsupported fork

2022-07-13
----------
**********

Fixed
~~~~~
=====

- Standardised the Requirements file structure in all templates.

2022-07-12
----------
**********

Fixed
~~~~~
=====

- Only run ``make check_keywords`` for IDAs, not all repos
- Ensure django-app unit tests will work, and test this in cookiecutter's own CI

Removed
~~~~~~~
=======
- Removed redundant New Relic agent injection in Makefile
- Removed references to now unsupported Travis CI

2022-07-11
----------
**********

Fixed
~~~~~
=====

- Fix or remove ``tags`` repo metadata in several templates; remove deprecated ``nick`` from openedx.yaml (see OEP-2)
- Remove extraneous period after short description
Expand All @@ -48,166 +56,165 @@ Fixed
- Change Django documentation and setup.py references from 2.2 to 3.2

2022-07-05
----------
**********

Fixed
~~~~~
=====

- Used newer, non-deprecated name for middleware to add custom attributes to requests from edx-drf-extensions

>>>>>>> master
2022-05-31
----------
**********

Fixed
~~~~~
=====

- Used newer, non-deprecated name for metrics monitoring middleware from edx-django-utils

Added
~~~~~
=====

- Added several more monitoring middlewares for IDAs

2022-04-08
----------
**********

Fixed
~~~~~
=====
* Fixed an issue with default config for JWT auth for new IDAs.


2022-02-18
----------
**********

Removed
~~~~~~~
=======
* Removed redundant New Relic agent injection in Dockerfile


2022-01-19
----------
**********

Added
~~~~~
=====

* Added Support for Django40

Removed
~~~~~~~
=======
* Removed Support for Django22, 30, 31

2022-01-14
----------
**********

Changed
~~~~~~~
=======

* Makefile created for django-ida now interpolates repo_name into dockerhub commands.

2021-10-27
----------
**********

Added
~~~~~
=====

* Added GitHub Actions to the python-template cookiecutter so that all
cookiecutters will make repos that check for conventional commits.

2021-10-01
----------
**********

Added
~~~~~
=====

* Include system checks for Django apps in order to catch mismatches between
model fields and Django admin.

2021-07-15
----------
**********

Changed
~~~~~~~
=======

* Update cookiecutters so that sphinx warnings are treated as errors.

2021-06-01
----------
**********

Fixed
~~~~~
=====

* Django-IDA Dockerfiles

Added
~~~~~
=====

* Testing Dockerfiles into `make test` for Django-IDA

Changed
~~~~~~~
=======

* Django-IDA Dockerfile now uses ubuntu focal

2021-04-05
----------
**********

Fixed
~~~~~
=====

* Fixed django module documentation by using proper django settings.

Added
~~~~~
=====

* Added "Edit on Github" button to new project's ReadTheDocs.

2020-11-25
----------
**********

Changed
~~~~~~~
=======

* Add a typical development workflow to the generated README

2020-11-06
----------
**********

Changed
~~~~~~~
=======

* All projects (including top level) use Python 3.8 and Django 2.2

2020-11-06
----------
**********

Fixed
~~~~~
=====

* Fix Read the Docs config to point to the correct config file.
``requirements/docs.txt`` should be ``requirements/doc.txt``

2020-11-05
----------
**********

Fixed
~~~~~
=====

* Use virtualenv to prevent flakiness in ``make upgrade`` test

2020-10-30
----------
**********

Fixed
~~~~~
=====

* Don't fill in a sample url pattern for Django apps, just suggest one in a comment

2020-08-26
----------
**********

Changed
~~~~~~~
=======

* Configure devstack Django settings to have a good JWT_AUTH and a DATABASES that point at the mysql container.
* Install mysqlclient
Expand All @@ -219,86 +226,86 @@ Changed
* Ignore emacs backup files.

2020-08-14
----------
**********

Changed
~~~~~~~
=======

* Ignores /healthcheck endpoint in monitoring for IDAs

2020-08-07
----------
**********

Fixed
~~~~~
=====

- Tweaks to the READMEs to separate using cookiecutters from updating
cookiecutters; clarify the use of a virtualenv for running cookiecutters;
correct the way we talk about Slack and getting help; minor formatting
improvements.

2020-08-03
----------
**********

Fixed
~~~~~~~
=======

* Doc8 configs no longer have a max line length, which goes against our best practice to not use hard line breaks, as documented in `OEP-19: Developer Documentation Best Practices`_.

.. _`OEP-19: Developer Documentation Best Practices`: https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html#best-practices

2020-07-28
----------
**********

Fixed
~~~~~~~
=======

* Include ``JWT_AUTH_COOKIE`` in the base ``JWT_AUTH`` settings dict.

2020-07-15
----------
**********

Changed
~~~~~~~
=======

* Changed how oauth2_urlpatterns is imported in the urls.py file

2020-07-09
----------
**********

Fixed
~~~~~
=====

* Added csrf.urls to IDA cookiecutter so that CSRF works

(some intervening changes not captured)

2020-06-02
----------
**********

* Adding decision to make this repo the place for all edx cookiecutters.

2020-05-27
----------
**********

* Used the layered approach for cookiecutter-xblock
* setup.py is now only in python-template

2020-05-12
----------
**********

Added
~~~~~
=====

* Added cookiecutter-argocd-application
- a cookiecutter used by devops
* Added cookiecutter-xblock


2020-05-11
----------
**********

Added
~~~~~
=====

* Added CHANGELOG
Loading

0 comments on commit 499514a

Please sign in to comment.