Skip to content

[Documentation] Prepare project documentation and assessment evidence pack #16

@Josan88

Description

@Josan88

Summary

Prepare the documentation and evidence package required for the project presentation and final report.

Tasks

  • Use GROUP/BookRunner Evidence Register.md as the local evidence checklist and index
  • Store screenshots, logs, and notes under the GROUP/evidence/ folder structure
  • Document the final DevOps pipeline from GitHub commit to Azure Container Apps deployment
  • Document tool justifications for GitHub, GitHub Actions, Docker, ACR, ACA, PostgreSQL, Azure Monitor, Selenium, Jest, and Supertest
  • Capture and organize screenshots for source control, CI/CD, tests, Docker images, deployment, database, monitoring, and redeployment
  • Record configuration notes for local, staging, and production environments
  • Maintain a troubleshooting section for failed builds, failed tests, deployment errors, and database connection issues
  • Link evidence back to the brief's success metrics and deliverables

Done criteria

  • The team has a structured evidence folder or document index
  • Each brief deliverable has at least one matching evidence item
  • The presentation demo has screenshot/log backups if live services fail
  • The final report can reference the collected evidence without searching through chat or browser history

Reference

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions