-
Notifications
You must be signed in to change notification settings - Fork 180
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.
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
DDF-5606 Standardized references to 'resources' in documentation #5608
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -83,7 +83,6 @@ If no sort policy is defined for a particular search, the temporal policy will a | |
|
||
The ${branding} is used to catalog resources. | ||
A Resource is a URI-addressable entity that is represented by a Metacard. | ||
Resources may also be known as products or data. | ||
Resources may exist either locally or on a remote data store. | ||
|
||
.Examples of Resources | ||
|
@@ -101,30 +100,16 @@ Resources may exist either locally or on a remote data store. | |
* ${branding} REST | ||
|
||
The Query Service Endpoint, the Catalog Framework, and the `CatalogProvider` are key | ||
components for processing a retrieve product request. | ||
The Endpoint bundle contains a Web service that exposes the interface to retrieve products, also referred to as Resources. | ||
components for processing a retrieve resource request. | ||
The Endpoint bundle contains a Web service that exposes the interface to retrieve resources. | ||
The Endpoint calls the `CatalogFramework` to execute the operations of its specification. | ||
The `CatalogFramework` relies on the Sources to execute the actual product retrieval. | ||
Optional PreResource and PostResource Catalog Plugins may be invoked by the `CatalogFramework` to modify the product retrieval request/response prior to the Catalog Provider processing the request and providing the response. | ||
It is possible to retrieve products from specific remote Sources by specifying the site name(s) in the request. | ||
The `CatalogFramework` relies on the Sources to execute the actual resource retrieval. | ||
Optional `PreResource` and `PostResource` Catalog Plugins may be invoked by the `CatalogFramework` to modify the resource retrieval request/response prior to the Catalog Provider processing the request and providing the response. | ||
It is possible to retrieve resources from specific remote Sources by specifying the site name(s) in the request. | ||
|
||
.Product Caching | ||
[NOTE] | ||
==== | ||
Existing ${branding} clients are able to leverage product caching due to the product cache being implemented in the ${branding}. | ||
Enabling the product cache is an administrator function. | ||
|
||
Product Caching is enabled by default. | ||
==== | ||
|
||
To configure product caching: | ||
|
||
. Navigate to the *${admin-console}*. | ||
. Select ${ddf-catalog}. | ||
. Select *Configuration*. | ||
. Select *Resource Download Settings*. | ||
|
||
See <<{reference-prefix}ddf.catalog.resource.download.ReliableResourceDownloadManager,Resource Download Settings configurations>> for all possible configurations. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ❓ Should we include a link to https://github.com/codice/ddf/pull/5608/files#diff-de98e1cea538c46c6ad3f393cd560bd7R1? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure. Can you explain? |
||
Existing ${branding} clients are able to leverage product caching due to the product cache being implemented in the ${branding}. | ||
|
||
.Product Retrieval Request | ||
[ditaa,product_retrieval_request,png] | ||
|
@@ -165,11 +150,11 @@ See <<{reference-prefix}ddf.catalog.resource.download.ReliableResourceDownloadMa | |
|
||
===== Notifications and Activities | ||
|
||
${branding} can send/receive notifications of "Activities" occuring in the system. | ||
${branding} can send/receive notifications of "Activities" occurring in the system. | ||
|
||
====== Notifications | ||
|
||
Currently, the notifications provide information about product retrieval only. | ||
Currently, the notifications provide information about resource retrieval only. | ||
|
||
====== Activities | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -165,8 +165,8 @@ It is possible to have only remote Sources configured and no local `CatalogProvi | |
|
||
===== Product Retrieval | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ✏️ I noticed There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I didn't change any of the configurations (metatypes, for example) under the scope of this PR and they use "Product" |
||
|
||
The Query Service Endpoint, the Catalog Framework, and the `CatalogProvider` are key components for processing a retrieve product request. | ||
The Endpoint bundle contains a Web service that exposes the interface to retrieve products, also referred to as Resources. | ||
The Query Service Endpoint, the Catalog Framework, and the `CatalogProvider` are key components for processing a resource retrieval request. | ||
The Endpoint bundle contains a Web service that exposes the interface to retrieve resources. | ||
The Endpoint calls the `CatalogFramework` to execute the operations of its specification. | ||
The `CatalogFramework` relies on the Sources to execute the actual product retrieval. | ||
Optional `PreResource` and `PostResource` Catalog Plugins may be invoked by the `CatalogFramework` to modify the product retrieval request/response prior to the Catalog Provider processing the request and providing the response. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
:title: Configuring Product Caching | ||
:type: configuration | ||
:status: published | ||
:parent: Configuring Data Management | ||
:order: 026 | ||
:summary: Enabling or disabling product caching. | ||
|
||
== {title} | ||
|
||
To configure product caching: | ||
|
||
. Navigate to the *${admin-console}*. | ||
. Select ${ddf-catalog}. | ||
. Select *Configuration*. | ||
. Select *Resource Download Settings*. | ||
. Select / Deselect *Enable Product Caching*. | ||
|
||
See <<{reference-prefix}ddf.catalog.resource.download.ReliableResourceDownloadManager,Resource Download Settings configurations>> for all possible configurations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ Should all of the "Product" headers (Product Retrieval, Product Retrieval Services, Product Cacheing, etc.) be changed to "Resource" as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The configurations for these in the code use Product, so I left them for now, but it'd be nice to change them up as well