Merge pull request #383 from omnivector-solutions/tbeck/PENG-1756--up…

…date-wording-throughout

Tbeck/peng 1756  update wording throughout

.github/workflows/build_docs.yaml

@@ -0,0 +1,38 @@
+name: Build Documentation
+
+on:
+  push:
+    paths:
+      - 'jobbergate-docs/docs/**'
+      - 'jobbergate-api/jobbergate_api/**'
+      - 'jobbergate-cli/jobbergate_cli/**'
+      - 'jobbergate-core/jobbergate_core/**'
+      - 'jobbergate-agent/jobbergate_agent/**'
+    branches:
+      - 'main'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Set up Poetry
+        uses: Gr1N/setup-poetry@v8
+
+      - name: Build Documentation
+        run: |
+          make docs
+
+      - name: Deploy documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/site

.github/workflows/prepare_release.yaml

@@ -14,7 +14,7 @@ on:
     inputs:
       bump_rule:
         type: choice
-        description: Bump version rule for Poetry
+        description: Release Type
         options:
           - patch
           - minor

README.md

@@ -0,0 +1,26 @@
+![Build Status](https://img.shields.io/github/actions/workflow/status/omnivector-solutions/jobbergate/test_on_push.yaml?branch=main&label=main-build&logo=github&style=plastic)
+![GitHub Issues](https://img.shields.io/github/issues/omnivector-solutions/jobbergate?label=issues&logo=github&style=plastic)
+![Pull Requests](https://img.shields.io/github/issues-pr/omnivector-solutions/jobbergate?label=pull-requests&logo=github&style=plastic)
+![GitHub Contributors](https://img.shields.io/github/contributors/omnivector-solutions/jobbergate?logo=github&style=plastic)
+
+
+> An [Omnivector](https://www.omnivector.io/) initiative
+>
+> [![omnivector-logo](https://omnivector-public-assets.s3.us-west-2.amazonaws.com/branding/omnivector-logo-text-black-horz.png)](https://www.omnivector.io/)
+                      https://omnivector-public-assets.s3.us-west-2.amazonaws.com/branding/omnivector-logo-text-black-horz.png
+
+# Jobbergate
+
+
+Jobbergate is a job templating and submission system that integrates with Slurm to
+enable the re-use and remote submission of job scripts to a Slurm cluster.
+
+There are 2 main components of Jobbergate that are hosted as sub-projects of this
+repository:
+
+* [jobbergate-api](https://github.com/omnivector-solutions/jobbergate/jobbergate-api)
+* [jobbergate-cli](https://github.com/omnivector-solutions/jobbergate/jobbergate-cli)
+
+
+The complete documentation for Jobbergate can be viewed at the
+[Jobbergate Documentation](https://omnivector-solutions.github.io/jobbergate/) site.

examples/simple-application/README.rst → examples/simple-application/README.md

@@ -1,6 +1,4 @@
-==============================
- Dummy Jobbergate Application
-==============================
+# Dummy Jobbergate Application
 
 This is a dummy Jobbergate Application that may be used for integration testing the
 components of Jobbergate.

examples/simple-job-script.py

@@ -8,5 +8,5 @@
 
 print("Executing simple job script")
 
-output_file = Path(f"/nfs/simple-output-{gethostname()}.txt")
+output_file = Path(f"/nfs/simple-output.txt")
 output_file.write_text(f"Simple output from {gethostname()}")

fake-sbatch/README.md

@@ -0,0 +1,42 @@
+# Fake sbatch
+
+A testing utility that returns `sbatch` output assuming a certain failure percentage.
+
+By default, `fake-sbatch` will fail 10% of the time (for testing error cases).
+
+
+
+## Usage
+
+```shell
+fake-sbatch
+```
+
+The command above should produce output like:
+
+```
+fake-sbatch: Submitted batch job 653898
+```
+
+
+## Settings
+
+If you wish to override the fail percentage (for example, if you wanted it to always or never fail),
+you may set the it with: `FAKE_SBATCH_FAIL_PCT=1.0`. 1.0 means it will always fail. 0.0 means it will
+never fail.
+
+You can also control the range of randomly produced slurm job id values by adjusting the `FAKE_SBATCH_MAX_JOB_ID` and
+`FAKE_SBATCH_MIN_JOB_ID` settings.
+
+
+## Setting up to use with Jobbergate CLI
+
+A simple way to make the `fake-sbatch` executable available for jobbergate is to install it via `pipx`.
+
+Simply, navigate to the root of the `fake-sbatch` repository and execute:
+
+```shell
+pipx install .
+```
+
+Then, in your Jobbergate environment, apply the setting `SBATCH_PATH=fake-sbatch`

jobbergate-agent/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+This file keeps track of all notable changes to jobbergate-core
+
+## Unreleased
+
+
+## 4.1.0a2 -- 2023-10-10
+
+
+## 4.1.0a1 -- 2023-10-02
+
+
+## 4.1.0a0 -- 2023-09-25
+
+
+## 4.0.0 -- 2023-09-14
+- Started the project

jobbergate-agent/README.md

@@ -4,6 +4,7 @@
 
 To install the package from Pypi simply run `pip install jobbergate-agent`.
 
+
 ## Setup parameters
 
 1. Setup dependencies
@@ -32,6 +33,7 @@ To install the package from Pypi simply run `pip install jobbergate-agent`.
 
   NOTE: When both `JOBBERGATE_AGENT_SLURMRESTD_JWT_KEY_PATH` and `JOBBERGATE_AGENT_SLURMRESTD_JWT_KEY_STRING` are passed, the agent will completely ignore the `JOBBERGATE_AGENT_SLURMRESTD_JWT_KEY_PATH` and will prioritize the `JOBBERGATE_AGENT_SLURMRESTD_JWT_KEY_STRING`. Beware this behaviour.
 
+
 ## Local usage example
 
 1. Run app