Skip to content

Commit

Permalink
Div typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
alansemenov committed Oct 24, 2024
1 parent ab91474 commit 5bd7766
Show file tree
Hide file tree
Showing 13 changed files with 123 additions and 126 deletions.
12 changes: 6 additions & 6 deletions docs/admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

== Introduction

The Explorer administrative interface enable search administrators to define and manage how data is collected and then exposed through fine tuned interfaces.
The Explorer Admin interface enables search administrators to define and manage how data is collected and then exposed through fine-tuned interfaces.

== Access
From the Enonic XP admin interface: Click `XP meny -> Explorer`. This will launch the Explorer Admin interface.
From the Enonic XP admin interface: Click `XP menu -> Explorer`. This will launch the Explorer Admin interface.

NOTE: Only users with "Explorer Admin" or "System Admin" roles can access the interface.

Expand All @@ -19,7 +19,7 @@ image::home.png[Explorer home page,1024w]

== Navigation

From the top bar, you can access the Explorer menu to navigate across the various pages of the Explorer Admin.
From the top bar, you can access the Explorer menu to navigate across the various pages of the Explorer Admin.

image::menu.png[Explorer menu expanded,350w]

Expand All @@ -35,16 +35,16 @@ The different Explorer pages provide an entity list view. From here you can perf

image::plus.png[Green plus create icon,67]

When supported, a big green `+` icon at the bottom right of the page enables you to crate new entities.
When supported, a big green `+` icon at the bottom right of the page enables you to create new entities.

=== Standard actions
image::actions.png[Sample list of entities,768w]

From the right hand side of each entry in the list, perform standard actions like `Edit`,`Copy` and `Delete` by clicking the respective action icon.
From the right hand side of each entry in the list, perform standard actions like `Edit`, `Copy` and `Delete` by clicking the respective action icon.

=== Custom actions

Selected entities support custom actions. Such actions are listed on the left hand side.
Selected entities support custom actions which are listed on the left hand side.

image::custom-actions.png[Custom actions listed on the left hand side,340w]

Expand Down
12 changes: 6 additions & 6 deletions docs/collections.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

== Introduction

Use collections to gather and manage <<documents#, documents>>. Documents can be injected externally through the API, or activedly fetched by a collector.
Use collections to gather and manage <<documents#, documents>>. Documents can be injected externally through the API, or actively fetched by a collector.

image::collections-menu.png[Available menu items for collections, 450w]

Expand Down Expand Up @@ -35,13 +35,13 @@ image::scheduling.png[Scheduling interface,768]

If you selected a collector, you may optionally define schedule(s) to automatically run the collector.

NOTE: Consider that the scheduler should be allowed to finish before it is triggered again. Only one instance of the collector will be running at a time.
NOTE: Note that the scheduler should be allowed to finish before it is triggered again. Only one instance of the collector will be running at a time.

=== Run collector manually

image::custom-actions.png[Custom actions listed on the left hand side,340w]

From the collections list view: Clicking the `Collect` icon will manually trigger the collector job.
Clicking the `Collect` icon from the Collections list view will manually trigger the collector job.


== Status
Expand All @@ -52,13 +52,13 @@ image::status.png[Progress of currently running collectors,1024]

== Journal

Journal shows the history of completed collector jobs and their result.
Journal shows the history of completed collector jobs and their results.

image::journal.png[List of completed collector jobs,1024]

== Notifications

Optionally add e-mails to notify users about collector related events.
Optionally add e-mails to notify users about collector-related events.

image::journal.png[List of completed collector jobs,1024]

Expand All @@ -68,4 +68,4 @@ NOTE: For the e-mail notification to work, your Enonic XP deployment must be con

The schedule provides a global view of all collector jobs scheduled to run. This helps you plan execution and resource management optimally.

image::TODO.png[Calendar view of collector schedules,1024w]
//image::TODO.png[Calendar view of collector schedules,1024w]
7 changes: 3 additions & 4 deletions docs/collectors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Collectors are typically distributed as regular XP applications. A single applic

=== Configure

When you create a collection, select the collector, and configure it using the form that appears.
When you create a collection, select the collector and configure it using the form that appears.

