docs: Updated options

redis · Sep 5, 2024 · 2e743bb · 2e743bb
1 parent 55d77a4
commit 2e743bb
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 10 deletions.
diff --git a/docs/guide/src/docs/asciidoc/faq.adoc b/docs/guide/src/docs/asciidoc/faq.adoc
@@ -29,7 +29,7 @@ This issue occurs when you fail to supply the `--pass <password>` parameter.
 [[_faq_stream_id]]
 ERR The ID argument cannot be a complete ID because xadd-id-uniqueness-mode is strict::
 This usually happens in Active/Active (CRDB) setups where stream message IDs cannot be copied over to the target database.
-Use the `--no-stream-ids` option to disable ID propagation.
+Use the `--no-stream-id` option to disable ID propagation.
 
 [[_faq_script]]
 ERR Error running script... This Redis command is not allowed from scripts::

diff --git a/docs/guide/src/docs/asciidoc/files.adoc b/docs/guide/src/docs/asciidoc/files.adoc
@@ -6,13 +6,13 @@
 * <<_file_import,`file-import`>>: Import data from files
 * <<_file_export,`file-export`>>: Export Redis data structures to files
 
-
 [[_file_import]]
 == File Import
 
-The `import` command reads data from files and writes it to Redis.
+The `file-import` command reads data from files and writes it to Redis.
 
 The basic usage for file imports is:
+
 [source,console]
 ----
 riot file-import [OPTIONS] FILE... [REDIS COMMAND...]
@@ -108,11 +108,11 @@ riot file-import my.json hset --keyspace blah --key id expire --keyspace blah --
 .Import into hashes in keyspace `blah:<id>` *and* set TTL *and* add each `id` to a set named `myset`
 [source,console]
 ----
-riot file-import my.json hset --keyspace blah --key id expire --keyspace blah --key id sadd --keyspace myset --members id
+riot file-import my.json hset --keyspace blah --key id expire --keyspace blah --key id sadd --keyspace myset --member id
 ----
 
 [[_file_import_delimited]]
-== Delimited (CSV)
+=== Delimited (CSV)
 
 The default delimiter character is comma (`,`).
 It can be changed with the `--delimiter` option.
@@ -252,6 +252,9 @@ To show the full usage, run:
 riot file-export --help
 ----
 
+[[_file_export_json]]
+=== JSON
+
 .Export to JSON
 [source,console]
 ----
@@ -270,9 +273,12 @@ include::{includedir}/../resources/redis-dump.json[]
 include::{testdir}/file-export-json-gz[]
 ----
 
+[[_file_export_xml]]
+=== XML
 .Export to XML
 [source,console]
 ----
 include::{testdir}/file-export-xml[]
 ----
 
+
diff --git a/docs/guide/src/docs/asciidoc/introduction.adoc b/docs/guide/src/docs/asciidoc/introduction.adoc
@@ -5,10 +5,15 @@
 
 {project-title} includes the following features:
 
-* File import/export (CSV, JSON, XML)
-* Relational database import/export
-* Data generation using Faker or random data structures
-* Data migration from a Redis database to another
-* Live replication between two Redis databases
+* Files (CSV, JSON, XML)
+** <<_file_import,Import>>: File -> Redis
+** <<_file_export,Export>>: Redis -> File
+* Databases
+** <<_db_import,Import>>: Database -> Redis
+** <<_db_export,Export>>: Redis -> Database
+* Data Generators
+** <<_datagen_struct,Redis Data Generator>>: Data Structures -> Redis
+** <<_datagen_faker,Faker Data Generator>>: Faker -> Redis
+* <<_replication,Replication>>: Redis -> Redis
 
 {project-title} is supported by Redis, Inc. on a good faith effort basis. To report bugs, request features, or receive assistance, please https://github.com/redis/riot/issues[file an issue] or contact your Redis account team.
diff --git a/docs/guide/src/docs/asciidoc/usage.adoc b/docs/guide/src/docs/asciidoc/usage.adoc
@@ -38,3 +38,4 @@ include::{includedir}/databases.adoc[]
 include::{includedir}/files.adoc[]
 include::{includedir}/replication.adoc[]
 :leveloffset: -1
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -38,3 +38,4 @@ include::{includedir}/databases.adoc[]
		include::{includedir}/files.adoc[]
		include::{includedir}/replication.adoc[]
		:leveloffset: -1