FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Open Create a technical overview of each product
  • View options
  • Create a technical overview of each product

  • View options
  • Open Epic created by Dr Abraham Martin

    For each product we manage, provide an overview of how we manage it. This should include, if appropriate (either links to appropriate READMEs / docs or explanation in the guidebook):

    • Current status (Pre-alpha, Alpha, Beta, Live, Decommission)
    • Description of what the product does
    • Where the source code is
    • Where the infrastructure is defined
    • Where any operational documentation is located (how you deploy, how you debug, maintenance, etc)
      • How we deploy
      • Any known "gnarly bits" about the implementation or deployment
      • If this does not exists in any repo, create in the guidebook or add to corresponding repo and link from here.
    • Other system's dependencies
    • Future of the service:
      • How we'd like to improve things
      • Decommission process
    • Contact addresses
    • Service responsibilities (Service Owner / Service Manager)
    • Support responsibilities (Tech Lead and list of engineers responsible for operational stuff) For many of our more modern projects this will be very similar so we might be able to document with reference to a main document.

    Checklist of services can be found in https://gitlab.developers.cam.ac.uk/uis/devops/admin/-/issues/205

    Edited by Robin Goodall

    Linked items 0

  • Link items together to show that they're related or that one is blocking others.

    Activity

    • All activity
    • Comments only
    • History only
    • Newest first
    • Oldest first
    Loading Loading Loading Loading Loading Loading Loading Loading Loading Loading