[incubator-hop] branch master updated: HOP-2742 - working with git documentation

[ha...@apache.org]

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 ec14e93  HOP-2742 - working with git documentation
     new ac494b0  Merge pull request #747 from bamaer/HOP-2742
ec14e93 is described below

commit ec14e933864f0b35933534974b38e7ba5a121062
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Fri Apr 16 08:27:46 2021 +0200

    HOP-2742 - working with git documentation
---
 .../ROOT/assets/images/hop-gui/git-visual-diff.png | Bin 0 -> 20667 bytes
 .../assets/images/hop-gui/hop-gui-git-toolbar.png  | Bin 0 -> 6195 bytes
 .../ROOT/assets/images/hop-gui/hop-gui-no-git.png  | Bin 0 -> 4822 bytes
 docs/hop-user-manual/modules/ROOT/nav.adoc         |   1 +
 .../modules/ROOT/pages/hop-gui/hop-gui-git.adoc    |  48 ++++++++++++++++++++-
 .../modules/ROOT/pages/hop-gui/index.adoc          |   1 +
 6 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/git-visual-diff.png b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/git-visual-diff.png
new file mode 100644
index 0000000..638f7e0
Binary files /dev/null and b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/git-visual-diff.png differ
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/hop-gui-git-toolbar.png b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/hop-gui-git-toolbar.png
new file mode 100644
index 0000000..60e56da
Binary files /dev/null and b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/hop-gui-git-toolbar.png differ
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/hop-gui-no-git.png b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/hop-gui-no-git.png
new file mode 100644
index 0000000..2660890
Binary files /dev/null and b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/hop-gui-no-git.png differ
diff --git a/docs/hop-user-manual/modules/ROOT/nav.adoc b/docs/hop-user-manual/modules/ROOT/nav.adoc
index d96eae8..8b0996d 100644
--- a/docs/hop-user-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-user-manual/modules/ROOT/nav.adoc
@@ -11,6 +11,7 @@
 * xref:hop-gui/index.adoc[Hop Gui]
 ** xref:hop-gui/file-dialog.adoc[File Dialog]
 ** xref:hop-gui/perspectives.adoc[Perspectives]
+** xref:hop-gui/hop-gui-git.adoc[Working with git]
 ** xref:hop-gui/shortcuts.adoc[Keyboard Shortcuts]
 * xref:projects/index.adoc[Projects]
 ** xref:projects/projects-environments.adoc[Projects & Environments]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
index 6638c25..0bc2306 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
@@ -1,3 +1,49 @@
+:imagesdir: ../assets/images
+
 = Working with git
 
-Coming soon
\ No newline at end of file
+Version control is an important aspect of any serious data orchestration project. Hop wants to make it as easy as possible to manage versions for your workflows and pipelines through the integrated git options in the xref:hop-gui/perspectives.adoc#_file_explorer_perspective[File Explorer perspective].
+
+== File Explorer Toolbar
+
+The toolbar in the file explorer's tree dialog will enable the git options when it detects the project's root directory is a git repository (has a `.git` folder).
+
+image:hop-gui/hop-gui-no-git.png[No git available, width="30%", link=hop-gui/hop-gui-no-git.png]
+
+If git was found, the toolbar will be shown with the git options enabled.
+
+image:hop-gui/hop-gui-git-toolbar.png[Git toolbar, width="30%", link=hop-gui/hop-gui-git-toolbar.png]
+
+The options available in this toolbar are:
+
+* Open selected file
+* Delete Selected File
+* Refresh
+* Git info
+* Git Add
+* Git revert file to last committed version (HEAD)
+* Git commit
+* Git push
+* Git pull
+
+== File Explorer Tree
+
+In the folder and file structure tree below the toolbar, files use a color coding scheme to indicate the git status of a file:
+
+* black: unchanged. This is the latest version of the file available in git, no changes detected.
+* grey: this file is ignored
+* blue: staged for commit. This file is ready to be committed ('Git Commit')
+* red: not staged for commit. Add this file to git before changes can be committed ('Git Add').
+
+== Working with files in git
+
+Add a file::
+Click on a file that is not yet staged for commit (red), click 'Git Add'. The color of the file changes to blue (staged for commit).
+
+Commit a file::
+Click on a file that is staged for commit (blue), click 'Git Commit'. A popup dialog will ask to confirm the file to commit, and will show a popup for your commit message. Change the default 'Commit Message' to a commit message that describes the changes you made to the file. The file color changes to black (no changes).
+
+Show git info::
+Click on a file that is under version control (black or blue). The file explorer will show the git status for this file: the file or folder, status, branch and a revisions table (list of previous commits). Select one of the available commits to show the changed files to show the changed files for that revision. Select any of the files in the revision from the 'Changed files' list to show the git diff information on the right hand side. For workflows and pipelines, click 'Visual diff' to  [...]
+
+image:hop-gui/git-visual-diff.png[Git visual diff, width="65%", link=hop-gui/git-visual-diff.png]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
index ae78a83..1398af1 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
@@ -10,4 +10,5 @@ Covered here are
 
 * xref:hop-gui/file-dialog.adoc[File Dialog]: the versatile Hop file browser and chooser dialog.
 * xref:hop-gui/perspectives.adoc[Perspectives]: the various perspectives in the Hop Gui
+* xref:hop-gui/hop-gui-git.adoc[Working with git]: Manage files in the git version control system
 * xref:hop-gui/shortcuts.adoc[Keyboard Shortcuts]: a list of the keyboard shortcuts that are available in Hop Gui.
\ No newline at end of file