This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hop-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new ee2eda161f Website updated to 5fba80f
ee2eda161f is described below
commit ee2eda161f89c64b78eff251eb6e54fbdba22c4e
Author: jenkins <[email protected]>
AuthorDate: Fri Sep 25 09:10:07 2026 +0000
Website updated to 5fba80f
---
manual/next/projects/projects-environments.html | 37 +++++++++++++++++++++++--
1 file changed, 34 insertions(+), 3 deletions(-)
diff --git a/manual/next/projects/projects-environments.html
b/manual/next/projects/projects-environments.html
index f7fd6383a0..a6482a4d3e 100644
--- a/manual/next/projects/projects-environments.html
+++ b/manual/next/projects/projects-environments.html
@@ -3180,12 +3180,19 @@ The fields are grouped on tabs:
<strong>General</strong>, <strong>Configuration
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Configuration files</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">One or
more files that define environment-specific variables</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">One or
more files that define environment-specific variables. Each row is a filename
and a description</p></td>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Yes</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Short note
about that file. It is stored in the JSON file, not on the environment</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Import
variables</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Scan the
project for <code>${VARIABLE}</code> expressions and add missing names to a
configuration file</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
@@ -3208,7 +3215,7 @@ The fields are grouped on tabs: <strong>General</strong>,
<strong>Configuration
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Edit…​</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Open the
selected configuration file to set variable names, values and
descriptions</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Open the
selected configuration file to set its description and the variable names,
values and descriptions</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
<td class="tableblock halign-left valign-top"></td>
@@ -3228,7 +3235,8 @@ See <a href="../best-practices/index.html" class="xref
page">Best practices: sec
<p><span class="image"><img
src="../_images/hop-gui/environment/environment-files.png" alt="Environment
configuration files" width="90%"></span></p>
</div>
<div class="paragraph">
-<p><strong>Edit…​</strong> opens the described variables dialog
for the selected file:</p>
+<p><strong>Edit…​</strong> opens the described variables dialog
for the selected file.
+The description at the top of that dialog is the same file description as the
<strong>Description</strong> column.</p>
</div>
<div class="imageblock">
<div class="content">
@@ -3236,6 +3244,29 @@ See <a href="../best-practices/index.html" class="xref
page">Best practices: sec
</div>
</div>
<div class="paragraph">
+<p>The description is written into the configuration file when you confirm the
environment dialog.
+A file whose description did not change is left as it is.
+A file that does not exist yet is created when the description is not empty.
+Hover a row to see that description and the variables stored in the file.
+Values are shown as they are written, not with variables resolved.
+The value is hidden when the variable name contains <code>password</code>,
<code>passwd</code>, <code>secret</code>, <code>token</code> or
<code>credential</code>, and when the value is an encrypted Hop password.</p>
+</div>
+<div class="paragraph">
+<p>A configuration file looks like this:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<div class="code-lang" data-pagefind-ignore>json</div><pre class="highlightjs
highlight is-highlighted"><code class="language-json hljs"
data-lang="json"><span class="hljs-punctuation">{</span>
+ <span class="hljs-attr">"description"</span> <span
class="hljs-punctuation">:</span> <span class="hljs-string">"Warehouse
connection for this environment"</span><span
class="hljs-punctuation">,</span>
+ <span class="hljs-attr">"variables"</span> <span
class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span> <span
class="hljs-punctuation">{</span>
+ <span class="hljs-attr">"name"</span> <span
class="hljs-punctuation">:</span> <span
class="hljs-string">"DB_HOSTNAME"</span><span
class="hljs-punctuation">,</span>
+ <span class="hljs-attr">"value"</span> <span
class="hljs-punctuation">:</span> <span
class="hljs-string">"db.example.com"</span><span
class="hljs-punctuation">,</span>
+ <span class="hljs-attr">"description"</span> <span
class="hljs-punctuation">:</span> <span class="hljs-string">"Warehouse
host"</span>
+ <span class="hljs-punctuation">}</span> <span
class="hljs-punctuation">]</span>
+<span class="hljs-punctuation">}</span></code></pre>
+</div>
+</div>
+<div class="paragraph">
<p>When you browse for a file or directory in Hop Gui with a project active,
paths under a matching path-like variable are rewritten automatically. For
example, <code>${PROJECT_HOME}</code> is used for files under the project home,
and an environment variable such as <code>SOURCE_FILES=/data/incoming</code>
(or <code>SOURCE_FILES=~/incoming</code>) rewrites a selection under that
folder to <code>${SOURCE_FILES}/…</code>. If more than one variable matches,
the longest (most specific) path [...]
</div>
<div class="paragraph">