Each collector may provide special configuration forms that allow you to tune how it will work for a specific <<collections, collection>>.
Each collector may provide special configuration forms that allow you to tune how it will work for a specific <<#collections, collection>>.

NOTE: A collection may only have a single collector associated with it.

Expand All @@ -35,7 +35,7 @@ NOTE: Text within <script>, <nav> and <footer> elements will automatically be re

The webcrawler collector has the following configuration options.

URL:: This is the URL at which the collector will start crawling. For instance `https://market.enonic.com`. Only pages within the specified **domain** will be indexed.
URL:: This is the URL at which the collector will start crawling (for instance `https://market.enonic.com`). Only pages within the specified **domain** will be indexed.

Exclude patterns:: To avoid indexing all pages within a domain, you may specify exclude patterns.
+
Expand All @@ -49,7 +49,6 @@ Example: Ignore pages ending with `.html`
+
.html$
+
TODO: Verify examples and Document format(link?)

User-Agent:: Some webservers handle user-agents differently. Here you can pretend to be a specific browser or robot. If you leave the field empty it will use a default user agent.

Expand Down
30 changes: 15 additions & 15 deletions docs/doctypes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ In Explorer data is organized into <<collections#, Collections>>.
Each collection may contain a number of <<documents#, documents>>.
Each document may have fields with values.

Each document, must have a specific document-type.
Each document must have a specific document-type.

The document types controls the indexing, on a per field level, as well as optional validation rules.
A document type controls the indexing, on a per field level, as well as optional validation rules.

NOTE: A single collection may have documents with different document types.

== Document types list

The table will show a list of the document-types.
The table will show a list of the document types.

image::doctypes.png[Browse and manage document types, 1024w]

Each row represents a document-type and will have a button to edit the document-type.
Each row represents a document type and will have a button to edit it.


== Settings
Expand All @@ -29,15 +29,15 @@ When creating a new document type, you must define the basic settings:

image::doctype-new.png[Initial doctype configuration, 1000w]

Name:: A unique name which is also the identifier. The name may only contain a strictly limited set of characters.
Name:: A unique name which is also an identifier. The name may only contain a strictly limited set of characters.
+
WARNING: The name cannot be changed after a document-type is created. Deleting a document type after clients have started using it will be a breaking change in the GraphQL API. To prevent breaking the API, a document type can rather be disabled.
WARNING: The name cannot be changed after a document type is created. Deleting a document type after clients have started using it will be a breaking change in the GraphQL API. To prevent breaking the API, a document type should rather be disabled.

Add fields automatically:: Enable this option if you want the document type to be dynamic. If enabled, whenever a document is created or updated it will automatically detect new fields, determine a <<#_value_type, Value type>> for the field and add it to the document-type.
Add fields automatically:: Enable this option if you want the document type to be dynamic. If enabled, whenever a document is created or updated it will automatically detect new fields, determine a <<#_value_type, Value type>> for the field and add it to the document type.

== Fields

Once a document type has been created, you may manage it's fields.
Once a document type has been created, you can manage its fields.

image::doctype-fields.png[List of document type fields, 1000w]

Expand All @@ -46,15 +46,15 @@ Each row represents a field and will have a button to edit the field, or add new

=== Fields

Name:: Each field must have a unique name within the document-type.
Name:: Each field must have a unique name within the document type.
+
WARNING: The name cannot be changed after a field is created. Deleting a field after clients have started using it will be a breaking change in the GraphQL API. To prevent breaking the API, a field can rather be disabled.
WARNING: The name cannot be changed after a field is created. Deleting a field after clients have started using it will be a breaking change in the GraphQL API. To prevent breaking the API, a field should rather be disabled.
+
Fields can also be nested. A dot '*.*' is used to indicate nesting. For instance: `person.name`. In this case, the field `person` will be reserved for nesting, and can no longer be used for indexing.
Fields can also be nested. A dot '*.*' is used to indicate nesting. For instance: `person.name`. In this case, the field `person` will be reserved for nesting and can no longer be used for indexing.

