DDF-5606 Standardized references to 'resources' in documentation #5608
Conversation
ricklarsen
added
📖 Documentation
docs-content
| @@ -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.
✏️ I noticed Product Caching seems to be different, but I wasn't sure about these (166, 171, 172)
There was a problem hiding this comment.
I didn't change any of the configurations (metatypes, for example) under the scope of this PR and they use "Product"
| 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 |
There was a problem hiding this comment.
❓ 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.
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
| . 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.
❓ Should we include a link to https://github.com/codice/ddf/pull/5608/files#diff-de98e1cea538c46c6ad3f393cd560bd7R1?
There was a problem hiding this comment.
I'm not sure. Can you explain?
|
build now |
|
Internal build has been scheduled, your results will be available at build completion. |
ricklarsen
force-pushed
the
DDF-5606-master
branch
from
df7035c to
07238f8
Compare
|
Refer to this link for build results (access rights to CI server needed): |
ricklarsen
force-pushed
the
DDF-5606-master
branch
from
07238f8 to
2a0abc1
Compare
ricklarsen
force-pushed
the
DDF-5606-master
branch
from
2a0abc1 to
e81d0e6
Compare
What does this PR do?
Changes, where possible, references to 'data products' to the more accurate 'data resources' or simply 'resources'
Select relevant component teams:
@codice/data
@codice/docs
Ask 2 committers to review/merge the PR and tag them here.
@ahoffer
@brendan-hofmann
@brjeter
@clockard
@lessarderic
@mcalcote
@pklinef
@ricklarsen - Documentation
@shaundmorris
How should this be tested?
review content
Any background context you want to provide?
Tried not to change references where the actual code being referenced uses the term 'product' instead of 'resource'
What are the relevant tickets?
Fixes: #5606
Checklist:
Notes on Review Process
Please see Notes on Review Process for further guidance on requirements for merging and abbreviated reviews.
Review Comment Legend: