docs: Reorganized sections

redis · Sep 12, 2023 · 649fe5c · 649fe5c
1 parent d0f1908
commit 649fe5c
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 61 deletions.
diff --git a/docs/guide/src/docs/asciidoc/db-import.adoc b/docs/guide/src/docs/asciidoc/db-import.adoc
@@ -43,3 +43,5 @@ This will produce Redis strings that look like this:
 include::{includedir}/../resources/order.json[]
 ----
 
+[[_db_import_processing]]
+include::{includedir}/processing.adoc[leveloffset=+2]
diff --git a/docs/guide/src/docs/asciidoc/elasticache.adoc b/docs/guide/src/docs/asciidoc/elasticache.adoc
@@ -1,4 +1,4 @@
-[[_elasticache_migration]]
+[[_elasticache]]
 = Migrating from Elasticache
 
 This recipe contains step-by-step instructions to migrate an Elasticache (EC) database to {link_redis_enterprise} (RE).

diff --git a/docs/guide/src/docs/asciidoc/faker-import.adoc b/docs/guide/src/docs/asciidoc/faker-import.adoc
@@ -59,4 +59,7 @@ You can infer Faker fields from a RediSearch index using the `--infer` option:
 [source]
 ----
 include::{testdir}/faker-import-infer[]
-----
+----
+
+[[_faker_import_processing]]
+include::{includedir}/processing.adoc[leveloffset=+2]
diff --git a/docs/guide/src/docs/asciidoc/file-import.adoc b/docs/guide/src/docs/asciidoc/file-import.adoc
@@ -195,4 +195,17 @@ Here is a sample XML file that can be imported by {project-title}:
 [source]
 ----
 include::{testdir}/file-import-xml[]
+----
+
+[[_file_import_processing]]
+include::{includedir}/processing.adoc[leveloffset=+2]
+
+=== Regular Expressions
+
+In addition to the <<import processors>> you can perform field extraction using regular expressions.
+
+.Regex example
+[source]
+----
+riot file-import --regex name="(?<first>\w+)\/(?<last>\w+)" ...
 ----
diff --git a/.../guide/src/docs/asciidoc/quick-start.adoc → ...de/src/docs/asciidoc/getting-started.adoc b/.../guide/src/docs/asciidoc/quick-start.adoc → ...de/src/docs/asciidoc/getting-started.adoc
@@ -1,5 +1,5 @@
-[[_run]]
-= Quick Start
+[[_getting_started]]
+= Getting Started
 
 You can launch {project-title} with the following command:
 

diff --git a/docs/guide/src/docs/asciidoc/index.adoc b/docs/guide/src/docs/asciidoc/index.adoc
@@ -7,9 +7,9 @@
 include::{includedir}/_links.adoc[]
 
 :leveloffset: 1
-include::{includedir}/introduction.adoc[]
+include::{includedir}/overview.adoc[]
 include::{includedir}/install.adoc[]
-include::{includedir}/quick-start.adoc[]
+include::{includedir}/getting-started.adoc[]
 include::{includedir}/architecture.adoc[]
 include::{includedir}/files.adoc[]
 include::{includedir}/generators.adoc[]

diff --git a/docs/guide/src/docs/asciidoc/install.adoc b/docs/guide/src/docs/asciidoc/install.adoc
@@ -1,50 +1,37 @@
 [[_install]]
 = Install
 
-{project-title} can be installed in different ways depending on your environment and preference.
+{project-title} can be installed on Linux, macOS, and Windows platforms and can be used as a standalone tool that connects remotely to a Redis database.
+It is not required to run locally on a Redis server.
 
-[[_macos_install]]
-== macOS
 
-=== Homebrew
+[[_homebrew_install]]
+== Homebrew (macOS & Linux)
 
 [source]
 ----
 brew install redis-developer/tap/riot
 ----
 
-=== Manually
-
-include::{includedir}/install_manually.adoc[]
-
-[[_windows_install]]
-== Windows
-
-=== Scoop
+[[_scoop_install]]
+== Scoop (Windows)
 
 [source]
 ----
 scoop bucket add redis-developer https://github.com/redis-developer/scoop.git
 scoop install riot
 ----
 
-=== Manually
-
-include::{includedir}/install_manually.adoc[]
-
-[[_linux_install]]
-== Linux
+[[_manual_install]]
+== Manual Installation (All Platforms)
 
-=== Homebrew
-
-[source]
-----
-brew install redis-developer/tap/riot
-----
+Download the pre-compiled binary from the {link_releases}, uncompress and copy to the desired location.
 
-=== Manually
+[NOTE]
+====
+`riot-{project-version}.zip` requires Java 11 or greater to be installed while `riot-standalone-{project-version}-*.zip` includes its own Java runtime and does not require a Java installation.
+====
 
-include::{includedir}/install_manually.adoc[]
 
 [[_docker_install]]
 == Docker

diff --git a/docs/guide/src/docs/asciidoc/install_manually.adoc b/docs/guide/src/docs/asciidoc/install_manually.adoc
diff --git a/docs/guide/src/docs/asciidoc/introduction.adoc b/docs/guide/src/docs/asciidoc/introduction.adoc
diff --git a/docs/guide/src/docs/asciidoc/overview.adoc b/docs/guide/src/docs/asciidoc/overview.adoc
@@ -0,0 +1,17 @@
+[[_overview]]
+= Overview
+
+Redis Input/Output Tools ({project-title}) is a command-line utility to get data in and out of any Redis-compatible database like Redis OSS, Redis Cluster, Redis Enterprise, or <<_elasticache, Amazon ElastiCache>>.
+
+{project-title} allows you to:
+
+* Import data into a Redis database
+* Export data from a Redis database
+* Replicate (migrate) data between two Redis databases
+
+{project-title} supports many different sources and targets:
+
+* Files (CSV, JSON, XML)
+* Data generators (data structures, Faker)
+* Relational databases
+* Redis itself (snapshot and live replication)
diff --git a/docs/guide/src/docs/asciidoc/processing.adoc b/docs/guide/src/docs/asciidoc/processing.adoc
@@ -4,7 +4,6 @@
 {project-title} lets you process incoming records in different ways:
 
 * SpEL processors (`--proc`)
-* Regex field extraction (`--regex`)
 * SpEL filtering (`--filter`)
 
 [[_spel_proc]]
@@ -29,17 +28,8 @@ Processors have access to the SpEL evaluation context and also this function:
 riot file-import --proc epoch="#date.parse(mydate).getTime()" location="#geo(lon,lat)" name="#redis.hget('person1','lastName')" ...
 ----
 
-[[_architecture_regex]]
-=== Regular Expressions
-
-Extract patterns from source fields using regular expressions:
-[source]
-----
-riot file-import --regex name="(?<first>\w+)\/(?<last>\w+)" ...
-----
-
 [[_architecture_filters]]
-=== Filters
+== Filters
 
 Filters allow you to exclude records that don't match a SpEL boolean expression.