Value type:: Each field must have a specific value type. The value type enables field validation, and default indexing options.
Value type:: Each field must have a specific value type. The value type enables field validation and default indexing options.
+
The value types are: `Boolean`, `Double`, `geoPoint`, `instant`, `localDate`, `localDateTime`, `localTime`,`long`, `set` and `string`.
The value types are: `Boolean`, `Double`, `geoPoint`, `instant`, `localDate`, `localDateTime`, `localTime`,`long`, `set` and `string`.
+
NOTE: Value type validation is only enforced if documents are created with validateOccurrences=true.
+
Expand Down Expand Up @@ -84,6 +84,6 @@ Active:: Deleting a field will potentially break the strongly typed <<graphql#,

== Updating document types

When a document type is in use (one or more documents exists), it is still possible to modify and update the document type.
When a document type is in use (one or more documents exist), it is still possible to modify and update the document type.

After saving your changes to the document type, all documents will automatically be re-indexed based on the new document type definition.
After saving your changes to the document type, all documents will automatically be re-indexed based on the new document type definition.
6 changes: 3 additions & 3 deletions docs/documents.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

== Introduction

Each indexed item in Explorer is called a `Document`. The document will have a specific <<doctypes#, Document Type>>, and be stored in a specific <<collections#, Collection>>.
Each indexed item in Explorer is called a `Document`. The document will have a specific <<doctypes#, Document Type>> and be stored in a specific <<collections#, Collection>>.

== Browser

From the Documents page, you may instantly access all available document, search and filter the list to get the results you are looking for.
From the Documents page, you may instantly access all available documents, search and filter the list to get the results you are looking for.

image::documents.png[Browse and filter across all indexed documents, 1024w]

Expand All @@ -28,4 +28,4 @@ AND/OR toggle:: String search mode
Collections filter:: Select collections to include
Document types filter:: Select document types to include
Columns:: Add columns to the result view
Count:: Number of items in the result view
Count:: Number of items in the result view
6 changes: 3 additions & 3 deletions docs/graphql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

== Endpoint

The API's default location is:
The API's default location is:

http://localhost:8080/webapp/com.enonic.app.explorer/api/graphql

Expand Down Expand Up @@ -32,7 +32,7 @@ Access to the API requires that you create and submit a <<keys#, valid API key>>

The API is self-documented, and can be accessed directly using the Query tester in Explorer Admin

To test the public endpoint directly, we recommend using a tool like a browser extension like https://chrome.google.com/webstore/detail/altair-graphql-client/flnheeellpciglgpaodhkhmapeljopja[the Altair GraphQL client].
To test the public endpoint directly, we recommend using an external tool, for example a browser extension like https://chrome.google.com/webstore/detail/altair-graphql-client/flnheeellpciglgpaodhkhmapeljopja[the Altair GraphQL client].

== Usage

Expand Down Expand Up @@ -79,4 +79,4 @@ query MyQuery {
}
}
}
----
----
8 changes: 3 additions & 5 deletions docs/ingest.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Ingest API
:imagesdir: media
:imagesdir: media
:toc: right

