This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hop.git
The following commit(s) were added to refs/heads/master by this push:
new e46e1f6 Doc fixes in User Manual
new 12ce71e Merge pull request #1022 from rolfkleef/docs-fixes
e46e1f6 is described below
commit e46e1f6885de558bf617ec3b74b7b7430b181f17
Author: Rolf Kleef <[email protected]>
AuthorDate: Wed Aug 25 22:43:57 2021 +0200
Doc fixes in User Manual
Fix source code block markers:
- projects/metadata
- hop-tools/hop-conf/hop-conf
- pipeline/transforms/filemetadata
Use 'gs://' not 'googledrive://' (vfs/google-cloud-storage-vfs)
Update config.json to hop-config.json (variables)
---
.../modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc | 4 ++--
.../modules/ROOT/pages/pipeline/transforms/filemetadata.adoc | 2 --
docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc | 4 ++--
docs/hop-user-manual/modules/ROOT/pages/variables.adoc | 4 ++--
.../modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc | 2 +-
5 files changed, 7 insertions(+), 9 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
index 6d7f73f..c39aeeb 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
@@ -25,6 +25,7 @@ Hop Conf is a command line tool to manage environments.
The *hop-conf.sh* script can be run with the *-h* flag (`./hop-conf.sh -h`) to
display available options.
[source,bash]
+----
Usage: <main class> [-h] [-ec] [-ed] [-el] [-em] [-ey] [-pc] [-pd] [-pl] [-pm]
[-pn] [-py] [-aza=<account>] [-azi=<blockIncrement>]
[-azk=<key>] [-cfg=<configFile>]
@@ -160,8 +161,7 @@ Usage: <main class> [-h] [-ec] [-ed] [-el] [-em] [-ey]
[-pc] [-pd] [-pl] [-pm]
Export project metadata to a single JSON file
which you
can specify with this option. Also specify the -p
option.
-
-====
+----
The available options are listed below:
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filemetadata.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filemetadata.adoc
index e657e04..4a0e996 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filemetadata.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filemetadata.adoc
@@ -61,5 +61,3 @@ The fields returned by this transform are
* mask
* decimal_symbol
* grouping_symbol
-
-|===
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
b/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
index 37fb59f..96a1709 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
@@ -36,7 +36,7 @@ A project's metadata is stored in
`{openvar}PROJECT_HOME{closevar}/metadata`, bu
A basic project metadata folder will look similar to the one below:
[source,bash]
----
+----
.
├── cassandra-connection
@@ -62,4 +62,4 @@ A basic project metadata folder will look similar to the one
below:
└── workflow-run-configuration
└── local.json
18 directories, 4 files
----
\ No newline at end of file
+----
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
b/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
index 64dbd0e..f362fa4 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
@@ -73,12 +73,12 @@ This also means that's important to know where variables
can be set and used and
=== System properties
-All system properties defined in the Hop configuration file 'config.json' are
available as variables as well as all Java system properties.
+All system properties defined in the Hop configuration file 'hop-config.json'
are available as variables as well as all Java system properties.
You can define new system properties in the Hop GUI using the system
properties editor:
image::system-properties-menu.png[The system properties menu in Hop GUI]
-You can also edit the config.json file manually:
+You can also edit the 'hop-config.json' file manually:
[source,json]
{
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc
b/docs/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc
index 7d2af55..1b08720 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc
@@ -52,7 +52,7 @@ Once done you will see a `googleCloud` entry in the central
`hop-config.json` fi
== Usage and testing
-To test if the configuration works type use File/Open in the GUI and type in
googledrive:// as a file location.
+To test if the configuration works type use File/Open in the GUI and type in
gs:// as a file location.
Then hit enter (or click the refresh button).
Browse to a CSV, JSON or text file you uploaded and open it.
If all is configured correctly you should be able to see the content in the
Hop GUI.
