Skip to content

Commit

Permalink
Merge pull request #34 from uktrade/fix/syntax-highlighting
Browse files Browse the repository at this point in the history
docs: fix syntax highlighting
  • Loading branch information
michalc authored Feb 18, 2024
2 parents 815cebb + c87aa26 commit a67d35b
Show file tree
Hide file tree
Showing 4 changed files with 3,455 additions and 2,283 deletions.
18 changes: 9 additions & 9 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ description: How the main component of Data Workspace work together
order: 4
---

<script type="module">
import mermaid from '/assets/mermaid/mermaid.esm.min.mjs';
mermaid.initialize({ startOnLoad: true });
</script>

## Prerequisites

To understand the components of Data Workspace's architecture, you should have familiary with:
Expand All @@ -20,17 +25,17 @@ To understand the components of Data Workspace's architecture, you should have f

At the highest level, users access the Data Workspace application, which accesses a PostgreSQL database.

```mermaid
<pre class="mermaid">
graph
A[User] --> B[Data Workspace]
B --> C["PostgreSQL (Aurora)"]
```
</pre>

## Medium level architecture

The architecture is heavily Docker/ECS Fargate based.

```mermaid
<pre class="mermaid">
graph
A[User] -->|Staff SSO| B[Amazon Quicksight];
B --> C["PostgreSQL (Aurora)"];
Expand All @@ -41,10 +46,7 @@ graph
G --> C;
H --> C;
I --> C;
```
</pre>

## User-facing

Expand Down Expand Up @@ -88,5 +90,3 @@ graph

- [sentryproxy](https://quay.io/repository/uktrade/data-workspace-sentryproxy):
Proxies errors to a Sentry instance: only used by JupyterLab.

{% mermaid_js %}
5 changes: 2 additions & 3 deletions eleventy.config.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
const govukEleventyPlugin = require('@x-govuk/govuk-eleventy-plugin')
const pluginMermaid = require("@kevingimbel/eleventy-plugin-mermaid");
const fs = require('fs')

module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(pluginMermaid);

eleventyConfig.addPlugin(govukEleventyPlugin, {
icons: {
shortcut: '/assets/dit-favicon.png'
Expand Down Expand Up @@ -68,6 +65,8 @@ eleventyConfig.addCollection('homepage', (collection) =>
eleventyConfig.addPassthroughCopy('./docs/assets')
eleventyConfig.addPassthroughCopy('./docs/CNAME')
eleventyConfig.addPassthroughCopy('./docs/development/assets')
eleventyConfig.addPassthroughCopy({'./node_modules/mermaid/dist/**.mjs': 'assets/mermaid'})
eleventyConfig.addPassthroughCopy({'./node_modules/mermaid/dist/**.js': 'assets/mermaid'})

return {
dataTemplateEngine: 'njk',
Expand Down
Loading

0 comments on commit a67d35b

Please sign in to comment.