A REST style api to create, read, update and delete documents. Use this to update documents in your collection(s) externally.
Expand Down Expand Up @@ -28,8 +28,6 @@ Using the vhost configuration above, the API will be available on `company.com/i

The API requires that you <<keys#, create and submit a valid API key>> in the HTTP request header.

TODO: What about cty+accept?

[%header,cols="1%,1%,1%,97%a"]
[frame="none"]
[grid="none"]
Expand All @@ -52,7 +50,7 @@ Use the client by following the steps below:

=== Common variables

Specify the API key, and the collection to access. These values will automatically be applied to the different operations.
Specify the API key, and the collection to access. These values will automatically be applied to the different operations.

=== Bulk operations

Expand All @@ -67,7 +65,7 @@ You may perform the following bulk operations:
Using a document's URL you may perform the following operations:

* Get
* Patch - TODO? Modify?
* Patch
* Delete

== Usage examples
Expand Down
20 changes: 10 additions & 10 deletions docs/interfaces.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@

The purpose of Explorer is to enable search across multiple data sources.

When you have collected documented, you may explose them by defining a `search interface` - or just interface for short.
When you have collected documented, you may expose them by defining a `search interface` - or just `interface` for short.

An interface allows you to select which collections and synonyms to combine, as well as the ability to tune and boost your search down to the field level.

== Interface list

image::interface-list.png[Manage interfaces, 768w]

From the interface list view, you may perform regular actions.
From the interface list view, you may perform regular actions.

Additionally, it offers two custom actions for `Trying` out the interface:
Additionally, it offers two custom actions for trying out the interface:

* A *[Magnifying glass]* button, to test the interface.
* A *[GraphQL]* button, to test the API.
Expand All @@ -28,24 +28,24 @@ When creating, or editing interfaces, these are the available options you may ma

image::interface-myinterface.png[Manage interfaces, 1010w]

Name:: Each interface needs a unique name, which is also the identifier
Name:: Each interface needs a unique name, which is also the identifier.
+
NOTE: Once created, the name cannot be changed.

Collections:: You need to specify at least one collection to include in the search.

Boosting:: By default, the _alltext field is used when performing text searches. Here, you may add specific fields and boosting options to tune your search results.
Boosting:: By default, the `_alltext` field is used when performing text searches. Here, you may add specific fields and boosting options to tune your search results.
+
`Field boosting` means matches in the specified field will get a higher (or lower) priority when calculating the document scoring.
+
`Term boosting` allows you to boost a specific value within a field.

Stop-words:: The search string is split, by unicode boundaries, into words, then each word matching a stop word will be removed from the search string. Stop-words are applied before the synonym stage.
Stop-words:: Optionally add one or more stop-words.
+
TIP: Read more about <<#stop_words, Stop-words>>.
+
CAUTION: Be careful when adding stop words, it may quickly lead to an empty search string and no search results.

Synonyms:: Optionally add one ore more thesauri. They will be used to "decorate" the query, and hopefully provide better results.
Synonyms:: Optionally add one or more thesauri. They will be used to "decorate" the query, and hopefully provide better results.
+
First any <<#_stop_words, Stop-words>> are removed,
then the remaining search string is used to query for synonyms,
matches are used to decorate the main query.
TIP: Read more about <<#synonyms, Synonyms>>.
14 changes: 7 additions & 7 deletions docs/keys.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ The various form fields of keys are described below.

image::keys.png[Screenshot of the API keys list view,1280w]

Name:: An API-key must have a unique name. Once an API-key is created you cannot change it's name.
Name:: An API key must have a unique name. Once an API key is created you cannot change its name.

NOTE: The name has no other purpose than to distinguish multiple different keys when working in the Explorer Admin.

Key:: When you first create a new API key, the key field will contain the autogenerated key, if you don't like it, simply click the generate key button for a new one, or simply enter one yourself.
Key:: When you first create a new API key, the key field will contain the autogenerated key. If you don't like it, simply click the generate key button for a new one, or simply enter one yourself.
+
CAUTION: For security reasons, the clear-text key itself is not persisted in Explorer. This means that if you loose the key, it cannot be recovered, and you must create a new one.

Expand All @@ -39,7 +39,7 @@ An API key with the value `mySecretKey` should be passed in the following header

=== cURL

cURL is a popular command line tool which can be used to perform API requests.
cURL is a popular command line tool which can be used to perform API requests.
The API key can be added to the header like this:

.Setting headers with cURL
Expand All @@ -57,16 +57,16 @@ NOTE: The above example sets three headers in total.

=== GraphQL client

When accessing the GraphQL API externally,
the API key can must be added to the header.
For the Altair GraphQL Client (Chrome Extension),
When accessing the GraphQL API externally,
the API key can must be added to the header.
For the Altair GraphQL Client (Chrome Extension),
the header can be set clicking the top icon in the left hand menu panel.

image::headers.png[Adding headers in GraphQL client,544w]

=== Ingest Client

The Ingest API comes with a handy user interface, simply add the API key at the top of the form, and it will automatically work for all API methods.
The Ingest API comes with a handy user interface, simply add the API key at the top of the form, and it will automatically work for all API methods.

image::rest-client.png[Adding headers in REST client,768]

Expand Down
Loading

0 comments on commit 5bd7766

Please sign in to comment.