Skip to content

Add CALM Architecture documentation for TraderX #331

Description

@jimthompson5802

Feature Request

Given that TraderX and CALM are both FINOS projects, showcasing CALM version of TraderX architecture representation would be a good demonstration of these projects.

Description of Problem:

Currently the only architecture documentation available is based on C4 and separate markdown file for workflows. The various architecture views are generated through CI/CD GH Actions.

Potential Solutions:

No changes are recommended for the current architecture documentation.

The intent of this proposal is to add the CALM related artifacts to match, as closely as possible, the current TraderX architecture documentation. Specifically, these changes are proposed:

  • create following files
docs/
└── calm/
    ├── trading-system.architecture.json
    ├── trading-system-architecture-views.md
    ├── trading-system-process-flows.md
    ├── create-diagrams.sh
    └── templates/
        ├── trading-system-process-template.md
        └── architecture-diagram-template.md
  • trading-system.architecture.json CALM architecture file for TraderX
  • trading-system-architecture.md Generated views of the CALM architecture that is equivalent to the current architecture images structurizr-*.png
  • trading-system-process-flows.md Process flows for TraderX
  • create-diagrams.sh shell script that runs calm docify to generate the architecture views
  • templates/architecture-diagram-template.md CALM template file to generate the architecture views.
  • templates/trading-system-process-template.md CALM template file to generate business process flows

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    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