Skip to content

✨ Deployment Docs - Document Azure deployment, architecture, and onboarding details #2627

@ssw-yakshaver

Description

@ssw-yakshaver

Requested by: @wicksipedia via YakShaver.ai 🦬
cc: @wicksipedia, @joshbermanssw, @Marxoz, @PothieuG, @Freego1783

Hi Team!

  🟥  Watch the video (3 min 3 sec)

  Url from screen share: https://github.com

Pain

The Rules V3 (TinaCMS) repository lacks clear, up-to-date documentation describing where and how the application is deployed to Azure. New contributors cannot easily determine the target environment (e.g. resource groups, staging/production), deployment process, or where to find logs without tracing code or GitHub Actions. This PBI adds clear deployment, architecture, and onboarding documentation so developers can quickly understand and support the system.

Acceptance Criteria

  1. README clearly states that the project is deployed to Azure and identifies the environments (e.g. staging, production).
  2. Documentation specifies where to find deployment details, including relevant GitHub Actions workflows.
  3. Azure deployment information includes resource group naming conventions or where to locate them.
  4. A new or updated document exists in the docs directory covering architecture and deployment.
  5. Documentation explains how releases are performed (e.g. release branches, versioning).
  6. Up-to-date build/compile instructions are provided for local development.
  7. A new developer can answer the question 'Where is this deployed and how do I check logs?' without reading source code.
  8. Documentation freshness is validated (no references older than 12 months without review).

Screenshot

Screenshot
Figure: Deployment target unclear due to missing documentation in repository

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions