I generated an interactive diagram to explore Sceptre's codebase

[ivanmilevtues]

Hey, all I've always wanted to contribute to open-source projects. But at the very begining I found it a bit too difficult to navigate them and wrap my head around on the main flow and the main "logical" components. That is why I started working on a project to help people like me, who are visual learners. The project generates an interactive diagram starting from the highest level of abstraction and allows you to dive deeper into interesting components.

Here is the generated diagram:

graph LR
    CLI_Interface["CLI Interface"]
    Configuration_Manager["Configuration Manager"]
    Template_Processor["Template Processor"]
    Core_Orchestration_Engine["Core Orchestration Engine"]
    Resolver_Hook_System["Resolver & Hook System"]
    AWS_CloudFormation_Client["AWS CloudFormation Client"]
    Diffing_Reporting_Module["Diffing & Reporting Module"]
    CLI_Interface -- "initiates operations and passes control to" --> Core_Orchestration_Engine
    CLI_Interface -- "triggers project setup via" --> Configuration_Manager
    Configuration_Manager -- "provides parsed configuration and dependency graphs to" --> Core_Orchestration_Engine
    Configuration_Manager -- "integrates with" --> Resolver_Hook_System
    Core_Orchestration_Engine -- "executes AWS operations via" --> AWS_CloudFormation_Client
    Core_Orchestration_Engine -- "requests template processing from" --> Template_Processor
    Core_Orchestration_Engine -- "triggers" --> Resolver_Hook_System
    Core_Orchestration_Engine -- "requests diffs and receives status updates from" --> Diffing_Reporting_Module
    Template_Processor -- "uploads templates to S3 using" --> AWS_CloudFormation_Client
    Resolver_Hook_System -- "may make AWS calls via" --> AWS_CloudFormation_Client
    AWS_CloudFormation_Client -- "returns AWS responses and status to" --> Core_Orchestration_Engine
    Diffing_Reporting_Module -- "provides formatted output back to" --> CLI_Interface
    click CLI_Interface href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/CLI_Interface.md" "Details"
    click Configuration_Manager href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/Configuration_Manager.md" "Details"
    click Template_Processor href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/Template_Processor.md" "Details"
    click Core_Orchestration_Engine href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/Core_Orchestration_Engine.md" "Details"
    click Resolver_Hook_System href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/Resolver_Hook_System.md" "Details"
    click AWS_CloudFormation_Client href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/AWS_CloudFormation_Client.md" "Details"
    click Diffing_Reporting_Module href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/Diffing_Reporting_Module.md" "Details"

Loading

The generation tool is based on Static Analysis and LLMs and is fully open-source: https://github.com/CodeBoarding/CodeBoarding

You can see the full diagram with explanations and related source code here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sceptre/on_boarding.md

Any feedback is appreciated! If you like what you see I'd be more than happy to make a PR!

[zaro0508]

This looks nice. Thanks for make us aware of this tool. We would love to see a PR for this. I think it would make a nice supplement to the Sceptre CONTRIBUTING docs

[ivanmilevtues]

Yes that sounds awesome. Would you like to have just the top-level diagram? As now you can click on each of the components and they would lead to our own repo, where we've stored all the diagrams :).

Meaning I would put the top-level diagram, which links to our repo or you'd like something else :)