Major Architecture revision

com-pas / compas-architecture

Project's architecture documentation

Creative Commons Attribution 4.0 International

9 stars 5 forks source link

Major Architecture revision #69

Closed JorgenVanDerVelde closed 3 years ago

JorgenVanDerVelde commented 3 years ago

In this pull request I make a proposal for the architecture of CoMPAS. Following have been updated:

Gitbook structure. The final result can be viewed on a temporary gitbook
Functional architecture: description of context and decomposition
TEchnical architecture: description of the docker deployment and CI/CD
Glossary update
Readme update to reflect the the architecture must be updated
Page describing the technical decisions
All research moved to the apendices

The three pending pull requests have been merged in this pull request.

Flurb commented 3 years ago

Commit must be signed off to pass DCO check :) So each commit should have the flag --signoff, like this: git commit -a "message" --signoff

Flurb commented 3 years ago

DCO check issue has been fixed!

Flurb commented 3 years ago

Looks good! Few questions:

Why Gitbook over Github Pages?
Few typo's (CoMPASS instead of CoMPAS is pretty common)
AA(A) is on the roadmap, in the "Design decisions" section it's stated as "no AA(A)"
Technology image needs an update

JorgenVanDerVelde commented 3 years ago

Looks good! Few questions:

Why Gitbook over Github Pages?

I cannot get a custom table of contents on Github pages. The automatic process clutters the table of contents/menu, resulting in a unclear site. A solution is to use gitbook, unless a way is found to control the table of contents/menu

Few typo's (CoMPASS instead of CoMPAS is pretty common)

Removed CoMPASS

AA(A) is on the roadmap, in the "Design decisions" section it's stated as "no AA(A)"

Rephrased

Technology image needs an update

Rob will provide a new image

JorgenVanDerVelde commented 3 years ago

Navigation updated for github pages See: https://jorgenvandervelde.github.io/compas-architecture/