Merge pull request #1791 from gchq/bugfix/BAI-1499-fix-bailo-docs-links

BAI-1499 fix dead links, correct typos and improve docs

frontend/pages/docs/administration/getting-started/app-configuration.mdx

@@ -9,7 +9,7 @@ import DocsWrapper from 'src/docs/DocsWrapper'
 > `infrastructure/helm/bailo/templates/bailo/bailo.configmap.yaml`
 
 Bailo uses [`node-config`](https://github.com/node-config/node-config#readme) for application configuration.
-`node-config` organizes hierarchical configurations, allowing the user to set a series of overides over a base
+`node-config` organizes hierarchical configurations, allowing the user to set a series of overrides over a base
 configuration.
 
 The default set of configuration can be found in `config/default.js`, with overrides for other environments included in
@@ -39,7 +39,7 @@ The result is:
   a: 5, // no overrides
   b: 10, // overridden in production.cjs
   c: {
-    d: 999, // overriden in production.cjs, then again in local.js
+    d: 999, // overridden in production.cjs, then again in local.js
     e: 25 // not overwritten, objects are merged together.
   }
 }

frontend/pages/docs/administration/helm/configuration.mdx

@@ -6,7 +6,7 @@ The default Helm configuration is stored within `values.yaml`. You should not al
 overriding individual values via the command line `--set` flag, or by providing a custom `--values` file.
 
 To override a single value, add `--set <option>=<value>` to either the `helm install` and `helm upgrade` commands you
-run. To overide multiple values, create a `local.yaml` (or a deployment specific name like `ops.yaml`) file and add
+run. To override multiple values, create a `local.yaml` (or a deployment specific name like `ops.yaml`) file and add
 `--values local.yaml` to your `helm install` and `helm upgrade` commands. For example:
 
 ```yaml

frontend/pages/docs/administration/helm/isolated-environments.mdx

@@ -7,7 +7,7 @@ Bailo on a segregated environment you will need the following dependencies.
 
 ## Helm Charts
 
-We rely on the following Bitnami charts:
+We rely on the following [Bitnami charts](https://charts.bitnami.com/):
 
 - MinIO https://charts.bitnami.com/bitnami
 - MongoDB https://charts.bitnami.com/bitnami
@@ -16,16 +16,16 @@ We rely on the following Bitnami charts:
 
 We rely on the following images:
 
-- mongo:6.0.4
-- minio/minio:RELEASE.2023-01-31T02-24-19Z
-- marlonb/mailcrab:v0.10.0
-- nginx:1.21.6-alpine
-- registry:2.8.1
-- node:22-alpine
+- mongo:7.0.8
+- bitnami/minio:2024.4.6
+- marlonb/mailcrab:v1.2.0
+- nginx:1.25.4-alpine3.18
+- registry:2.8.3
+- node:22.6.0-alpine
 
-These will occassionally be updated. To retrieve the latest versions used, check `./docker-compose.yml` and
+These will occasionally be updated. To retrieve the latest versions used, check `./docker-compose.yml` and
 `./backend/Dockerfile`. These versions can be configured using the `tag` attribute for each image in `values.yaml` to
-override the defaults. In general, keeping to the same major version will maintain compatability with Bailo.
+override the defaults. In general, keeping to the same major version will maintain compatibility with Bailo.
 
 ## NPM
 

frontend/pages/docs/administration/schemas/create-a-schema.mdx

@@ -99,6 +99,7 @@ above, and then amend it so it looks like this:
       }
     },
     ...
+  }
 }
 ```
 

frontend/pages/docs/administration/schemas/upload-a-schema.mdx

@@ -10,8 +10,8 @@ By default Bailo comes with a default schema for both a model card and an access
 `backend/src/services/v2/schema.ts`. These contain a small number of questions, and are not expected to be used on a
 production system.
 
-To add a new schema, visit [/schemas/list](/schemas/list) on a Bailo instance. To manage schemas you will need to hold
-the 'admin' role on the Bailo instance. Click the 'Upload a new Schema' button in the top left.
+To add a new schema, visit [/schemas/list](/schemas/list) on a running Bailo instance. To manage schemas you will need
+to hold the 'admin' role on the Bailo instance. Click the 'Upload a new Schema' button in the top left.
 
 <Box sx={{ maxWidth: '75%', margin: 'auto' }}>
   <Image src={bailoResetApprovals} />

frontend/pages/docs/directory.tsx

