Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up codejail-service on Read The Docs #3

Open
3 tasks
timmc-edx opened this issue Jan 27, 2025 · 0 comments
Open
3 tasks

Set up codejail-service on Read The Docs #3

timmc-edx opened this issue Jan 27, 2025 · 0 comments

Comments

@timmc-edx
Copy link
Contributor

timmc-edx commented Jan 27, 2025

Acceptance Criteria

  • Fill out the documentation under docs/ and in README.rst
  • Set up a documentation build on Read The Docs (RTD)
  • Update the README to link to RTD

Notes

timmc-edx added a commit that referenced this issue Jan 27, 2025
Documentation has been ticketed in
#3 and linked from the
README.

Removed PyPI badge as this is an IDA and won't be published as a package.
@timmc-edx timmc-edx moved this to Backlog in Arch-BOM Jan 28, 2025
@timmc-edx timmc-edx changed the title Set up documentation Set up codejail-service on Read The Docs Jan 28, 2025
timmc-edx added a commit that referenced this issue Jan 28, 2025
Major changes:

- Trim dependencies, settings, and application code to remove anything
  relating to having a database (auth, models, pii-annotations,
  reserved-keywords) or being exposed to the outside world (cors, csrf).
  Add an in-memory DB for to satisfy Django's need for a "database".
- Remove unneeded requirements files. We're going to deploy the base
  layer instead of the production layer, and requirements.txt is
  just not needed at all as far as I can tell.
- Install gunicorn in the base layer. It's not clear if we'll want to
  use it from devstack (or just use runserver) but it should be
  available when we want to use it.
- Don't hardcode gunicorn's bind address; we'll pass it as `--bind`
  from the Dockerfile.
- Remove Dockerfile and devstack.py as these will be provided elsewhere.

Fixes:

- Use Python 3.12 for tox invocation (to match tox.ini and others)

Docs:

- Fill out README. Full documentation has been ticketed in
  #3 and linked
  from the README.
- Removed PyPI badge as this is an IDA and won't be published as a
  package.
- Update catalog-info.yaml from defaults
- Tweaks to PR template

Build:

- Suppress code coverage checks for gunicorn config file

Finally:

- Run `make upgrade`
timmc-edx added a commit that referenced this issue Jan 28, 2025
Major changes:

- Trim dependencies, settings, and application code to remove anything
  relating to having a database (auth, models, pii-annotations,
  reserved-keywords) or being exposed to the outside world (cors, csrf).
  Add an in-memory DB for to satisfy Django's need for a "database".
- Remove unneeded requirements files. We're going to deploy the base
  layer instead of the production layer, and requirements.txt is
  just not needed at all as far as I can tell.
- Install gunicorn in the base layer. It's not clear if we'll want to
  use it from devstack (or just use runserver) but it should be
  available when we want to use it.
- Don't hardcode gunicorn's bind address; we'll pass it as `--bind`
  from the Dockerfile.
- Remove Dockerfile and devstack.py as these will be provided elsewhere.

Fixes:

- Use Python 3.12 for tox invocation (to match tox.ini and others)

Docs:

- Fill out README. Full documentation has been ticketed in
  #3 and linked
  from the README.
- Removed PyPI badge as this is an IDA and won't be published as a
  package.
- Update catalog-info.yaml from defaults
- Tweaks to PR template

Build:

- Suppress code coverage checks for gunicorn config file

Finally:

- Run `make upgrade`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant