Fixed jobs menu, swagger. Added links about default resources

equinor · Mar 5, 2024 · 36fd93a · 36fd93a
1 parent be70288
commit 36fd93a
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 8 deletions.
diff --git a/public-site/docs/guides/jobs/configure-jobs.md b/public-site/docs/guides/jobs/configure-jobs.md
@@ -86,7 +86,7 @@ The data type of the `resources` is of type `ResourceRequirements` an requires t
 
 The etl job in the example above has `resource` configured.
 
-[More details](/docs/guides/resource-request/index.md) about `resources`.
+[More details](/docs/guides/resource-request/index.md) about `resources` and about [default resources](/docs/guides/resource-request/index.md#default-resources).
 
 ### node
 

diff --git a/public-site/docs/guides/jobs/index.md b/public-site/docs/guides/jobs/index.md
@@ -1,11 +1,11 @@
 ---
-title: Jobs
+title: Overview
 next: 'configure-jobs'
 ---
 
 # Jobs
 
-A job is an on-demand and short lived container/process that performs a set of tasks, e.g. a ML training job or an ETL job, and exits when it is done.
+A job is an on-demand and short-lived container/process that performs a set of tasks, e.g. a ML training job or an ETL job, and exits when it is done.
 The duration of a job can span from seconds to hours, depending on what tasks it performs, but it is expected to exit when it has completed the work. Multiple jobs can be created and running simultaneously.
 
 CPU, GPU and memory resources requested by a job are reserved when it starts, and released when it exits. This will help reduce the total cost for an application since cost is only calculated for running containers. A job that requests 10GB of memory and 2 CPUs, started once per day and runs for one hour, will only accumulate cost for the hour it is running. A component that requests the same resources will accumulate cost for all 24 hours of a day.

diff --git a/public-site/docs/guides/jobs/openapi-swagger.md b/public-site/docs/guides/jobs/openapi-swagger.md
@@ -33,8 +33,8 @@ additionalProperties:
   packageName: JobScheduler
   netCoreProjectFile: true
 ```
-
-Download or reference the [swagger.json](https://raw.githubusercontent.com/equinor/radix-public-site/main/public-site/docs/src/guides/jobs/swagger.json) file
+## swagger.json
+Download or reference the [swagger.json](https://raw.githubusercontent.com/equinor/radix-public-site/main/public-site/docs/guides/jobs/swagger.json) file
 
 ## Examples
 

diff --git a/public-site/docs/radix-config/index.md b/public-site/docs/radix-config/index.md
@@ -390,7 +390,8 @@ spec:
 
 The `resources` section specifies how much CPU and memory each component needs, that are shared among all Radix environments in a component. These common resources are overridden by environment-specific resources.
 
-The property `limits.memory` cannot be explicitly set, it is set automatically with the same value as `requests.memory` to reduce potential risk of not sufficient memory on a node. [Read more](https://kubernetes.io/blog/2021/11/26/qos-memory-resources/) about memory resources and QoS. 
+The property `limits.memory` cannot be explicitly set, it is set automatically with the same value as `requests.memory` to reduce potential risk of not sufficient memory on a node. [Read more](https://kubernetes.io/blog/2021/11/26/qos-memory-resources/) about memory resources and QoS.
+[More details](/docs/guides/resource-request/index.md) about `resources` and about [default resources](/docs/guides/resource-request/index.md#default-resources).
 
 ### `variables` (common)
 

diff --git a/public-site/sidebars.ts b/public-site/sidebars.ts
@@ -53,9 +53,21 @@ const sidebars: SidebarsConfig = {
             label: 'External DNS Alias',
             items: [
               'guides/external-alias/index',
-            'guides/external-alias-certificate/index',]},
+              'guides/external-alias-certificate/index',
+            ]},
           'guides/component-start-stop-restart/index',
-          'guides/jobs/index',
+          {
+              type: 'category',
+              label: 'Jobs',
+              items: [
+                  'guides/jobs/index',
+                  'guides/jobs/configure-jobs',
+                  'guides/jobs/job-manager-and-job-api',
+                  'guides/jobs/notifications',
+                  'guides/jobs/environment-variables',
+                  'guides/jobs/jobs-in-web-console',
+                  'guides/jobs/openapi-swagger',
+              ]},
           'guides/deploy-only/index',
           'guides/build-and-deploy/index',
           'guides/deployment-promotion/index',