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 86813d0d586e..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 @@ -4,7 +4,7 @@ :summary: Introduction to data and metadata sections. :order: 00 -.Catalog Architecture Diagram Data +.Catalog Architecture Diagram: Data [ditaa, catalog_architecture_data, png, ${image-width}] .... +------------------------------------------------------------+ @@ -136,8 +136,8 @@ The following blueprint snippet shows how to inject that service into another co The reference to this service can then be used to register new `MetacardTypes` or to lookup existing ones. -New `MetacardTypes` are typically registered by `CatalogProviders` or sources indicating they know how to persist, index, and query attributes from that type. -Endpoints or `InputTransformers` typically use the lookup functionality to access a `MetacardType` based on a parameter in the incoming metadata. +Typically, new `MetacardTypes` will be registered by `CatalogProviders` or sources indicating they know how to persist, index, and query attributes from that type. +Typically, Endpoints or `InputTransformers` will use the lookup functionality to access a `MetacardType` based on a parameter in the incoming metadata. Once the appropriate `MetacardType` is discovered and obtained from the registry, the component will know how to translate incoming raw metadata into a ${branding} Metacard. === Attributes diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/_plugin-template.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/_plugin-template.adoc new file mode 100644 index 000000000000..eb56652c12f9 --- /dev/null +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/_plugin-template.adoc @@ -0,0 +1,35 @@ +:type: plugin +:status: unpublished +:title: {plugin-name} +:link: {link} +:plugintypes: {plugintypes} +:summary: {summary} + +{description} + +== Related Components to {plugin-name} + +Replace this sentence with links to any related components, required or optional, that affect the operation of this plugin. + +== Installing the {plugin-name} + +The {plugin-name} {is || is not} installed by default with a standard installation in the ${app-name} application. + +If installed by default, delete this section. + +If not installed, update this section: +To install the {plugin-name} from the ${admin-console}: + +. Navigate to the *${admin-console}*. +. Select the *${ddf-catalog}* application. +. Select the *Configuration* tab. +. Select the *{plugin-name}*. + +== Configuring the {plugin-name} + +{configuration} + +== Usage Limitations of the {plugin-name} + +Delete header if none. + diff --git a/distribution/docs/src/main/resources/content/_architectures/_plugins/plugins-intro.adoc b/distribution/docs/src/main/resources/content/_architectures/_plugins/plugins-intro.adoc index 922a9093874d..14c96acab21d 100644 --- a/distribution/docs/src/main/resources/content/_architectures/_plugins/plugins-intro.adoc +++ b/distribution/docs/src/main/resources/content/_architectures/_plugins/plugins-intro.adoc @@ -4,7 +4,7 @@ :plugintypes: general :order: 00 -.Catalog Architecture Catalog Plugins +.Catalog Architecture: Catalog Plugins [ditaa, catalog_architecture_plugins, png,${image-width}] .... +------------------------------------------------------------+ 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 6445402a4e81..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 @@ -9,7 +9,7 @@ ((({title}))) This configuration works just like the STS Client Config for the internal STS, but produces standard requests instead of the custom ${branding} ones. -It supports two new auth types for the context policy manager, `WSSBASIC` and `WSSPKI`. +It supports two new auth types for the context policy manager, WSSBASIC and WSSPKI. Use these auth types when connecting to a non-${branding} STS or if ignoring realms. === Security STS Address Provider 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 4a4369e1028d..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 @@ -6,7 +6,7 @@ The ${branding} applications are a collection of OSGi bundles that contain configurations to be displayed in the ${admin-console}. The applications are defined in the ${etc/application-definitions} directory. -Any json file added to the ${etc/application-definitions} with name, description, and bundleLocations keys will be displayed in the ${admin-console}. +Any json file added to the ${etc/application-definitions} with name, description and bundleLocations keys will be displayed in the ${admin-console}. The application will only display if one of the bundles listed in the bundleLocations key is running or there is at least 1 plugin associated with that application running. A KAR file is a Karaf-specific archive format (*K*araf *AR*chive). 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 38db49838253..f446303f5d1d 100644 --- a/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc +++ b/distribution/docs/src/main/resources/content/_introduction/documentation-notes.adoc @@ -24,7 +24,7 @@ Use this section to navigate the various user interfaces available in ${branding Integrators:: <<{integrating-prefix}integrating,Integrating>> | -Integrators will use the existing applications to support their external frameworks. This section will provide details for finding, accessing, and using the components of ${branding}. +Integrators will use the existing applications to support their external frameworks. This section will provide details for finding, accessing and using the components of ${branding}. Developers:: <<{developing-prefix}developing,Developing>> | 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 36f771d02a7d..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 @@ -32,7 +32,7 @@ Only authorized users are then allowed to continue to the Search UI page. === Allowing Guest User Access Guest authentication must be enabled and configured to allow guest users. -Once the guest user is configured, the redaction and filtering of metadata is done for the guest user the same way it is done for normal users. +Once the guest user is configured, redaction and filtering of metadata is done for the guest user the same way it is done for normal users. To enable guest authentication for a context, use the <<{managing-prefix}configuring_the_web_context_policy_manager, Web Context Policy Manager>> configuration to select *Allow Guest Access*. diff --git a/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc b/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc index e472e159086a..032e3a88b512 100644 --- a/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_configuring/filter-policy-plugins.adoc @@ -7,6 +7,6 @@ == {title} -Several ((Policy Plugins)) for catalog filtering exist currently, <<{developing-prefix}metacard_attribute_security_policy_plugin,Metacard Attribute Security Policy Plugin>> and <<{developing-prefix}xml_attribute_security_policy_plugin,XML Attribute Security Policy Plugin>>. +Several ((Policy Plugins)) for catalog filtering exist currently: <<{developing-prefix}metacard_attribute_security_policy_plugin,Metacard Attribute Security Policy Plugin>> and <<{developing-prefix}xml_attribute_security_policy_plugin,XML Attribute Security Policy Plugin>>. These Policy Plugin implementations allow an administrator to easily add filtering capabilities to some standard Metacard types for all ${ddf-catalog} operations. These plugins will place policy information on the Metacard itself that allows the <<{developing-prefix}filter_plugin,Filter Plugin>> to restrict unauthorized users from viewing content they are not allowed to view. 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 513bbdc08332..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 @@ -105,7 +105,7 @@ If the hostname is changed during the install to something other than `localhost |Internal HTTPS Port |org.codice.ddf.system.httpsPort |String -a|The https port that the system uses. +|The https port that the system uses. NOTE: This *DOES* change the port the system runs on. |8993 @@ -114,7 +114,7 @@ NOTE: This *DOES* change the port the system runs on. |Internal HTTP Port |org.codice.ddf.system.HttpPort |String -a|The http port that the system uses. +|The http port that the system uses. NOTE: This *DOES* change the port the system runs on. |8181 @@ -123,7 +123,7 @@ NOTE: This *DOES* change the port the system runs on. |Internal Default Port |org.codice.ddf.system.port |String -a|The default port that the system uses. This should match either the above http or https port. +|The default port that the system uses. This should match either the above http or https port. NOTE: This *DOES* change the port the system runs on. |8993 @@ -150,7 +150,8 @@ a|The hostname or IP address used to advertise the system. Do not enter `localho If the hostname is changed during the install to something other than `localhost` a new keystore and truststore must be provided. See <<{managing-prefix}managing_keystores_and_certificates,Managing Keystores and Certificates>> for details. -NOTE: Does not change the address the system runs on. +NOTE: +Does not change the address the system runs on. |localhost |Yes @@ -158,7 +159,7 @@ NOTE: Does not change the address the system runs on. |HTTPS Port |org.codice.ddf.external.httpsPort |String -a|The https port used to advertise the system. +|The https port used to advertise the system. NOTE: This does not change the port the system runs on. |8993 @@ -167,7 +168,7 @@ NOTE: This does not change the port the system runs on. |External HTTP Port |org.codice.ddf.external.httpPort |String -a|The http port used to advertise the system. +|The http port used to advertise the system. NOTE: This does not change the port the system runs on. |8181 @@ -176,7 +177,7 @@ NOTE: This does not change the port the system runs on. |External Default Port |org.codice.ddf.external.port |String -a|The default port used to advertise the system. This should match either the above http or https port. +|The default port used to advertise the system. This should match either the above http or https port. NOTE: Does not change the port the system runs on. |8993 diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc index f19be7f249d1..3a468f69eb15 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/configure-single-sign-on.adoc @@ -7,7 +7,7 @@ .[[_configuring_sso]]Configure Single Sign On (SSO) **** -Configure Single Sign On method for SAML or OIDC. +Configure Single Sign On method: SAML or OIDC. (((Single Sign On, SSO))) .SAML SSO diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc index c1a3a63fa376..9608465bfff6 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/file-system-access.adoc @@ -73,7 +73,7 @@ Set directory permissions to protect the ${branding} from unauthorized access. The amount of memory allocated to the Java Virtual Machine host ${branding} by the operating system can be increased by updating the `setenv` script: -.Setenv Scripts (*NIX) +.Setenv Scripts: *NIX ---- ${home_directory}/bin/setenv Update the JAVA_OPTS -Xmx value @@ -81,7 +81,7 @@ ${home_directory}/bin/setenv-wrapper.conf Update the wrapper.java.additional -Xmx value ---- -.Setenv Scripts (Windows) +.Setenv Scripts: Windows ---- ${home_directory}/bin/setenv.bat Update the JAVA_OPTS -Xmx value @@ -96,7 +96,7 @@ By default, ${branding} prevents connections to JMX because the system is more s is not enabled. However, many monitoring tools require a JMX connection to the Java Virtual Machine. To enable JMX, update the setenv script: -.Setenv Scripts (*NIX) +.Setenv Scripts: *NIX ---- ${home_directory}/bin/setenv Remove -XX:+DisableAttachMechanism from JAVA_OPTS @@ -104,7 +104,7 @@ ${home_directory}/bin/setenv-wrapper.conf Comment out the -XX:+DisableAttachMechanism line and re-number remainder lines appropriately ---- -.Setenv Scripts (Windows) +.Setenv Scripts: Windows ---- ${home_directory}/bin/setenv.bat Remove -XX:+DisableAttachMechanism from JAVA_OPTS diff --git a/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc b/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc index a98e6f14befd..6b4beb52c580 100644 --- a/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_installing/initial-startup.adoc @@ -53,7 +53,7 @@ Bundle fragments are distinguished from other bundles in the command line consol Bundle fragments remain in the *Resolved* state and can never move to the *Active* state. ==== -.Example Bundle Fragment in the Command Line Console +.Example: Bundle Fragment in the Command Line Console ---- 96 | Resolved | 80 | 2.10.0.SNAPSHOT | DDF :: Platform :: PaxWeb :: Jetty Config, Hosts: 90 ---- 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 cd4bb4a094da..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 @@ -26,7 +26,7 @@ Do not use spaces in directory or file names of the `${home_directory}` path. For example, do not install in the default `Program Files` directory. ==== + -.Example Create a Directory (Windows and *NIX) +.Example: Create a Directory (Windows and *NIX) ---- mkdir new_installation ---- @@ -38,12 +38,12 @@ 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 (such as ${branding}_GROUP) (Windows users skip this step) + -.Example Add New Group on *NIX +.Example: Add New Group on *NIX ---- groupadd ${branding}_GROUP ---- + -.Example Switch User on *NIX +.Example: Switch User on *NIX ---- chown ${branding}_USER:${branding}_GROUP new_installation 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 b8f72818c97d..2ebaf784c10d 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 @@ -81,7 +81,7 @@ The `--created-after` and `--created-before` options allow filtering on the date 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. +If no date filtering options are provided, created and modified dates are ignored, so that all metacards match. .Date Syntax Supported dates are taken from the common subset of ISO8601, matching the datetime from the following syntax: diff --git a/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc b/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc index a734807feaaa..40581dcc4323 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/forms-commands.adoc @@ -8,7 +8,7 @@ == {title} ((System search)) provide a way to execute queries with pre-defined templates and search criteria. System search forms are loaded -via the system and are read-only. This command allows an administrator to ingest, modify, or remove system search forms within the system. +via the system and are read-only. This command allows an administrator to ingest, modify or remove system search forms within the system. .Loading Forms With Defaults ---- diff --git a/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc b/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc index 20c07b21d52a..d3f328f19346 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/monitoring.adoc @@ -61,7 +61,7 @@ In order to see the messages in the log, one must set the logging level for `org Other appenders can be selected and configured. -For more detail on configuring the log file and what is logged to the console see http://karaf.apache.org/manual/latest/#_log[Log] {external-link} in the Karaf documentation. +For more detail on configuring the log file and what is logged to the console see: http://karaf.apache.org/manual/latest/#_log[Karaf Documentation: Log] {external-link}. === Enabling HTTP Access Logging diff --git a/distribution/docs/src/main/resources/content/_managing/_running/starting-intro.adoc b/distribution/docs/src/main/resources/content/_managing/_running/starting-intro.adoc index 915be7208c07..e860da3aea47 100644 --- a/distribution/docs/src/main/resources/content/_managing/_running/starting-intro.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_running/starting-intro.adoc @@ -11,12 +11,12 @@ Follow the below steps to start and stop ${branding}. Run one of the start scripts from a command shell to start the distribution and open a local console: -.Start Script (*NIX) +.Start Script: *NIX ---- ${home_directory}/bin/${branding-lowercase} ---- -.Start Script (Windows) +.Start Script: Windows ---- ${home_directory}/bin/${branding-lowercase}.bat ---- diff --git a/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc b/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc index 916601d6206b..5647e47eb442 100644 --- a/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc +++ b/distribution/docs/src/main/resources/content/_managing/_securing/managing-keystores.adoc @@ -124,7 +124,7 @@ Additionally, the password that ${branding} uses to decrypt (unlock) the key and ${branding} assumes that password used to unlock the keystore is the same password that unlocks private keys in the keystore. ==== -The location, file name, passwords, type of the server, and trust key stores can be set in the `custom.system.properties` file: +The location, file name, passwords and type of the server and trust key stores can be set in the `custom.system.properties` file: . Setting the Keystore and Truststore Java Properties [source] diff --git a/distribution/docs/src/main/resources/content/_metadataReference/associations-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/associations-attributes-table.adoc index 0edf63d2e7cb..b023f745e76e 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/associations-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/associations-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Associations (Attributes in this group represent associations between resources.) *Injected by default.* +.Associations: Attributes in this group represent associations between resources. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== diff --git a/distribution/docs/src/main/resources/content/_metadataReference/contact-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/contact-attributes-table.adoc index 6b5ba74d8714..d6c915af8b42 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/contact-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/contact-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Contact (Attributes in this group reflect metadata about different kinds of people/groups/units/organizations that can be associated with a metacard.) *Injected by default.* +.Contact: Attributes in this group reflect metadata about different kinds of people/groups/units/organizations that can be associated with a metacard. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== |Term diff --git a/distribution/docs/src/main/resources/content/_metadataReference/datetime-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/datetime-attributes-table.adoc index e5f50aac2880..88c8f49eb0bf 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/datetime-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/datetime-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.DateTime (Attributes in this group reflect temporal aspects about the resource.) *Injected by default.* +.DateTime: Attributes in this group reflect temporal aspects about the resource. *Injected by default.* [cols="5" options="header"] |=== |Term diff --git a/distribution/docs/src/main/resources/content/_metadataReference/history-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/history-attributes-table.adoc index d19310540ecf..7108f24035c6 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/history-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/history-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.History (Attributes in this group describe the history/versioning of the metacard.) *Injected by default.* +.History: Attributes in this group describe the history/versioning of the metacard. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== |Term diff --git a/distribution/docs/src/main/resources/content/_metadataReference/location-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/location-attributes-table.adoc index 28c4db085880..26dd61580dc1 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/location-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/location-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Location (Attributes in this group reflect location aspects about the resource.) *Injected by default.* +.Location: Attributes in this group reflect location aspects about the resource. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== |Term diff --git a/distribution/docs/src/main/resources/content/_metadataReference/media-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/media-attributes-table.adoc index 3ca70ddd1c9f..a48a944a21ef 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/media-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/media-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Media (Attributes in this group reflect metadata about media in general.) *Injected by default.* +.Media: Attributes in this group reflect metadata about media in general. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== |Term diff --git a/distribution/docs/src/main/resources/content/_metadataReference/metacard-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/metacard-attributes-table.adoc index 2e5a51a5223e..414cfe35fca4 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/metacard-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/metacard-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Metacard (Attributes in this group describe the metacard itself.) *Injected by default.* +.Metacard: Attributes in this group describe the metacard itself. *Injected by default.* [cols="5" options="header"] |=== |Term diff --git a/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc index 0bb1acb2253c..bef55546b949 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/security-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Security (Attributes in this group relate to security of the resource and metadata.) *Injected by default.* +.Security: Attributes in this group relate to security of the resource and metadata. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== diff --git a/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc b/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc index f16538716a2c..c2a423ebbf1a 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/supported-file-formats.adoc @@ -9,7 +9,7 @@ ${branding} supports a wide variety of file types and data types for ingest. The ${branding}'s internal Input Transformers extract the necessary data into a <<{metadata-prefix}catalog_taxonomy_definitions,generalized format>>. -${branding} supports ingest of many datatypes and commonly used file formats, such as Microsoft office products: including Word documents, Excel spreadsheets, and PowerPoint presentations, as well as .pdf files, GeoJson, and others. See <<{metadata-prefix}all_file_formats_supported,complete list>>. +${branding} supports ingest of many datatypes and commonly used file formats, such as Microsoft office products: Word documents, Excel spreadsheets, and PowerPoint presentations as well as .pdf files, GeoJson and others. See <<{metadata-prefix}all_file_formats_supported,complete list>>. Many of these file types support additional <<_file_format_specific_attributes,file format-specific attributes>> from which additional metadata can be extracted. [NOTE] diff --git a/distribution/docs/src/main/resources/content/_metadataReference/topic-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/topic-attributes-table.adoc index 58adcc835fae..398bc5d53777 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/topic-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/topic-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Topic (Attributes in this group describe the topic of the resource.) *Injected by default.* +.Topic: Attributes in this group describe the topic of the resource. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== diff --git a/distribution/docs/src/main/resources/content/_metadataReference/validation-attributes-table.adoc b/distribution/docs/src/main/resources/content/_metadataReference/validation-attributes-table.adoc index c3c2ba2ea45a..d257dd819232 100644 --- a/distribution/docs/src/main/resources/content/_metadataReference/validation-attributes-table.adoc +++ b/distribution/docs/src/main/resources/content/_metadataReference/validation-attributes-table.adoc @@ -7,7 +7,7 @@ == {title} -.Validation (Attributes in this group identify validation issues with the metacard and/or resource.) *Injected by default.* +.Validation: Attributes in this group identify validation issues with the metacard and/or resource. *Injected by default.* [cols="1,2,1,1,1" options="header"] |=== diff --git a/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc b/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc index 3ba98265ac65..1663c6ee86e0 100644 --- a/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc +++ b/distribution/docs/src/main/resources/content/_quickstart/quickstart-installing.adoc @@ -25,7 +25,7 @@ For security reasons, ${branding} cannot be started from a user's home directory .Java Requirements (Quick Install) -Follow the instructions outlined in <<{managing-prefix}java_requirements, Java Requirements>>. +Follow the instructions outlined here: <<{managing-prefix}java_requirements, Java Requirements>>. .Check System Time [WARNING] @@ -60,7 +60,7 @@ The Windows Zip implementation, which is invoked when a user double-clicks on a This is a consequence of its inability to process long file paths. Instead, use the java jar command line utility to unzip the distribution (see example below) or use a third party utility such as 7-Zip. -NOTE: If and only if a JDK is installed, the jar command may be used; otherwise, another archiving utility that does not have issue with long paths should be installed +Note: If and only if a JDK is installed, the jar command may be used; otherwise, another archiving utility that does not have issue with long paths should be installed .Use Java to Unzip in Windows(Replace `` with correct path `and ` with current version.) ---- diff --git a/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc b/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc index e3335d661bcf..8d7c118f8828 100644 --- a/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc +++ b/distribution/docs/src/main/resources/content/_quickstart/quickstart-intro.adoc @@ -9,7 +9,7 @@ == {title} -(((Quick start guide)))This quick tutorial will enable installation, configuration, and usage of a basic instance of ${branding}. +(((Quick start guide)))This quick tutorial will enable install, configuring and using a basic instance of ${branding}. [NOTE] ==== diff --git a/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc b/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc index ce4e6e00bdc7..0ba6b15f6eaa 100644 --- a/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_dependencyList/ddf-dependency-list.adoc @@ -3,7 +3,7 @@ :status: published :parent: ${ddf-branding} Dependency List :order: 00 -:summary: ${ddf-branding} ${project.version} Dependency List +:summary: ${ddf-branding} ${project.version} Dependency List. == {summary} ((({title}))) diff --git a/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc b/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc index 99319593a5c3..d32530d8f76e 100644 --- a/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_dependencyList/js-dependency-list.adoc @@ -3,7 +3,7 @@ :status: published :parent: ${branding} Dependency List :order: 01 -:summary: ${branding} ${project.version} Javascript Dependency List +:summary: ${branding} ${project.version} Javascript Dependency List. == {summary} ((({title}))) diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc index 01a7ac314b0a..6484bb25ab9c 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/Session.adoc @@ -22,7 +22,7 @@ |Specifies the length of inactivity (in minutes) between client requests before the servlet container will invalidate the session (this applies to all client sessions). This value must be 2 minutes or greater, as users are warned when only 1 minute remains. If a value of less than 2 minutes is used, the timeout is set to the default time of 31 minutes. -See also <<_ddf.platform.ui.config,Platform UI Config>>. +See also: <<_ddf.platform.ui.config,Platform UI Config>>. |31 |true diff --git a/distribution/docs/src/main/resources/content/_reference/_tables/sourcePoller.adoc b/distribution/docs/src/main/resources/content/_reference/_tables/sourcePoller.adoc index 2256babf195a..0b6ff4851d05 100644 --- a/distribution/docs/src/main/resources/content/_reference/_tables/sourcePoller.adoc +++ b/distribution/docs/src/main/resources/content/_reference/_tables/sourcePoller.adoc @@ -19,9 +19,10 @@ |Poll Interval (minutes) |pollIntervalMinutes |Integer -a|The interval (in minutes) at which to recheck the availability of all sources. Must be at least 1 minute. +|The interval (in minutes) at which to recheck the availability of all sources. Must be at least 1 minute. -WARNING: There is a maximum delay of 2*`pollIntervalMinutes` for the Source Poller to be updated after the availability of a source changes or a source is created/modified/deleted. +WARNING: +There is a maximum delay of 2*`pollIntervalMinutes` for the Source Poller to be updated after the availability of a source changes or a source is created/modified/deleted. Currently the <<{developing-prefix}standard_catalog_framework,Standard Catalog Framework>> and the <<{integrating-prefix}catalog_rest_endpoint,Catalog REST Endpoint>> use the Source Poller to get source availabilities. The `pollIntervalMinutes` should not be set to value a which results in an unacceptable maximum delay. |1 diff --git a/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc b/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc index c7b042456f85..5e32607dd3d6 100644 --- a/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc +++ b/distribution/docs/src/main/resources/content/_using/using-simple-search-ui.adoc @@ -21,7 +21,7 @@ Enter one or more of the available search criteria to execute a query: Keyword Search:: A text box allowing the user to enter a textual query. This supports the use of (*) wildcards. If blank, the query will contain a contextual component. Temporal Query:: Select from *any*, *relative*, or *absolute*. Selecting *Any* results in no temporal restrictions on the query, selecting *relative* allows the user to query a period from some length of time in the past until now, and selecting *absolute* allows the user to specify a *start* and *stop* date range. -Spatial Search:: Select from *any*, *point-radius*, and *bounding box*. Selecting *Any* results in no spatial restrictions on the query, selecting *point-radius* allows the user to specify a *lat/lon* and *radius* to search, and selecting a *bounding box* allows the user to specify an *eastern*, *western*, *southern*, and *northern* boundary to search within. +Spatial Search:: Select from *any*, *point-radius*, and *bounding box*. Selecting *Any* results in no spatial restrictions on the query, selecting *point-radius* allows the user to specify a *lat/lon* and *radius* to search, and selecting a *bounding box* allows the user to specify an *eastern*, *western*, *southern* and *northern* boundary to search within. Type Search:: Select from *any*, or a specific type. Selecting *Any* results in no type restrictions on the query, and Selecting *Specific Types* shows a list of known content types on the federation, and allows the user to select a specific type to search for. Sources:: Select from *none*, *all sources*, or *specific sources*. Selelcting *None* results in querying only the local provider, Selecting *All Sources* results in an enterprise search where all federations are queried, and selecting *Specific Sources* allows the user to select which sources are queried. Results per Page:: Select the number of results to be returned by a single query.