Skip to content

update docs to reflect merging COMPLETE_WITH_ERRORS into ERROR #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clnowacki merged 5 commits into from
Jun 2, 2025
Merged

update docs to reflect merging COMPLETE_WITH_ERRORS into ERROR #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1b5e325
update docs to reflect merging COMPLETE_WITH_ERRORS into ERROR
jtat1062 Apr 21, 2025
5a61527
re-built files
jtat1062 May 9, 2025
c97afd2
fixed description of picking supplemental based on job status
clnowacki Jun 2, 2025
f9fd73b
added missing comma
clnowacki Jun 2, 2025
ce6fe5a
rebuilt the docs
clnowacki Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/docs/TiesDb-Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,10 @@ different S3 bucket, a new output object will be created. Otherwise, the previou
object will be used.

It is possible for there to be multiple matching supplementals in TiesDb. In that case,
Workflow Manager will first pick the supplementals with the best job status. The job statuses
from best to worst are `COMPLETE`, `COMPLETE_WITH_WARNINGS`, and `COMPLETE_WITH_ERRORS`. If no jobs
with those statuses exist, all other statuses are considered equally bad. If there are multiple
supplementals with the same status, the most recently created supplemental will be used.
Workflow Manager will first pick the supplementals with the best job status. It first looks for a
job status of `COMPLETE`, and then `COMPLETE_WITH_WARNINGS`. If no jobs with those statuses exist,
all other statuses are considered equally bad. If there are multiple supplementals with the same
status, the most recently created supplemental will be used.

In order to determine if a previous job was similar enough to a current job, a hash of the
important parts of the jobs is computed. The parts of the job that are included in the hash are:
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/html/REST-API.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1041,8 +1041,8 @@ <h3 class="numbered-content">SingleJobInfo (Response only)</h3>
<td style="width:40%;">
A string that will be one of the following values: UNKNOWN,
INITIALIZED (the job has been initialized but not started),
IN_PROGRESS, IN_PROGRESS_ERRORS, IN_PROGRESS_WARNINGS
COMPLETE, COMPLETE_WITH_ERRORS, COMPLETE_WITH_WARNINGS,
IN_PROGRESS, IN_PROGRESS_ERRORS, IN_PROGRESS_WARNINGS,
COMPLETE, COMPLETE_WITH_WARNINGS,
CANCELLING, CANCELLED, CANCELLED_BY_SHUTDOWN, ERROR
</td>
</tr>
Expand Down Expand Up @@ -1070,7 +1070,7 @@ <h3 class="numbered-content">SingleJobInfo (Response only)</h3>
<td style="width:40%;">terminal</td>
<td style="width:20%;">boolean</td>
<td style="width:40%;">
True if jobStatus is COMPLETE, COMPLETE_WITH_ERRORS,
True if jobStatus is COMPLETE,
COMPLETE_WITH_WARNINGS, CANCELLED, CANCELLED_BY_SHUTDOWN, or ERROR;
otherwise false
</td>
Expand Down
8 changes: 4 additions & 4 deletions docs/site/TiesDb-Guide/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,10 +395,10 @@ <h1 id="before-job-check">Before Job Check</h1>
different S3 bucket, a new output object will be created. Otherwise, the previous job's output
object will be used.</p>
<p>It is possible for there to be multiple matching supplementals in TiesDb. In that case,
Workflow Manager will first pick the supplementals with the best job status. The job statuses
from best to worst are <code>COMPLETE</code>, <code>COMPLETE_WITH_WARNINGS</code>, and <code>COMPLETE_WITH_ERRORS</code>. If no jobs
with those statuses exist, all other statuses are considered equally bad. If there are multiple
supplementals with the same status, the most recently created supplemental will be used.</p>
Workflow Manager will first pick the supplementals with the best job status. It first looks for a
job status of <code>COMPLETE</code>, and then <code>COMPLETE_WITH_WARNINGS</code>. If no jobs with those statuses exist,
all other statuses are considered equally bad. If there are multiple supplementals with the same
status, the most recently created supplemental will be used.</p>
<p>In order to determine if a previous job was similar enough to a current job, a hash of the
important parts of the jobs is computed. The parts of the job that are included in the hash are:</p>
<ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/site/html/REST-API.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1041,8 +1041,8 @@ <h3 class="numbered-content">SingleJobInfo (Response only)</h3>
<td style="width:40%;">
A string that will be one of the following values: UNKNOWN,
INITIALIZED (the job has been initialized but not started),
IN_PROGRESS, IN_PROGRESS_ERRORS, IN_PROGRESS_WARNINGS
COMPLETE, COMPLETE_WITH_ERRORS, COMPLETE_WITH_WARNINGS,
IN_PROGRESS, IN_PROGRESS_ERRORS, IN_PROGRESS_WARNINGS,
COMPLETE, COMPLETE_WITH_WARNINGS,
CANCELLING, CANCELLED, CANCELLED_BY_SHUTDOWN, ERROR
</td>
</tr>
Expand Down Expand Up @@ -1070,7 +1070,7 @@ <h3 class="numbered-content">SingleJobInfo (Response only)</h3>
<td style="width:40%;">terminal</td>
<td style="width:20%;">boolean</td>
<td style="width:40%;">
True if jobStatus is COMPLETE, COMPLETE_WITH_ERRORS,
True if jobStatus is COMPLETE,
COMPLETE_WITH_WARNINGS, CANCELLED, CANCELLED_BY_SHUTDOWN, or ERROR;
otherwise false
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/site/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,5 +408,5 @@ <h1 id="overview">Overview</h1>

<!--
MkDocs version : 0.17.5
Build Date UTC : 2025-03-18 20:24:01
Build Date UTC : 2025-06-02 14:55:36
-->
4 changes: 2 additions & 2 deletions docs/site/search/search_index.json
View file
Open in desktop

Large diffs are not rendered by default.

64 changes: 32 additions & 32 deletions docs/site/sitemap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,162 +2,162 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Release-Notes/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/License-And-Distribution/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Acknowledgements/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Install-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Admin-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/User-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/OpenID-Connect-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Media-Segmentation-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Feed-Forward-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Derivative-Media-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Object-Storage-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Markup-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/TiesDb-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Trigger-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Roll-Up-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Health-Check-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Artifact-Extraction-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Quality-Selection-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Media-Selectors-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/REST-API/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Component-API-Overview/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Component-Descriptor-Reference/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/CPP-Batch-Component-API/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Python-Batch-Component-API/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Java-Batch-Component-API/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/GPU-Support-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Contributor-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Development-Environment-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Node-Guide/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Workflow-Manager-Architecture/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/CPP-Streaming-Component-API/index.html</loc>
<lastmod>2025-03-18</lastmod>
<lastmod>2025-06-02</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>