codice · ricklarsen · Oct 19, 2021 · Oct 8, 2021
@@ -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.
 
-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.
+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.
 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

@@ -4,7 +4,7 @@
 :plugintypes: general
 :order: 00
 
-.Catalog Architecture: Catalog Plugins
+.Catalog Architecture Catalog Plugins
 [ditaa, catalog_architecture_plugins, png,${image-width}]
 ....
 +------------------------------------------------------------+

@@ -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

@@ -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).

@@ -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>> |

@@ -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, 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, the 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*.
 

@@ -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.
@@ -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
-|The https port that the system uses.
+a|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
-|The http port that the system uses.
+a|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
-|The default port that the system uses. This should match either the above http or https port.
+a|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,16 +150,15 @@ 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
 
 |HTTPS Port
 |org.codice.ddf.external.httpsPort
 |String
-|The https port used to advertise the system.
+a|The https port used to advertise the system.
 
 NOTE: This does not change the port the system runs on.
 |8993
@@ -168,7 +167,7 @@ NOTE: This does not change the port the system runs on.
 |External HTTP Port
 |org.codice.ddf.external.httpPort
 |String
-|The http port used to advertise the system.
+a|The http port used to advertise the system.
 
 NOTE: This does not change the port the system runs on.
 |8181
@@ -177,7 +176,7 @@ NOTE: This does not change the port the system runs on.
 |External Default Port
 |org.codice.ddf.external.port
 |String
-|The default port used to advertise the system. This should match either the above http or https port.
+a|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

@@ -7,7 +7,7 @@
 
 .[[_configuring_sso]]Configure Single Sign On (SSO)
 ****
-Configure Single Sign On method: SAML or OIDC.
+Configure Single Sign On method for SAML or OIDC.
 (((Single Sign On, SSO)))
 
 .SAML SSO

@@ -73,15 +73,15 @@ 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
 ${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,15 +96,15 @@ 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
 ${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

@@ -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
 ----

@@ -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 (e.g., ${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
 

@@ -81,7 +81,7 @@ The `--created-after` and `--created-before` options allow filtering on the date
 These date ranges are exclusive (i.e., 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:

@@ -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
 ----

@@ -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[Karaf Documentation: Log] {external-link}.
+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.
 
 === Enabling HTTP Access Logging
 

@@ -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
 ----

@@ -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 and type of the server and trust key stores can be set in the `custom.system.properties` file:
+The location, file name, passwords, 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]

@@ -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"]
 |===
 

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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"]
 |===
 

@@ -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: 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: 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>>.
 Many of these file types support additional <<_file_format_specific_attributes,file format-specific attributes>> from which additional metadata can be extracted.
 
 [NOTE]

@@ -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"]
 |===