Skip to content

Commit

Permalink
Merge branch 'main' of github.com:alan-turing-institute/AssurancePlat…
Browse files Browse the repository at this point in the history
…form
  • Loading branch information
AoifeHughes committed Jul 17, 2023
2 parents 78e566b + eb1a7e9 commit 0e63fe9
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion frontend/src/components/Navigation.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ function Navigation() {
<li className="nav-item">
<a
className="nav-link"
href="https://github.com/alan-turing-institute/AssurancePlatform"
href="https://alan-turing-institute.github.io/AssurancePlatform/"
>
Docs
<span className="sr-only">(current)</span>
Expand Down
4 changes: 2 additions & 2 deletions site/docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Trustworthy and Ethical Assurance platform, or Assurance Platform for short,
is an open-source tool that has been designed and developed by researchers at
the Alan Turing Insitute and University of York to support the process of
the Alan Turing Institute and University of York to support the process of
developing and communicating assurance cases.

!!! question "What is an assurance case?"
Expand All @@ -24,7 +24,7 @@ is important, and it should be developed in such a way that facilitates
communication and review by stakeholders or third parties. For instance, using
clear and accessible terminology to assist those who need to understand and
evaluate the assurance argument. To support this, assurance cases are often
organized into a modular, hierarchical structure (e.g higher-level claims
organized into a modular, hierarchical structure (e.g. higher-level claims
supported by lower-level sub-claims), and standardised approaches, such as Goal
Structuring Notation (GSN), exist to allow complex arguments to be broken down
and understood more easily.
Expand Down
3 changes: 1 addition & 2 deletions site/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ information about the following:
- How do you install and deploy the SAFE-D Assurance platform?
- How do you use the SAFE-D Assurance platform and methodology?

![An illustration that shows a project team designing and developing a system. They are organised such that they form an abstract assurance case.](assets/images/building-an-assurance-case.png){
width=50% }
![An illustration that shows a project team designing and developing a system. They are organised such that they form an abstract assurance case.](assets/images/building-an-assurance-case.png)

!!! warning "Under Construction 🚧"

Expand Down
9 changes: 5 additions & 4 deletions site/docs/platform-details/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,16 @@ to run the tests.

A crucial aspect of the Assurance Platform is the visualization of an assurance
case, which we do using the [Mermaid](https://mermaid-js.github.io/mermaid/#/)
package. This takes some markdown text and displays it as a flowchart. It is
package. This takes some Markdown text and displays it as a flowchart. It is
possible to experiment with Mermaid, interactively creating flowcharts via the
live editor [https://mermaid.live/](https://mermaid.live/).

### Description of some components

The react framework is based around _Components_, which can correspond to a
webpage or an element on a webpage (such as a form or a chart). The following
Components in this codebase contribute to the Assurance Platform web app:
The [React framework](http://react.dev) is based around _Components_, which can
correspond to a webpage or an element on a webpage (such as a form or a chart).
The following Components in this codebase contribute to the Assurance Platform
web app:

- [CaseContainer](src/components/CaseContainer.js): this is the main "view" of
an assurance case. It contains several other components in different areas of
Expand Down
8 changes: 4 additions & 4 deletions site/docs/platform-details/azure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploying the Assurance Platform on Microsoft Azure Cloud

!!! info "Azure Deployment
!!! info "Azure Deployment"

The following procedure makes use of Docker, Azure Webapps, and Azure Database for Postgresql.
These instructions make use of the Azure Portal.
Expand Down Expand Up @@ -36,7 +36,7 @@ postgres=> \q

## Create backend docker image

This step can be skipped if you are using a github Action to build the Docker
This step can be skipped if you are using a GitHub Action to build the Docker
image, as is currently done for the `dev` and `main` branches.

- Install docker following instructions
Expand Down Expand Up @@ -74,7 +74,7 @@ docker push DOCKER_USERNAME/eap_backend:latest
- DBPASSWORD=THE_PASSWORD_FOR_THE_USER_YOU_JUST_MADE
- Test that the backend is working (will take a few minutes to start up the
first time) by going to
https://BACKEND_WEBAPP_NAME.azurewebsites.net/api/cases and you should get an
https://BACKEND_WEBAPP_NAME.azurewebsites.net/api/cases, and you should get an
empty list.
- You may also want to turn on Continuous deployment from the Deployment Center
settings, to have Azure pull the latest container every time one is available.
Expand Down Expand Up @@ -120,5 +120,5 @@ labelled "Enable Access-Control-Allow-Credentials", and put
Click "Save" here again, and restart the backend webapp from the "Overview"
page.

Wait a few seconds, then check the frontend web site to see that everything
Wait a few seconds, then check the frontend website to see that everything
works.

0 comments on commit 0e63fe9

Please sign in to comment.