@@ -50,8 +50,9 @@ export const flatDirectory: Array<DirectoryEntry> = [
   // Administration
   { title: 'Administration', slug: 'administration', header: true },
 
+  /// Getting Started
   { title: 'Getting Started', slug: 'administration/getting-started', header: true },
-  { title: 'Building The Bailo Image', slug: 'administration/getting-started/building-the-bailo-image' },
+  { title: 'App Configuration', slug: 'administration/getting-started/app-configuration' },
 
   /// Helm
   { title: 'Helm', slug: 'administration/helm', header: true },
@@ -64,13 +65,10 @@ export const flatDirectory: Array<DirectoryEntry> = [
   { title: 'Create a Schema', slug: 'administration/schemas/create-a-schema' },
   { title: 'Upload a Schema', slug: 'administration/schemas/upload-a-schema' },
 
-  { title: 'App Configuration', slug: 'administration/getting-started/app-configuration' },
-
+  /// Migrations
   { title: 'Migrations', slug: 'administration/migrations', header: true },
   { title: 'Bailo v0.4', slug: 'administration/migrations/bailo-0.4' },
   { title: 'Bailo v2.0', slug: 'administration/migrations/bailo-2.0' },
-
-  { title: 'Managing Bailo', slug: 'administration/managing-bailo', header: true },
 ]
 
 export interface DirectoryTree {

frontend/pages/docs/users/managing-models-and-releases/upload-to-bailo/files.mdx

@@ -7,7 +7,7 @@ import bailoUploadedFile from 'public/docs/bailo_created_release_upload_file.png
 
 # Uploading files
 
-A file can be anything to do with the model data. This can be model binaries or other infomation that allows users of
+A file can be anything to do with the model data. This can be model binaries or other information that allows users of
 Bailo to build and use your prepared models.
 
 ## Adding files to a new release
@@ -29,9 +29,9 @@ Similarly, you can upload and delete a file to an existing release by editing an
   <Image src={bailoUploadedFile} />
 </Box>
 
-## Uploading files programatically
+## Uploading files programmatically
 
 If you intend to download and use this in a notebook or other Python project you can use Bailo's Python Client. You can
-find out how to do this [here](/docs/python/notebooks/models_and_releases_demo/index.html).
+find out how to do this [here](/docs/python/notebooks/models_and_releases_demo_pytorch/index.html).
 
 export default ({ children }) => <DocsWrapper>{children}</DocsWrapper>

frontend/pages/docs/users/programmatically-using-bailo/open-api.mdx

@@ -6,7 +6,7 @@ import bailoSwaggerDocs from 'public/docs/bailo_swagger_docs.png'
 
 # Open API Docs
 
-Bailo provides an Open API Specification for all Bailo endpoints [here](/docs/api).
+Bailo provides an Open API Specification for all Bailo endpoints viewable [here](/docs/api) on a running Bailo instance.
 
 <Box sx={{ maxWidth: '75%', margin: 'auto' }}>
   <Image src={bailoSwaggerDocs} />

frontend/pages/docs/users/programmatically-using-bailo/python-client.mdx

@@ -2,8 +2,8 @@ import DocsWrapper from 'src/docs/DocsWrapper'
 
 # Python Client
 
-Bailo also provides a wrapper for all endpoints in the form of a Python Client. It is now avalible on the Python Package
-Index.
+Bailo also provides a wrapper for all endpoints in the form of a Python Client. It is now available on the Python
+Package Index.
 
 **You can find the full Python documentation [here](../../python/index.html)**
 

frontend/pages/docs/users/reviews/reviewed/access-request.mdx

@@ -13,6 +13,6 @@ This can only be reviewed and approved by the **_Model Senior Responsible office
 When an access request is created, the Model Senior Responsible Officer can either request for changes or approve. Once
 approved, the access request will be moved to **_Archived_**
 
-See [here](https://gchq.github.io/Bailo/docs/python/notebook/access_requests_demo) on how to do this in Python.
+See [here](/docs/python/notebooks/access_requests_demo/index.html) on how to do this in Python.
 
 export default ({ children }) => <DocsWrapper>{children}</DocsWrapper>

frontend/pages/docs/users/reviews/reviewed/releases.mdx

@@ -19,8 +19,8 @@ Only the owner of the uploaded model can create a release.
 ## **Approval process and roles**
 
 When the Model Technical Reviewer and Model Senior Responsible Officer review a release, one or both will leave a
-request for changes and/or approve. When approved by both roles, the release will be moved to **_Archived_**
+request for changes and/or approve. When approved by both roles, the release will be moved to **_Archived_**.
 
-See [here](https://gchq.github.io/Bailo/docs/python/notebook/models_and_releases_demo) on how to do this in Python
+See [here](/docs/python/notebooks/models_and_releases_demo_pytorch/index.html) on how to do this in Python.
 
 export default ({ children }) => <DocsWrapper>{children}</DocsWrapper>

frontend/pages/docs/users/using-a-model/using-a-pushed-docker-image.mdx

@@ -16,8 +16,8 @@ be found inside the UI on the registry of a model.
 
 <Image src={registryTab} />
 
-Clicking on the "Push Image" button will display a dialog window that will make the process easier, but essentially the
-process is:
+Clicking on the "Push Image" button will display a dialogue window that will make the process easier, but essentially
+the process is:
 
 - Create a token in the UI to make sure you have the correct Docker permissions (this will give you a secret key and an
   access key that will be used to authentication)