Issues uncovered while creating a new IDA #404
Description
A/C
- Break the list below into reasonably-sized issues
I created https://github.com/edx/flashcards for a hackathon, and discovered several respects in which the IDA cookiecutter output was broken or just not ideal. Capturing here for now, although several of these should probably be broken out into separate issues and/or PRs for implementation.
- Update the Dockerfile to include dev image and match recent best practices (it looks like there are a few existing PRs that may address this once merged, we should finish those)
- Stop using deprecated MAINTAINER Dockerfile field (may be fixed in one of the existing PRs?)
- Switch CHANGELOG.rst to use named Open edX releases rather than the essentially unused version number
- Remove openedx.yaml (see Use catalog-info.yaml for release metadata. Get rid of openedx.yaml openedx-proposals#526)
- Add .vscode (for Visual Code Studio) to .gitignore
- Do we still want .bowerrc? It seems unused.
- Remove .github/workflows/pypi-publish.yml , since we don't publish IDA packages to PyPI
- Remove renovate.json? I think we generally want to discourage having frontend code in IDAs, although it's conceivable that we might add a little for use in Django Admin..
- Add missing "#" for make help entries to work (comments starting with "##" after the target name get used)
- Add missing make target descriptions; at least some of these should probably be listed in
make help - Fix pycodestyle & pylint failures out of the box
- Add link to 2U-specific IDA creation instructions: https://2u-internal.atlassian.net/wiki/spaces/SRE/pages/19237450/Creating+A+New+Kubernetes+Django+Service