docs(workflow): rename workflow to job

pollination · Dec 8, 2020 · bf1d3bd · bf1d3bd
1 parent 86515a1
commit bf1d3bd
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 24 deletions.
diff --git a/docs.py b/docs.py
@@ -6,7 +6,7 @@
 from pydantic_openapi_helper.inheritance import class_mapper
 from queenbee.recipe.recipe import Recipe
 from queenbee.plugin.plugin import Plugin
-from queenbee.workflow.workflow import Workflow
+from queenbee.job.job import Job
 
 
 parser = argparse.ArgumentParser(description='Generate OpenAPI JSON schemas')
@@ -45,10 +45,10 @@
 
 
 modules = [
-    {'module': [Workflow], 'name': 'Workflow'},
+    {'module': [Job], 'name': 'Job'},
     {'module': [Recipe], 'name': 'Recipe'},
     {'module': [Plugin], 'name': 'Plugin'},
-    {'module': [Recipe, Plugin, Workflow], 'name': 'Queenbee'}
+    {'module': [Recipe, Plugin, Job], 'name': 'Queenbee'}
 ]
 
 

diff --git a/docs/_static/redoc-workflow.html → docs/_static/redoc-job.html b/docs/_static/redoc-workflow.html → docs/_static/redoc-job.html
@@ -2,7 +2,7 @@
 <html>
 
 <head>
-  <title>Queenbee Workflow Schema</title>
+  <title>Queenbee Job Schema</title>
   <!-- needed for adaptive design -->
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1">
@@ -20,7 +20,7 @@
 </head>
 
 <body>
-  <redoc spec-url="schemas/workflow-openapi.json"></redoc>
+  <redoc spec-url="schemas/job-openapi.json"></redoc>
   <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
 </body>
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -13,7 +13,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 from queenbee.repository import RepositoryIndex
-from queenbee.workflow import Workflow
+from queenbee.job import Job
 from queenbee.recipe import Recipe
 from queenbee.plugin import Plugin
 from queenbee._openapi import get_openapi
@@ -252,10 +252,10 @@
 if not os.path.isdir(folder):
     os.mkdir(folder)
 
-with open(os.path.join(folder, 'workflow-openapi.json'), 'w') as out_file:
+with open(os.path.join(folder, 'job-openapi.json'), 'w') as out_file:
     json.dump(
-        get_openapi(schema_class=Workflow, title='Queenbee Workflow Schema',
-                    description='Schema documentation for Queenbee Workflows'),
+        get_openapi(schema_class=Job, title='Queenbee Job Schema',
+                    description='Schema documentation for Queenbee Jobs'),
         out_file,
         indent=2
     )
@@ -284,8 +284,8 @@
         indent=2
     )
 
-with open(os.path.join(folder, 'workflow-schema.json'), 'w') as out_file:
-    out_file.write(Workflow.schema_json())
+with open(os.path.join(folder, 'job-schema.json'), 'w') as out_file:
+    out_file.write(Job.schema_json())
 
 with open(os.path.join(folder, 'plugin-schema.json'), 'w') as out_file:
     out_file.write(Plugin.schema_json())

diff --git a/docs/guides/index.rst b/docs/guides/index.rst
@@ -1,7 +1,7 @@
 How To
 ======
 
-This section of the documentation aims to provide guided examples for users to familiarize themselves with the use of Queenbee to create reusable workflow templates and store them.
+This section of the documentation aims to provide guided examples for users to familiarize themselves with the use of Queenbee to create reusable recipe templates and store them.
 
 Pre-Flight Check
 ----------------

diff --git a/docs/guides/plugin.rst b/docs/guides/plugin.rst
@@ -39,7 +39,7 @@ You can check the full schema definition for a plugin Config `here <../_static/r
 
 Docker Config
 ^^^^^^^^^^^^^
-The Docker configuration tells the workflow execution engine which container to use when executing a Function
+The Docker configuration tells the recipe execution engine which container to use when executing a Function
 from this Plugin. It will also indicate what path within the folder each artifact (file or folder) should be
 loaded to.
 

diff --git a/docs/guides/repository-create.rst b/docs/guides/repository-create.rst
@@ -1,7 +1,7 @@
 Create A New Repository
 =======================
 
-Queenbee repositories are essential to store and share Plugins and Recipes that can be executed as Workflows.
+Queenbee repositories are essential to store and share Plugins and Recipes that can be executed as Jobs.
 
 A Repository is a folder that consists of an ``index.json`` index file and a series of packaged Plugins and Recipes.
 It is used to manage Recipe dependencies (which can be Plugins or other Recipes).

diff --git a/docs/guides/repository-manage.rst b/docs/guides/repository-manage.rst
@@ -7,7 +7,7 @@ a local index of repositories that you can reference.
 The Queenbee CLI can be used to `add`, `list` and `remove` repositories from your local
 index. Once a repository has been added to your local index you can search through the available
 Queenbee packages (both plugins and recipes) and fetch specific package versions for 
-use in a workflow.
+use in a job.
 
 Local Index Management
 ----------------------

diff --git a/docs/schemas/index.rst b/docs/schemas/index.rst
@@ -4,9 +4,9 @@ Queenbee Schemas
 There are two main schemas that users should concern themselves with when using Queenbee. The **Plugin** schema and the **Recipe** schema.
 These two types of objects are written/created by users to express business logic to be executed.
 
-There is an additional schema called a **Workflow**. Users supply **input arguments** and a **recipe** to a workflow executor, which will then
-create and manage a Workflow object. The resulting Workflow object is **read only** and is used to monitor the execution and output data from the
-workflow executor.
+There is an additional schema called a **Job**. Users supply **input arguments** and the source to a **recipe** to an executor, which will then
+create and manage a Job object. The resulting Job object is **read only** and is used to monitor the execution and output data from the
+executor.
 
 .. toctree::
    :maxdepth: 1
@@ -15,4 +15,4 @@ workflow executor.
    plugins
    recipes
    repository
-   workflows
+   jobs
diff --git a/docs/schemas/workflows.rst → docs/schemas/jobs.rst b/docs/schemas/workflows.rst → docs/schemas/jobs.rst
@@ -1,4 +1,4 @@
-Workflows
+Jobs
 =========
 
 Schema
@@ -26,7 +26,7 @@ Schema
       NProgress.start();
     </script>
     <script>
-      jsonSchemaViewer(window, '../_static/schemas/workflow-schema.json')
+      jsonSchemaViewer(window, '../_static/schemas/job-schema.json')
     </script>
     <script>
       NProgress.done();
@@ -40,15 +40,15 @@ Schema
 
 OpenAPI Docs 
 -------------
-You can find the Open API Docs formatted by redoc `here <../_static/redoc-workflow.html#tag/workflow_model>`_.
+You can find the Open API Docs formatted by redoc `here <../_static/redoc-job.html#tag/job_model>`_.
 
 OpenAPI Definition 
 -------------------
-You can find the OpenAPI JSON definition `here <../_static/schemas/workflow-openapi.json>`_.
+You can find the OpenAPI JSON definition `here <../_static/schemas/job-openapi.json>`_.
 
 JSON Schema Definition 
 -----------------------
-You can find the JSON Schema definition `here <../_static/schemas/workflow-schema.json>`_.
+You can find the JSON Schema definition `here <../_static/schemas/job-schema.json>`_.
 
 
 Examples