Create Dev Launchers System Design and Architecture Documentation

[oriyomibadmus]

We need to create a comprehensive documentation outlining the Dev Launchers system design and architecture. This document will serve as a reference point for current and future members, helping them understand the overall structure and components of our systems

Acceptance Criteria

• Generate system design documentation

  • The documentation should include information about the overall structure and components of the system.
  • The document should be easily understandable by current and future members.
  • The documentation should serve as a reference point for understanding the system design.

• Include system architecture details

  • The system design documentation should include details about the system architecture.
  • The architecture details should cover the different components and their interactions.
  • The document should provide a clear understanding of how the different parts of the system work together.

• Cover system components

  • The system design documentation should cover all the major components of the Devlaunchers system.
  • Each component should be described in detail, including its purpose and functionality.
  • The document should provide insights into how the components interact with each other.

• Provide guidelines for understanding the system

  • The system design documentation should include guidelines for understanding the system.
  • The guidelines should help current and future members navigate through the documentation.
  • The document should provide clear instructions on how to use the documentation effectively.

• Ensure documentation is up-to-date

  • The system design documentation should be regularly updated to reflect any changes in the system.
  • Any modifications or additions to the system should be reflected in the documentation.
  • The document should have a versioning system to track changes and updates.

• Review and validate the documentation

  • The system design documentation should be reviewed by relevant team members.
  • The review process should ensure the accuracy and completeness of the documentation.
  • Any feedback or suggestions should be incorporated into the final version of the document.

[dbradham]

@oriyomibadmus is this something you would be interested in working on? I think having a diagram of our system would be extremely helpful for maintaining the system and onboarding new developers.

[oriyomibadmus]

@dbradham Yes, I totally agree and would be taking this on

[dbradham]

Big points to cover:

• How to data flows from users to the database, and back
• How authentication works
• Backend data flow
• Frontend data flow
• Devops/deployments
• Define the hosting environments/providers
• Define the life of a request
• Define the tech stack

[dbradham]

@oriyomibadmus I am moving this to "in progress" lane. I am looking forward to your output here! I was wondering if you would be willing to join some calls for with other teams like IdeaSpace or User Profile and present the diagrams when you are finished? I think it would help them a lot for them to hear you explain our existing systems and take their questions.

Also, please let me know if I can help with covering any of the points in the comments above. I know last week you had mentioned some pending questions for frontend data flow specifically.

[dbradham]

How authentication works in the application (David will work on this)

How authentication works in the Strapi admin panel (Yomi will work on this)

Backend data flow (Yomi has gotten started on this)

Frontend data flow (David will work on this)

Devops/deployments (Yomi already has most of this documented)

Define the hosting environments/providers (Yomi has gotten started on this)

Define the life of a request (Assignee TBD)

Define the tech stack (Assignee TBD)

How to data flows from users to the database, and back (Assignee TBD)