Skip to content

Fix release notes documentation on LINKED_MEDIA_HASH. #169

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
merged 1 commit into from
Jul 6, 2023
Merged

Fix release notes documentation on LINKED_MEDIA_HASH. #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/Release-Notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ Rights in Data-General Clause 52.227-14, Alt. IV (DEC 2007). Copyright 2023 The

<h3>TiesDb Linked Media</h3>

- Added support for the `LINKED_MEDIA_HASH` `media.mediaProperty` in the job creation request. When specified,
the value of the `LINKED_MEDIA_HASH` will be used instead of the actual media hash when creating a record in TiesDb,
- Added support for `LINKED_MEDIA_HASH` in the `media.properties` section of the job creation request. When specified,
the value of `LINKED_MEDIA_HASH` will be used instead of the actual media hash when creating a record in TiesDb,
and also when looking for existing records in TiesDb.
- This feature can be used to submit a transcoded (or thumbnail) version of an image to process instead of the source
image. For example, the source image may be in a format not supported by OpenMPF. In this case, the value of the
image. For example, the source image may be in a format not supported by OpenMPF. In this case, the value of
`LINKED_MEDIA_HASH` can be set to the source image, but the rest of the job creation request would specify
the `media.path` and `media.mediaMetadata` for the transcoded version of that image.
the `media.mediaUri` and `media.metadata` for the transcoded version of that image.

<h3>Output Changed Counter</h3>

Expand Down
8 changes: 4 additions & 4 deletions docs/site/Release-Notes/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,13 +320,13 @@ <h3>TiesDb Checking</h3>
<h3>TiesDb Linked Media</h3>

<ul>
<li>Added support for the <code>LINKED_MEDIA_HASH</code> <code>media.mediaProperty</code> in the job creation request. When specified,
the value of the <code>LINKED_MEDIA_HASH</code> will be used instead of the actual media hash when creating a record in TiesDb,
<li>Added support for <code>LINKED_MEDIA_HASH</code> in the <code>media.properties</code> section of the job creation request. When specified,
the value of <code>LINKED_MEDIA_HASH</code> will be used instead of the actual media hash when creating a record in TiesDb,
and also when looking for existing records in TiesDb.</li>
<li>This feature can be used to submit a transcoded (or thumbnail) version of an image to process instead of the source
image. For example, the source image may be in a format not supported by OpenMPF. In this case, the value of the
image. For example, the source image may be in a format not supported by OpenMPF. In this case, the value of
<code>LINKED_MEDIA_HASH</code> can be set to the source image, but the rest of the job creation request would specify
the <code>media.path</code> and <code>media.mediaMetadata</code> for the transcoded version of that image.</li>
the <code>media.mediaUri</code> and <code>media.metadata</code> for the transcoded version of that image.</li>
</ul>
<h3>Output Changed Counter</h3>

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 @@ -380,5 +380,5 @@ <h1 id="overview">Overview</h1>

<!--
MkDocs version : 0.17.5
Build Date UTC : 2023-05-10 01:08:58
Build Date UTC : 2023-07-05 20:43:29
-->
2 changes: 1 addition & 1 deletion docs/site/search/search_index.json
View file
Open in desktop

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions docs/site/sitemap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,127 +2,127 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Release-Notes/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/License-And-Distribution/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Acknowledgements/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Install-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Admin-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/User-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Media-Segmentation-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Feed-Forward-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Derivative-Media-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Object-Storage-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Markup-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/TiesDb-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/REST-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Component-API-Overview/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Component-Descriptor-Reference/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/CPP-Batch-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Python-Batch-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Java-Batch-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/GPU-Support-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Contributor-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Development-Environment-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Node-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Workflow-Manager-Architecture/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/CPP-Streaming-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-07-05</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>