Transition Documentation: Dev Ops

[maortiz-27-80]

User Story or Problem Statement

Our primary objective is to facilitate a smooth transition for the incoming CMS team. To achieve this, we need to document our processes comprehensively. This documentation will serve as a valuable resource for the new team members and contribute to the overall success of the handover.

Overall Process Documentation

• Identify and document end-to-end processes
• Include step-by-step procedures, key milestones, and dependencies
• If applicable, identify and document dependencies on external systems, APIs, or third-party services
• Document the location of critical knowledge repositories, wikis, or documentation sources
• Include information about access permissions and guidelines for updating or maintaining these repositories
• Include an updated list of key contacts within the organization, including team leads, support personnel, and any external contacts relevant to the CMS team's responsibilities
• Document any historical data, insights, or lessons learned from past projects or incidents that may be valuable for the incoming team
• Document the details of the current environment and infrastructure, including server configurations, network architecture, and any specialized hardware or software in use
• Provide information about integration points and how different components of the system interact
• Specify the tools and processes used for monitoring system health
• Provide details on logging practices, log locations, and how to interpret and respond to common log entries
• Outline the process for releasing new features, updates, or patches
• Document versioning practices, release notes, and rollback procedures

Repetitive Processes

• Identify and document repetitive processes that are crucial for daily operations
• Include detailed instructions, best practices, and any relevant tools or resources

Acceptance Criteria

• Document processes in Confluence. Parent page for Dev Ops is here.
• Each documented process should be reviewed and approved by the PO, PM, and DM
• The documentation should be clear, concise, and easily understandable by individuals with varying levels of expertise
• Include visual aids, flowcharts, diagrams, and links (external and internal) where applicable to enhance clarity

Team

Please check the team(s) that will do this work.

• CMS Team
• Public Websites
• Facilities
• Accelerated Publishing

cc: @BerniXiongA6 @EWashb @ndouglas

[EWashb]

@maortiz-27-80 there may be documentation that makes more sense from the DevOps perspective to live in GH repos. IMO it's ok if we refer our confluence to GH for things like this. I would like to make sure that all of our DevOps info is current and updated in GH anyway (which I think it should be...the team as been great keeping up with things on the DevOps side)

[maortiz-27-80]

@EWashb - Discussed with @BerniXiongA6 this morning. We will have the Confluence pages and team members can only link out to Github documentation where appropriate. We'll reiterate to the team as well.

[olivereri]

@EWashb @maortiz-27-80 This is ready for PO, PM, and DM review:
https://vfs.atlassian.net/wiki/spaces/PCMS/pages/2891743252/DevOps

[maortiz-27-80]

@olivereri - this looks great! thanks for including the architecture diagram and all the links are working for me. very detailed and much appreciated :) cc: @EWashb @BerniXiongA6 @michelle-dooley