Skip to content

Commit

Permalink
documentation update on the development guide
Browse files Browse the repository at this point in the history
  • Loading branch information
rhuygen committed Feb 13, 2025
1 parent 514e133 commit 5ad8baa
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
15 changes: 13 additions & 2 deletions dev_guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1339,8 +1339,19 @@

<h1 id="developer-guide">Developer Guide<a class="headerlink" href="#developer-guide" title="Permanent link">&para;</a></h1>
<p>Welcome to the CGSE developer guide! An in-depth reference on how to contribute to the CGSE.</p>
<p>First thing to know is that this repository is actually a monorepo, meaning it contains a bunch of related but
self-standing packages with a minimum of interdependencies. These packages are </p>
<p>First thing to know is that this repository is actually a monorepo, meaning it contains a bunch of
related but self-standing packages with a minimum of interdependencies. A monorepo can grow quite
big and can contain a lot of packages that even different groups are working on. What they have in
common is that they use the same guidelines and have the same or a very similar development
workflow.</p>
<p>Don't confuse a monorepo with a <em>monolith</em> or a <em>monolithic architecture</em>. While a monorepo holds
multiple related but more-or-less independent projects, a monolith is a traditional software
application or architecture which is an often huge, self-contained and independent unit of code that
is highly coupled and difficult to maintain.</p>
<p>Don't confuse a monorepo with microservices either. A microservice architecture contains units that
run independently and are developed, scaled and deployed without affecting the other units or
services. You can set up a monorepo containing all of your microservices with ease, one does not
need the other, but they can perfectly go together.</p>



Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 5ad8baa

Please sign in to comment.