From 4656d7a63e9e46c8f66214a9816e5153f473136c Mon Sep 17 00:00:00 2001 From: Rick Larsen Date: Thu, 28 Oct 2021 08:15:11 -0700 Subject: [PATCH] edits to docs to remove latin abbreviations (#6640) (#6647) --- .../catalog-framework-intro.adoc | 2 +- .../standard-catalog-framework.adoc | 4 ++-- .../content/_architectures/_data/data-intro.adoc | 2 +- .../_architectures/_eventing/eventing-intro.adoc | 2 +- .../_operations/operations-intro.adoc | 2 +- .../_architectures/_queries/filterbuilder-api.adoc | 2 +- .../_architectures/_resources/content-item.adoc | 2 +- .../external-ws-s-sts-support.adoc | 2 +- .../security-expansion-service.adoc | 2 +- .../_securityFramework/security-filtering.adoc | 2 +- .../security-ldap-embedded-server.adoc | 14 +++++++------- .../_architectures/_securityFramework/subject.adoc | 2 +- .../_transformers/tika-input-xformer.adoc | 2 +- .../_devComponents/custom-action-components.adoc | 2 +- .../_devComponents/custom-applications.adoc | 4 ++-- .../_devComponents/custom-resource-readers.adoc | 2 +- .../_devComponents/default-attribute-values.adoc | 6 +++--- .../global-attribute-validators.adoc | 2 +- .../_endpoints/opensearch-endpoint.adoc | 6 +++--- .../_integrating/_eventing/subscriptions.adoc | 6 +++--- .../_coreConcepts/resources-intro.adoc | 8 ++++---- .../content/_introduction/documentation-notes.adoc | 6 +++--- .../_managing/_configuring/config-templates.adoc | 2 +- .../_configuring/configuration-files.adoc | 5 +++-- .../_configuring/configuring-guest-access.adoc | 2 +- .../_managing/_configuring/configuring-oidc.adoc | 2 +- .../_configuring/connecting-to-sources.adoc | 4 ++-- .../_managing/_configuring/enabling-ssl.adoc | 2 +- .../_configuring/environment-hardening.adoc | 4 ++-- .../_managing/_configuring/global-settings.adoc | 6 +++--- .../_managing/_configuring/securing-idp-sp.adoc | 2 +- .../_configuring/updating-system-users.adoc | 2 +- .../_managing/_installing/ie11-configuration.adoc | 2 +- .../_managing/_installing/install-with-zip.adoc | 4 ++-- .../_managing/_running/catalog-commands.adoc | 2 +- .../content/_managing/_running/ddf-service.adoc | 5 ++++- .../_managing/_running/troubleshooting.adoc | 2 +- .../_quickstart/quickstart-certificates.adoc | 12 ++++++------ .../_tables/DDF_Custom_Mime_Type_Resolver.adoc | 2 +- .../content/_reference/_tables/KmlEndpoint.adoc | 2 +- .../_tables/Metacard_S3_Storage_Route.adoc | 2 +- .../_reference/_tables/landingpage.properties.adoc | 2 +- .../_reference/_tables/spatial.kml.style.adoc | 4 ++-- 43 files changed, 78 insertions(+), 74 deletions(-) diff --git a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc index 07163104da8e..cd8f572423bd 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/catalog-framework-intro.adoc @@ -173,7 +173,7 @@ If the requested product is not in the cache, the product is retrieved from the The caching to a local file of the product and the streaming of the product to the client are done simultaneously so that the client does not have to wait for the caching to complete before receiving the product. If errors are detected during the caching, caching of the product will be abandoned, and the product will be returned to the client.  -The Catalog Framework attempts to detect any network problems during the product retrieval, e.g., long pauses where no bytes are read implying a network connection was dropped. +The Catalog Framework attempts to detect any network problems during the product retrieval, for example, long pauses where no bytes are read implying a network connection was dropped. (The amount of time defined as a "long pause" is configurable, with the default value being five seconds.) The Catalog Framework will attempt to retrieve the product up to a configurable number of times (default = three), waiting for a configurable amount of time (default = 10 seconds) between each attempt, trying to successfully retrieve the product. If the Catalog Framework is unable to retrieve the product, an error message is returned to the client. diff --git a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/standard-catalog-framework.adoc b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/standard-catalog-framework.adoc index 960843fed0ee..b9b7345f093b 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/standard-catalog-framework.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_catalogFrameworks/standard-catalog-framework.adoc @@ -21,10 +21,10 @@ Use this framework if: It is possible to have only remote Sources configured with no local `CatalogProvider` configured and be able to execute queries to specific remote sources by specifying the site name(s) in the query request. The Standard Catalog Framework also maintains a list of `ResourceReaders` for resource retrieval operations. -A resource reader is matched to the scheme (i.e., protocol, such as `file://`) in the URI of the resource specified in the request to be retrieved. +A resource reader is matched to the scheme (the protocol, such as `file://`) in the URI of the resource specified in the request to be retrieved. Site information about the catalog provider and/or any federated source(s) can be retrieved using the Standard Catalog Framework. -Site information includes the source's name, version, availability, and the list of unique content types currently stored in the source (e.g., NITF). +Site information includes the source's name, version, availability, and the list of unique content types currently stored in the source (such as NITF). If no local catalog provider is configured, the site information returned includes site info for the catalog framework with no content types included. == Installing the Standard Catalog Framework diff --git a/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc index d852ecd88974..d389d3ae673b 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_data/data-intro.adoc @@ -83,7 +83,7 @@ Required attributes must be the base of all extensible metacard types. [WARNING] ==== Not all <<{managing-prefix}catalog_providers,Catalog Providers>> support extensible metacards. -Nevertheless, each Catalog Provider should at least have support for the default `MetacardType`; i.e., it should be able to store and query on the attributes and attribute formats specified by the default metacard type. +Nevertheless, each Catalog Provider should at least have support for the default `MetacardType`. That is, it should be able to store and query on the attributes and attribute formats specified by the default metacard type. Catalog providers are neither expected nor required to store attributes that are not in a given metacard's type. Consult the documentation of the Catalog Provider in use for more information on its support of extensible metacards. diff --git a/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc index 453d5458e707..29dc2ce2925c 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_eventing/eventing-intro.adoc @@ -35,7 +35,7 @@ The ((Eventing)) capability of the Catalog allows endpoints (and thus external u Notably, the Catalog allows event evaluation on both the previous value (if available) and new value of a Metacard when an update occurs. -Eventing allows ${branding}s to receive events on operations (e.g. create, update, delete) based on particular queries or actions. +Eventing allows ${branding}s to receive events on operations (such as create, update, delete) based on particular queries or actions. Once subscribed, users will receive notifications of events such as update or create on any source. == Eventing Components diff --git a/distribution/docs/src/main/resources/content/_architectures/_operations/operations-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_operations/operations-intro.adoc index 4acca9a6961a..ae71dc0c18c1 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_operations/operations-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_operations/operations-intro.adoc @@ -35,7 +35,7 @@ The Catalog provides the capability to query, create, update, and delete metacar Each of these operations follow a request/response paradigm. The request is the input to the operation and contains all of the input parameters needed by the Catalog Framework's operation to communicate with the Sources. The response is the output from the execution of the operation that is returned to the client, which contains all of the data returned by the sources. -For each operation there is an associated request/response pair, e.g., the `QueryRequest` and `QueryResponse` pair for the Catalog Framework's query operation. +For each operation there is an associated request/response pair. For example, the `QueryRequest` and `QueryResponse` pair for the Catalog Framework's query operation. All of the request and response objects are extensible in that they can contain additional key/value properties on each request/response. This allows additional capability to be added without changing the Catalog API, helping to maintain backwards compatibility. diff --git a/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc b/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc index da833b4361bd..6586a80b6f38 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_queries/filterbuilder-api.adoc @@ -32,4 +32,4 @@ Filters use a number of boolean operators. Filters can be based on specific attributes. -`FilterBuilder.attribute(String attributeName)`:: begins a fluent API for creating an Attribute-based Filter, i.e., a Filter that matches on Metacards with Attributes of a particular value. +`FilterBuilder.attribute(String attributeName)`:: begins a fluent API for creating an Attribute-based Filter, which is a Filter that matches on Metacards with Attributes of a particular value. diff --git a/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc b/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc index d5e543b1b7ec..49c4d35fa647 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_resources/content-item.adoc @@ -7,5 +7,5 @@ :summary: Content Item. ((Content Item)) is the domain object populated by the Storage Provider that represents the information about the content to be stored or content that has been stored in the Storage Provider. -A `ContentItem` encapsulates the content's globally unique ID, mime type, and input stream (i.e., the actual content). +A `ContentItem` encapsulates the content's globally unique ID, mime type, and input stream (that is, the actual content). The unique ID of a `ContentItem` will always correspond to a Metacard ID. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc index 8a0f0f31023e..a718f5d6f357 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/external-ws-s-sts-support.adoc @@ -15,6 +15,6 @@ Use these auth types when connecting to a non-${branding} STS or if ignoring rea === Security STS Address Provider (((Security STS Address Provider))) -This allows one to select which STS address will be used (e.g. in SOAP sources) for clients of this service. +This allows one to select which STS address will be used (for example, in SOAP sources) for clients of this service. Default is off (internal). diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc index ec26bca79e4b..dd34723caf12 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-expansion-service.adoc @@ -45,7 +45,7 @@ The result is returned to the caller. |=== .Included Expansions -Note that the rules listed for each key are processed in order, so they may build upon each other, i.e., a new value from the new replacement string may be expanded by a subsequent rule. +Note that the rules listed for each key are processed in order, so they may build upon each other. That is, a new value from the new replacement string may be expanded by a subsequent rule. In the example `Location:Goodyear` would expand to `Goodyear AZ USA` and `Title:VP-Sales` would expand to `VP-Sales VP Sales`. To use the expansion service, modify the following two files within the `${home_directory}/etc/pdp` directory: diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc index 85033c8673d6..b43d27ac2eab 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-filtering.adoc @@ -10,7 +10,7 @@ ((Metacard filtering)) is performed by the <<{developing-prefix}filter_plugin,Filter Plugin>> after a query has been performed, but before the results are returned to the requestor. -Each metacard result will contain security attributes that are populated by the CatalogFramework based on the PolicyPlugins (Not provided! You must create your own plugin for your specific metadata!) that populates this attribute. +Each metacard result will contain security attributes that are populated by the CatalogFramework based on the PolicyPlugins that populates this attribute. (These plugins are NOT provided by default. You must create your own plugin for your specific metadata) The security attribute is a HashMap containing a set of keys that map to lists of values. The metacard is then processed by a filter plugin that creates a `KeyValueCollectionPermission` from the metacard's security attribute. This permission is then checked against the user subject to determine if the subject has the correct claims to view that metacard. diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc index f2029c8e2f0f..7b362c62d388 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/security-ldap-embedded-server.adoc @@ -99,7 +99,7 @@ The Embedded LDAP application contains an LDAP server (OpenDJ version 2.6.2) tha |`testuser2` |`password2` -|  +| |General test user for authentication |`nromanova` @@ -229,8 +229,8 @@ The default schemas loaded into the LDAP instance are the same defaults that com === Starting and Stopping the Embedded LDAP -The embedded LDAP application installs a feature with the name `ldap-embedded`. -Installing and uninstalling this feature will start and stop the embedded LDAP server. +The embedded LDAP application installs a feature with the name `ldap-embedded`. +Installing and uninstalling this feature will start and stop the embedded LDAP server. This will also install a fresh instance of the server each time. If changes need to persist, stop then start the `embedded-ldap-opendj` bundle (rather than installing/uninstalling the feature). @@ -241,7 +241,7 @@ If ${branding} is stopped while the LDAP feature is installed and started, it wi Current limitations for the embedded LDAP instances include: -* Inability to store the LDAP files/storage outside of the ${branding} installation directory. This results in any LDAP data (i.e., LDAP user information) being lost when the `ldap-embedded` feature is uninstalled. +* Inability to store the LDAP files/storage outside of the ${branding} installation directory. This results in any LDAP data (that is, LDAP user information) being lost when the `ldap-embedded` feature is uninstalled. * Cannot be run standalone from ${branding}. In order to run `embedded-ldap`, the ${branding} must be started. === External Links for the Embedded LDAP @@ -260,11 +260,11 @@ Download https://backstage.forgerock.com/downloads/OpenDJ/OpenDJ%20Enterprise/2. === Using the Admin Tools -The admin tools are located in `/bat` for Windows and `/bin` for `*nix`.  +The admin tools are located in `/bat` for Windows and `/bin` for `*nix`. These tools can be used to administer both local and remote LDAP servers by setting the *host* and *port* parameters appropriately. -In this example, the user *Bruce Banner (uid=bbanner)* is disabled using the *manage-account* command on Windows. +In this example, the user *Bruce Banner (uid=bbanner)* is disabled using the *manage-account* command on Windows. Run *manage-account --help* for usage instructions. .Example Commands for Disabling/Enabling a User's Account @@ -329,7 +329,7 @@ Account Is Disabled: false ---- -Notice `Account Is Disabled: false` in the listing. +Notice `Account Is Disabled: false` in the listing. .Verifying an Account is Enabled ---- diff --git a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/subject.adoc b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/subject.adoc index d5d9e9d98cc7..96e8c90d8690 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_securityFramework/subject.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_securityFramework/subject.adoc @@ -12,7 +12,7 @@ The ((Subject)) is the key object in the security framework. Most of the workflow and implementations revolve around creating and using a Subject. The Subject object in ${branding} is a class that encapsulates all information about the user performing the current operation. -The Subject can also be used to perform permission checks to see if the calling user has acceptable permission to perform a certain action (e.g., calling a service or returning a metacard). +The Subject can also be used to perform permission checks to see if the calling user has acceptable permission to perform a certain action (for example, calling a service or returning a metacard). This class was made ${branding}-specific because the Shiro interface cannot be added to the Query Request property map. .Implementations of Subject: diff --git a/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-input-xformer.adoc b/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-input-xformer.adoc index ea20682c3c67..afb37e27683b 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-input-xformer.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_transformers/tika-input-xformer.adoc @@ -7,7 +7,7 @@ The ((Tika Input Transformer)) is the default input transformer responsible for translating Microsoft Word, Microsoft Excel, Microsoft PowerPoint, OpenOffice Writer, and PDF documents into Catalog records. This input transformer utilizes https://tika.apache.org[Apache Tika] to provide basic support for these mime types. -The metadata common to all these document types, e.g., creation date, author, last modified date, etc., is extracted and used to create the catalog record. +The metadata common to all these document types, such as creation date, author, last modified date, etc., is extracted and used to create the catalog record. The Tika Input Transformer's main purpose is to ingest these types of content into the Metadata Catalog. The Tika input transformer is most basic input transformer and the last to be invoked. diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc index fab207892be6..dda1abb0823f 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-action-components.adoc @@ -44,7 +44,7 @@ The following is a sample taxonomy: |Naming Convention |`catalog.data.metacard.view` -|Provides a valid URL to view a metacard. Format of data is not specified; i.e. the representation can be in XML, JSON, or other. +|Provides a valid URL to view a metacard. Format of data is not specified, so the representation can be in XML, JSON, or other. |Export as ... |`catalog.data.metacard.thumbnail` diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc index 16e143a901f4..a10c75b58118 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-applications.adoc @@ -93,7 +93,7 @@ An example of this is a properties file for the JDBC connection properties of a It is recommended that: * Any `data/configuration` files be placed under the `src/main/resources` directory of the maven project. -Sub-directories under `src/main/resources` can be used, e.g., `etc/security`. +Sub-directories under `src/main/resources` can be used, for example, `etc/security`. * The Maven project's pom file should be updated to attach each `data/configuration` file as an artifact (using the `build-helper-maven-plugin`). * Add each `data/configuration` file to the KAR file using the `` tag in the KAR's `features.xml` file. @@ -168,6 +168,6 @@ An example of this would be a properties file for the JDBC connection properties It is recommended that: * Any data/configuration files be placed under the `src/main/resources` directory of the maven project. -(Sub-directories under `src/main/resources` can also be used, e.g., `etc/security`) +(Sub-directories under `src/main/resources` can also be used, for example, `etc/security`) * The maven project's pom file should be updated to attach each data/configuration file as an artifact (using the `build-helper-maven-plugin`) * Add each data/configuration file to the KAR file by using the `` tag in the KAR's `features.xml` file diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc index 21504dfd7779..fac5918c2141 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/custom-resource-readers.adoc @@ -60,7 +60,7 @@ The `Map arguments` parameter is passed in to support any === Implement `retrieveResource()` -. Define supported schemes (e.g., file, http, etc.). +. Define supported schemes (such as file, http, etc.). . Check if the incoming URI matches a supported scheme. If it does not, throw `ResourceNotSupportedException`. .Example: diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc index d8cf7633a168..0a19bcea718e 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/default-attribute-values.adoc @@ -38,16 +38,16 @@ The value corresponding to the `attribute` key is the name of the attribute to w [NOTE] ==== -The attribute's default value must be of the same type as the attribute, but it has to be written as a string (i.e., enclosed in quotation marks) in the JSON file. +The attribute's default value must be of the same type as the attribute, but it has to be written as a string (enclosed in quotation marks) in the JSON file. -Dates must be UTC datetimes in the ISO 8601 format, i.e., `yyyy-MM-ddTHH:mm:ssZ` +Dates must be UTC datetimes in the ISO 8601 format, `yyyy-MM-ddTHH:mm:ssZ` ==== The `metacardTypes` key is optional. If it is left out, then the default attribute value will be applied to every metacard that has that attribute. It can be thought of as a 'global' default value. If the `metacardTypes` key is included, then its value must be a list of strings where each string is the name of a metacard type. In this case, the default attribute value will be applied only to metacards that match one of the types given in the list. [NOTE] ==== -In the event that an attribute has a 'global' default value as well as a default value for a specific metacard type, the default value for the specific metacard type will be applied (i.e., the more specific default value wins). +In the event that an attribute has a 'global' default value as well as a default value for a specific metacard type, the default value for the specific metacard type will be applied (the more specific default value wins). ==== Example: diff --git a/distribution/docs/src/main/resources/content/_developing/_devComponents/global-attribute-validators.adoc b/distribution/docs/src/main/resources/content/_developing/_devComponents/global-attribute-validators.adoc index c624c37fda9c..9190cc38b81b 100644 --- a/distribution/docs/src/main/resources/content/_developing/_devComponents/global-attribute-validators.adoc +++ b/distribution/docs/src/main/resources/content/_developing/_devComponents/global-attribute-validators.adoc @@ -46,7 +46,7 @@ Each object in the list of validators is the validator name and list of argument [WARNING] ==== -The value of the `arguments` key must always be an array of strings, even for numeric arguments, e.g. `["1", "10"]` +The value of the `arguments` key must always be an array of strings, even for numeric arguments, for example, `["1", "10"]` ==== diff --git a/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc b/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc index 98bbefc1aa48..924450d4a456 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_endpoints/opensearch-endpoint.adoc @@ -163,7 +163,7 @@ default: `5000` |`polygon` |`polygon` |Comma-delimited list of lat/lon (`EPSG:4326 (WGS84)` decimal degrees) pairs, in clockwise order around the polygon, where the last point is the same as the first in order to close the polygon. -(e.g. `-80,-170,0,-170,80,-170,80,170,0,170,-80,170,-80,-170`) +(for example, `-80,-170,0,-170,80,-170,80,170,0,170,-80,170,-80,-170`) |According to the OpenSearch Geo Specification this is *deprecated*. Use the `geometry` parameter instead. |`box` @@ -242,12 +242,12 @@ default: `300000` (5 minutes) |`type` |`type` -|Any valid datatype (e.g. `Text`) +|Any valid datatype (such as `Text`) |Specifies the type of data to search for. |`version` |`version` -|Comma-delimited list of strings (e.g. 20,30) +|Comma-delimited list of strings (such as 20,30) |Version values for which to search. |=== diff --git a/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc b/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc index a2a733714385..140b5613daf6 100644 --- a/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc +++ b/distribution/docs/src/main/resources/content/_integrating/_eventing/subscriptions.adoc @@ -67,10 +67,10 @@ The Standard Event Processor is an implementation of the Event Processor and p Events are generated by the ${ddf-catalog}Framework as metacards are created/updated/deleted and the Standard Event Processor is called since it is also a Post-Ingest Plugin. The Standard Event Processor checks each event against each subscription's criteria. -When an event matches a subscription's criteria the Standard Event Processor: +When an event matches a subscription's criteria, the Standard Event Processor invokes: -* invokes each pre-delivery plugin on the metacard in the event. -* invokes the `DeliveryMethod` operation corresponding to the type of event being processed, e.g., `created()` operation for the creation of a metacard. +* each pre-delivery plugin on the metacard in the event. +* the `DeliveryMethod` operation corresponding to the type of event being processed, such as the `created()` operation for the creation of a metacard. .Available Event Processor * <<{architecture-prefix}event_processor,Standard Event Processor>> diff --git a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/resources-intro.adoc b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/resources-intro.adoc index 203eae619e95..35c3be4a9e38 100644 --- a/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/resources-intro.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/_coreConcepts/resources-intro.adoc @@ -7,13 +7,13 @@ == {title} -The Catalog Framework can interface with storage providers to provide storage of resources to specific types of storage, e.g., file system, relational database, XML database. +The Catalog Framework can interface with storage providers to provide storage of resources to specific types of storage, such as file system, relational database, XML database. A default file system implementation is provided by default. -Storage providers act as a proxy between the Catalog Framework and the mechanism storing the content. -Storage providers expose the storage mechanism to the Catalog Framework. +Storage providers act as a proxy between the Catalog Framework and the mechanism storing the content. +Storage providers expose the storage mechanism to the Catalog Framework. Storage plugins provide pluggable functionality that can be executed either immediately before or immediately after content has been stored or updated. -Storage providers provide the capability to the Catalog Framework to create, read, update, and delete resources in the content repository. +Storage providers provide the capability to the Catalog Framework to create, read, update, and delete resources in the content repository. See <<{managing-prefix}data_management,Data Management>> for more information on specific file types supported by ${branding}. diff --git a/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc b/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc index 9b6b0726a2ec..f446303f5d1d 100644 --- a/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc @@ -28,7 +28,7 @@ Integrators will use the existing applications to support their external framewo Developers:: <<{developing-prefix}developing,Developing>> | -Developers will build or extend the functionality of the applications.  +Developers will build or extend the functionality of the applications. === Documentation Conventions @@ -46,14 +46,14 @@ Example: `ddf.catalog.CatalogFramework` ==== Hyperlinks -Some hyperlinks (e.g., `/admin`) within the documentation assume a locally running installation of ${ddf-branding}.  +Some hyperlinks (such as `/admin`) within the documentation assume a locally running installation of ${ddf-branding}. Simply change the hostname if accessing a remote host. Hyperlinks that take the user away from the ${branding} documentation are marked with an `external link` ({external-link}) icon. === Support -Questions about ${ddf-branding} should be posted to the https://groups.google.com/d/forum/ddf-users[ddf-users forum] {external-link} or https://groups.google.com/d/forum/ddf-developers[ddf-developers forum] {external-link}, where they will be responded to quickly by a member of the ${ddf-branding} team. +Questions about ${ddf-branding} should be posted to the https://groups.google.com/d/forum/ddf-users[ddf-users forum] {external-link} or https://groups.google.com/d/forum/ddf-developers[ddf-developers forum] {external-link}, where they will be responded to quickly by a member of the ${ddf-branding} team. ==== Documentation Updates diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/config-templates.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/config-templates.adoc index a8dd6958fe16..526148a19fc1 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/config-templates.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/config-templates.adoc @@ -12,7 +12,7 @@ A template file is provided for some configurable ${branding} items so that they The following steps define the procedure for configuring a new source or feature using a `config` file: . Copy/rename the provided template file in the ``etc/templates` directory to the `etc` directory. (Refer to the table above to determine correct template.) -.. Not required, but a good practice is to change the instance name (e.g., `OpenSearchSource.1.config`) of the file to something identifiable (`OpenSearchSource.remote-site-1.config`). +.. While not required, a good practice is to change the instance name (such as `OpenSearchSource.1.config`) of the file to something identifiable (`OpenSearchSource.remote-site-1.config`). . Edit the copied file to etc with the settings for the configuration. (Refer to the table above to determine the configurable properties). .. Consult the inline comments in the file for guidance on what to modify. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc index a41d851ccb00..541aabf85383 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuration-files.adoc @@ -16,7 +16,8 @@ The ${admin-console} can be re-enabled for additional configuration changes. ==== In an environment hardened for security purposes, access to the ${admin-console} or the ${command-console} might be denied and using the latter in such an environment may cause configuration errors. -It is necessary to configure ${branding} (e.g., providers, Schematron rulesets, etc.) using `.config` files. +For this reason,`.config` files (such as providers, Schematron rulesets, etc.) +are necessary to configure ${branding}. A template file is provided for some configurable ${branding} items so that they can be copied/renamed then modified with the appropriate settings. @@ -24,5 +25,5 @@ A template file is provided for some configurable ${branding} items so that they ==== If the ${admin-console} is enabled again, all of the configuration done via `.config` files will be loaded and displayed. However, note that the name of the `.config` file is not used in the ${admin-console}. -Rather, a universally unique identifier (UUID) is added when the ${branding} item was created and displays this UUID in the console (e.g., `OpenSearchSource.112f298e-26a5-4094-befc-79728f216b9b`) +Rather, a universally unique identifier (UUID) is added when the ${branding} item was created and displays this UUID in the console (for example, `OpenSearchSource.112f298e-26a5-4094-befc-79728f216b9b`) ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc index 328a24adc0ea..75f8b64624a4 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-guest-access.adoc @@ -12,7 +12,7 @@ Unauthenticated access to a secured ${branding} system is provided by the *Guest By default, ${branding} allows guest access. Because ${branding} does not know the identity of a Guest user, it cannot assign security attributes to the Guest. -The administrator must configure the attributes and values (i.e. the "claims") to be assigned to Guests. +The administrator must configure the attributes and values (the "claims") to be assigned to Guests. The Guest Claims become the default minimum attributes for every user, both authenticated and unauthenticated. Even if a user claim is more restrictive, the guest claim will grant access, so ensure the guest claim is only as permissive as necessary. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc index 5ab98b442996..845f2442e6e9 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/configuring-oidc.adoc @@ -45,5 +45,5 @@ To configure a source to use OAuth 2.0, under the source's configuration, [NOTE] ==== -If the system ${branding} is federating with is a ${branding}, the ${branding} receiving the federated request should be connected to an external IdP and have `/services` protected by that IdP (i.e. have /service=OIDC`). +If ${branding} is federating with another ${branding}, the ${branding} receiving the federated request should be connected to an external IdP and have `/services` protected by that IdP (that is, have `/service=OIDC`). ==== diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-sources.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-sources.adoc index 62980c6ad125..c984d449f3bd 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-sources.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/connecting-to-sources.adoc @@ -11,7 +11,7 @@ A *source* is a system consisting of a catalog containing Metacards. ((Catalog sources)) are used to connect Catalog components to data sources, local and remote. -Sources act as proxies to the actual external data sources, e.g., a RDBMS database or a NoSQL database. +Sources act as proxies to the actual external data sources, such as an RDBMS database or a NoSQL database. .Types of Sources ((Remote Source)):: Read-only data sources that support query operations but cannot be used to create, update, or delete metacards. @@ -26,6 +26,6 @@ Therefore, a ${ddf-catalog} can also act as a federated source to another ${ddf- [[_catalog_providers]]((Catalog Providers)):: A Catalog Provider is used to interact with data providers, such as files systems or databases, to query, create, update, or delete data. The provider also translates between ${branding} objects and native data formats. + -All sources, including federated source and connected source, support queries, but a Catalog provider also allows metacards to be created, updated, and deleted. A Catalog provider typically connects to an external application or a storage system (e.g., a database), acting as a proxy for all catalog operations. +All sources, including federated source and connected source, support queries, but a Catalog provider also allows metacards to be created, updated, and deleted. A Catalog provider typically connects to an external application or a storage system (such as a database), acting as a proxy for all catalog operations. [[_catalog_stores]]((Catalog Stores)):: A Catalog Store is an editable store that is either local or remote. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc index 5d6132b597d4..59000a533d8f 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/enabling-ssl.adoc @@ -20,7 +20,7 @@ The following values can be set: |`javax.net.ssl.trustStore` |`etc/keystores/serverTruststore.jks` -|The java keystore that contains the trusted public certificates for Certificate Authorities (CA's) that can be used to validate SSL Connections for outbound TLS/SSL connections (e.g. HTTPS). +|The java keystore that contains the trusted public certificates for Certificate Authorities (CAs) that can be used to validate SSL Connections for outbound TLS/SSL connections (such as HTTPS). When making outbound secure connections a handshake will be done with the remote secure server and the CA that is in the signing chain for the remote server's certificate must be present in the trust store for the secure connection to be successful. |`javax.net.ssl.trustStorePassword` diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc index 5a7da2d8f417..b1b37be6c7fc 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/environment-hardening.adoc @@ -32,7 +32,7 @@ a|* Stop the management feature using the command line console: `feature:stop ma |File System Access |tampering, information disclosure, and denial of service -a|Set OS File permissions under the `${home_directory}` directory (e.g. `/deploy`, `/etc`) to ensure unauthorized viewing and writing is not allowed. +a|Set OS File permissions under the `${home_directory}` directory (for example, `/deploy` or `/etc`) to ensure unauthorized viewing and writing is not allowed. If Caching is installed: @@ -65,7 +65,7 @@ To allow direct remote access to the ${branding} shell from any host, change the SSH can also be authenticated and authorized through an external Realm, such as LDAP. This can be accomplished by editing the `${home_directory}/etc/org.apache.karaf.shell.cfg` file and setting the -value for `sshRealm`, e.g. to `ldap`. No restart of ${branding} is necessary after this change. +value for `sshRealm` to the appropriate realm, such as `ldap`. No restart of ${branding} is necessary after this change. By definition, all connections over SSH will be authenticated and authorized and secure from eavesdropping. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc index 332fc66be3a8..614bf8834766 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/global-settings.adoc @@ -317,7 +317,7 @@ The interval is measured in seconds. |String |Files uploaded with these bad file extensions will have their file names sanitized before being saved -E.g. sample_file.exe will be renamed to sample_file.bin upon ingest +For example, `sample_file.exe` will be renamed to `sample_file.bin` upon ingest |.exe, .jsp, .html, @@ -394,9 +394,9 @@ E.g. sample_file.exe will be renamed to sample_file.bin upon ingest |File names flagged as potentially dangerous to the host system or external clients |bad.files |String -|Files uploaded with these bad file names will have their file names sanitized before being saved +|Files uploaded with these bad file names will have their file names sanitized before being saved. -E.g. crossdomain.xml will be renamed to file.bin upon ingest +For example, `crossdomain.xml` will be renamed to `file.bin` upon ingest |crossdomain.xml, clientaccesspolicy.xml, .htaccess, diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/securing-idp-sp.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/securing-idp-sp.adoc index 3b0282658db9..4f93f0534070 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/securing-idp-sp.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/securing-idp-sp.adoc @@ -27,7 +27,7 @@ The Web SSO bundles are installed by default with the ${ddf-security} applicatio .. An HTTPS URL (https://) .. A file URL (file:) .. An XML block to refer to desired metadata -... (e.g., \${secure_url}/services/idp/login/metadata) +... (for example, \${secure_url}/services/idp/login/metadata) .SAML 2.0 Web SSO Client (SP) example.xml [source,xml,linenums] diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc index 99ad71565931..86de457de3c1 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/updating-system-users.adoc @@ -57,7 +57,7 @@ The following attribute values are not allowed: * `null` * `""` -* a non-String (e.g. `100`, `false`) +* a non-String (for example, `100` or `false`) * an array including any of the above * `[]` diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/ie11-configuration.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/ie11-configuration.adoc index f33e0f9d9c65..66f18199e9b3 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/ie11-configuration.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/ie11-configuration.adoc @@ -12,7 +12,7 @@ Below are steps listing all of the changes that ${branding} requires to run on I . In the IE11 `Settings` > `Compatibility View Settings` dialog, un-check `Display intranet sites in Compatibility View`. . In the `Settings` > `Internet Options` > `Security` tab, `Local intranet` zone: -.. Click the `Sites` > `Advanced` button, add the current host name to the list, e.g., https://windows-host-name.domain.edu, and close the dialog. +.. Click the `Sites` > `Advanced` button, add the current host name to the list, such as \https://windows-host-name.domain.edu, and close the dialog. .. Make sure the security level for the `Local intranet` zone is set to `Medium-low` in `Custom level...`. ... `Enable Protected Mode` is checked by default, but it may need to be disabled if the above changes do not fully resolve access issues. . Restart the browser. diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc index 4fbee8925485..aecad9b95b55 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/install-with-zip.adoc @@ -33,10 +33,10 @@ mkdir new_installation + .. Use a Non-`root` User on *NIX. (Windows users skip this step) + -It is recommended that the `root` user create a new install directory that can be owned by a non-`root` user (e.g., ${branding}_USER). +It is recommended that the `root` user create a new install directory that can be owned by a non-`root` user (such as ${branding}_USER). This can be a new or existing user. This ${branding}_USER can now be used for the remaining installation instructions. -.. Create a new group or use an existing group (e.g., ${branding}_GROUP) (Windows users skip this step) +.. Create a new group or use an existing group (such as ${branding}_GROUP) (Windows users skip this step) + .Example: Add New Group on *NIX ---- diff --git a/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc b/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc index 4328410d6ea5..7c9f0be738e2 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/catalog-commands.adoc @@ -78,7 +78,7 @@ Provides a list of environment variables. .catalog:dump Options The `catalog:dump` command provides selective export of metacards based on date ranges. The `--created-after` and `--created-before` options allow filtering on the date and time that the metacard was created, while `--modified-after` and `--modified-before` options allow filtering on the date and time that the metacard was last modified (which is the created date if no other modifications were made). -These date ranges are exclusive (i.e., if the date and time match exactly, the metacard will not be included). +These date ranges are exclusive (that is, if the date and time match exactly, the metacard will not be included). [[_date_filtering_options]]The date filtering options (`--created-after`, `--created-before`, `--modified-after`, and `--modified-before`) can be used in any combination, with the export result including only metacards that match all of the provided conditions. If no date filtering options are provided, created and modified dates are ignored, so that all metacards match. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc b/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc index a4d4b29934aa..796e76cb4234 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/ddf-service.adoc @@ -17,16 +17,19 @@ When ${branding} is started using Karaf Wrapper, new `wrapper.log` and `wrapper. ==== When installing as a service on *NIX, do not use spaces in the path for ${home_directory} as the service scripts that are generated by the wrapper cannot handle spaces. ==== + [WARNING] ==== Ensure that JAVA_HOME is properly set before beginning this process. See <<{introduction-prefix}java_requirements,Java Requirements>>. ==== + [WARNING] ==== Install a profile on the first start of the system. -Attempting to install a profile after the first start (i.e. when starting as a service) may cause issues. +Attempting to install a profile after the first start (such as when starting as a service) may cause issues. ==== + [WARNING] ==== If using the default Security Manager, the service should be ran as the user who installed the service in order to avoid permission issues. diff --git a/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc b/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc index b878e5b4fedc..3a3b9d7ee882 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/troubleshooting.adoc @@ -78,7 +78,7 @@ This can be caused when another ${branding} is not properly shut down. |Perform one or all of the following recommended solutions, as necessary. * Wait for proper shutdown of ${branding} prior to starting a new instance. -* Verify running java.exe are not ${branding} (e.g., kill/close if necessary). +* Verify running java.exe are not ${branding} (and use kill/close commands, if necessary). * Utilize automated start/stop scripts to run ${branding} as a service. 2+^|*Troubleshooting TLS/SSL Connectivity* diff --git a/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc b/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc index bf1536e456ca..9701793f189c 100644 --- a/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc +++ b/distribution/docs/src/main/resources/content/_quickstart/quickstart-certificates.adoc @@ -45,9 +45,9 @@ For *NIX, use the `CertNew.sh` script. where: -* `` represents a fully qualified common name (e.g. "", where could be something like cluster.yoyo.com) -* `` represents a distinguished name as a comma-delimited string (e.g. "c=US, st=California, o=Yoyodyne, l=San Narciso, cn=") -* `` represents optional subject alternative names to be added to the generated certificate (e.g. "DNS:,DNS:node1.,DNS:node2."). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: +* `` represents a fully qualified common name (such as "", where could be something like cluster.yoyo.com) +* `` represents a distinguished name as a comma-delimited string (such as "c=US, st=California, o=Yoyodyne, l=San Narciso, cn=") +* `` represents optional subject alternative names to be added to the generated certificate (such as "DNS:,DNS:node1.,DNS:node2."). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: ** `email` - email subject ** `URI` - uniformed resource identifier ** `RID` - registered id @@ -66,9 +66,9 @@ For Windows, use the `CertNew.cmd` script. where: -* `` represents a fully qualified common name (e.g. "", where could be something like cluster.yoyo.com) -* `` represents a distinguished name as a comma-delimited string (e.g. "c=US, st=California, o=Yoyodyne, l=San Narciso, cn=") -* `` represents optional subject alternative names to be added to the generated certificate (e.g. "DNS:,DNS:node1.,DNS:node2."). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: +* `` represents a fully qualified common name (such as"", where could be something like cluster.yoyo.com) +* `` represents a distinguished name as a comma-delimited string (such as "c=US, st=California, o=Yoyodyne, l=San Narciso, cn=") +* `` represents optional subject alternative names to be added to the generated certificate (such as "DNS:,DNS:node1.,DNS:node2."). The format for subject alternative names is similar to the OpenSSL X509 configuration format. Supported tags are: ** `email` - email subject ** `URI` - uniformed resource identifier ** `RID` - registered id diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/DDF_Custom_Mime_Type_Resolver.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/DDF_Custom_Mime_Type_Resolver.adoc index 088797870969..f765a84c3316 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/DDF_Custom_Mime_Type_Resolver.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/DDF_Custom_Mime_Type_Resolver.adoc @@ -33,7 +33,7 @@ |File Extensions to Mime Types |customMimeTypes |String -|List of key/value pairs where key is the file extension and value is the mime type, e.g., nitf=image/nitf +|List of key/value pairs where key is the file extension and value is the mime type, for example, `nitf=image/nitf` |null |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc index e4cbc4caef89..4aabec2a3387 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/KmlEndpoint.adoc @@ -19,7 +19,7 @@ |Style Document |styleUrl |String -|KML Document containing custom styling. This will be served up by the KmlEndpoint. (e.g. file:///path/to/kml/style/doc.kml) +|KML Document containing custom styling. This will be served up by the KmlEndpoint. (for example, \file:///path/to/kml/style/doc.kml) | |false diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Metacard_S3_Storage_Route.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Metacard_S3_Storage_Route.adoc index ed5e3337ad0f..e02aee0bbe21 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Metacard_S3_Storage_Route.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Metacard_S3_Storage_Route.adoc @@ -77,7 +77,7 @@ |String |Template specifying the S3 object key for the metacard data. The template uses handlebars syntax. -Use [] to reference dotted attributes e.g. {{[attribute.name]}}. +Use [] to reference dotted attributes, as in {{[attribute.name]}}. If you wish to include date, you would use {{dateFormat created yyyy-MM-dd}} |data/backup/metacard/{{substring id 0 3}}/{{substring id 3 6}}/{{id}}.xml diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc index 4597803da160..704b9f206801 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/landingpage.properties.adoc @@ -75,7 +75,7 @@ |Additional Links |links |String -|Additional links to be displayed on the landing page. Use the format , (e.g. `example`, `http://www.example.com`). Empty entries are ignored. +|Additional links to be displayed on the landing page. Use the format , (such as `example,http://www.example.com`). Empty entries are ignored. | |yes |=== diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/spatial.kml.style.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/spatial.kml.style.adoc index 61f42bc7601b..e4cc411fbd59 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/spatial.kml.style.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/spatial.kml.style.adoc @@ -19,7 +19,7 @@ |Attribute Name |attributeName |String -|The name of the Metacard Attribute to match against. e.g. title, metadata-content-type, etc +|The name of the Metacard Attribute to match against. For example, title, metadata-content-type, etc |null |true @@ -33,7 +33,7 @@ |Style URL |styleUrl |String -|The full qualified URL to the KML Style. e.g. http://example.com/styles#myStyle +|The full qualified URL to the KML Style, for example, \http://example.com/styles#myStyle |null |true