Skip to content

Document monitoring setup, deployed URLs, and evaluator access #129

Description

@MartinSteinmayer

Summary

Document how tutors/evaluators can access the deployed system and verify monitoring.

The final evaluation expects a running system, clear access instructions, and operational visibility. Documentation should make this easy to verify without reverse-engineering the repository.

Scope

Update README and/or docs with an evaluator-focused guide covering:

  • Deployed frontend URL.
  • Kubernetes namespace/environment details.
  • How the system is deployed, e.g. Helm/GitHub Actions.
  • Prometheus access instructions.
  • Grafana access instructions.
  • Dashboard file/location and import/provisioning details.
  • Alert rule file/location and what the alert means.
  • Basic verification checklist for the live system.

Suggested sections

  • ## Evaluation Quickstart
  • ## Live Deployment
  • ## Monitoring and Alerts
  • ## How to Verify the Running System

Acceptance criteria

  • README or docs include the deployed frontend URL/access instructions.
  • Kubernetes/Rancher deployment location is documented.
  • Prometheus and Grafana access instructions are documented.
  • Dashboard JSON and alert rule locations are documented.
  • There is a short evaluator checklist for testing the live system.
  • Documentation explains any required credentials/access limitations.

Why this matters

The aggregated and final team grades expect tutors to interact with a deployed running version without relying on local-only setup or private explanations.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    devopsCI/CD, deployment, operationsdocumentationImprovements or additions to documentationhigh prioHigh-priority workmonitoringPrometheus, Grafana, etc.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions