Skip to content

Finish codejail-service docs #3

@timmc-edx

Description

@timmc-edx

Fill out remaining documentation under docs/ and in README.rst.

Acceptance Criteria

  • First pass: docs: First pass at docs, mostly around config and deployment #25
  • More details:
    • Recommendation to harvest apparmor denial logs, e.g. SYSTEMD_COLORS=false journalctl -k --grep='apparmor.*openedx_codejail_service' -f
  • Move developer docs from README into new docs/developing.rst page
  • Add ADR with repo purpose
  • Add ADR explaining the lack of authentication and lack of a DB (summary: allows locking down networking)

PRs:

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions