You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by ha...@apache.org on 2021/04/22 21:15:36 UTC
[incubator-hop] branch master updated: HOP-2768 hop web initial
documentation
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 afeb25b HOP-2768 hop web initial documentation
new 4f05065 Merge pull request #763 from bamaer/HOP-2768
afeb25b is described below
commit afeb25b6db0634eea97f2586196a52f6c59253ab
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Thu Apr 22 21:26:43 2021 +0200
HOP-2768 hop web initial documentation
---
docs/hop-dev-manual/modules/ROOT/nav.adoc | 5 +-
.../pages/{webhop => hopweb}/developer-guide.adoc | 0
.../hopweb-antipatterns.adoc} | 0
.../modules/ROOT/pages/hopweb/index.adoc | 46 ++++++++++++++++++
.../modules/ROOT/pages/webhop/index.adoc | 19 --------
.../modules/ROOT/assets/images/hop-web.png | Bin 0 -> 359525 bytes
docs/hop-user-manual/modules/ROOT/nav.adoc | 1 +
.../modules/ROOT/pages/hop-gui/hop-web.adoc | 54 +++++++++++++++++++++
.../modules/ROOT/pages/hop-gui/index.adoc | 3 +-
9 files changed, 106 insertions(+), 22 deletions(-)
diff --git a/docs/hop-dev-manual/modules/ROOT/nav.adoc b/docs/hop-dev-manual/modules/ROOT/nav.adoc
index 2c03e7f..9bf11c6 100644
--- a/docs/hop-dev-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/nav.adoc
@@ -28,7 +28,8 @@ under the License.
** xref:apache-release/creating-a-release.adoc[Creating a Release]
** xref:apache-release/promoting-a-release.adoc[Promoting a Release]
** xref:apache-release/checking-a-release.adoc[Checking a Release]
-* xref:webhop/index.adoc[Hop Web]
-** xref:webhop/developer-guide.adoc[Webhop Developer Guide]
+* xref:hopweb/index.adoc[Hop Web]
+** xref:hopweb/developer-guide.adoc[Hop Web Developer Guide]
+** xref:hopweb/hopweb-antipatterns.adoc[Hop Web Antipatterns]
* xref:sdk/index.adoc[SDK]
** xref:sdk/hop-sdk.adoc[The Hop SDK]
\ No newline at end of file
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/webhop/developer-guide.adoc b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/developer-guide.adoc
similarity index 100%
rename from docs/hop-dev-manual/modules/ROOT/pages/webhop/developer-guide.adoc
rename to docs/hop-dev-manual/modules/ROOT/pages/hopweb/developer-guide.adoc
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/webhop/webhop-antipatterns.adoc b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/hopweb-antipatterns.adoc
similarity index 100%
rename from docs/hop-dev-manual/modules/ROOT/pages/webhop/webhop-antipatterns.adoc
rename to docs/hop-dev-manual/modules/ROOT/pages/hopweb/hopweb-antipatterns.adoc
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc
new file mode 100644
index 0000000..eaf8ea9
--- /dev/null
+++ b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc
@@ -0,0 +1,46 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Hop Web Development Guide
+
+
+== Building or customizing Hop Web
+
+Building and setting up your own Hop Web environment is straightforward.
+
+The steps to set up the default Docker image are included in a helper script `docker/create_hop_web_container.sh` in the Hop code base. This should get you started to make modifications or create your own version entirely.
+
+[source,bash]
+----
+#set working dir to current location
+cd "${0%/*}"
+
+#unzip files for docker image
+unzip ../assemblies/web/target/hop.war -d ../assemblies/web/target/webapp
+unzip ../assemblies/plugins/dist/target/hop-assemblies-*.zip -d ../assemblies/plugins/dist/target/
+
+#build docker image
+docker build ../ -f Dockerfile.web -t hop-web
+
+#cleanup
+rm -rf ../assemblies/web/target/webapp
+rm -rf ../assemblies/plugins/dist/target/plugins
+----
+
+== Additional Guides
+
+* xref:hopweb/developer-guide.adoc[Developer Guide]
+* xref:hopweb/hopweb-antipatterns.adoc[Hop Web Antipatterns]
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/webhop/index.adoc b/docs/hop-dev-manual/modules/ROOT/pages/webhop/index.adoc
deleted file mode 100644
index 122eb8e..0000000
--- a/docs/hop-dev-manual/modules/ROOT/pages/webhop/index.adoc
+++ /dev/null
@@ -1,19 +0,0 @@
-////
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
-////
-= Index Page
-
-* xref:webhop/developer-guide.adoc[Developer Guide]
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/hop-web.png b/docs/hop-user-manual/modules/ROOT/assets/images/hop-web.png
new file mode 100644
index 0000000..118b827
Binary files /dev/null and b/docs/hop-user-manual/modules/ROOT/assets/images/hop-web.png differ
diff --git a/docs/hop-user-manual/modules/ROOT/nav.adoc b/docs/hop-user-manual/modules/ROOT/nav.adoc
index decc71e..846a64f 100644
--- a/docs/hop-user-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-user-manual/modules/ROOT/nav.adoc
@@ -29,6 +29,7 @@ under the License.
** xref:hop-gui/perspectives.adoc[Perspectives]
** xref:hop-gui/hop-gui-git.adoc[Working with git]
** xref:hop-gui/shortcuts.adoc[Keyboard Shortcuts]
+** xref:hop-gui/hop-web.adoc[Hop Web (Experimental)]
* xref:projects/index.adoc[Projects]
** xref:projects/projects-environments.adoc[Projects & Environments]
** xref:projects/metadata.adoc[Metadata]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-web.adoc b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-web.adoc
new file mode 100644
index 0000000..e5aceec
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-web.adoc
@@ -0,0 +1,54 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+:imagesdir: ../assets/images
+
+= Hop Web (Experimental)
+
+Hop Web is a web based Hop Gui version. Hop Gui was designed from the ground up to be web-ready. You'll barely notice any difference between working in the Hop Gui _fat client_ or Hop Web.
+
+WARNING: Even though Hop Web is largely functional, there still are a couple of bugs that need to be ironed out before it is ready for prime time. The most important issues are:
+
+* copy/paste does not work
+* keyboard shortcuts do not work, do not overrule your browser's default etc.
+
+== Getting Hop Web
+
+Hop Web is included in the default Hop build. With each build, an update is pushed to https://hub.docker.com/r/apache/incubator-hop-web[Docker Hub].
+
+This continously updated docker image is by far the easiest way to try out Hop Web:
+
+Pull the latest build with: `docker pull apache/incubator-hop-web`.
+
+TIP: Given Hop Web's experimental status, you're strongly encouraged to test with the latest and greatest image available.
+
+Once the image has been pulled, start Hop Web with `docker run -p 8080:8080 apache/incubator-hop-web:latest`
+
+The Hop Web container should only take a couple of seconds to start. Your container logs should output similar to the example below:
+
+[source, bash]
+----
+22-Apr-2021 18:13:39.786 INFO [main] org.apache.catalina.startup.HostConfig.deployDirectory Deployment of web application directory [/usr/local/tomcat/webapps/ROOT] has finished in [8,274] ms
+22-Apr-2021 18:13:39.790 INFO [main] org.apache.coyote.AbstractProtocol.start Starting ProtocolHandler ["http-nio-8080"]
+22-Apr-2021 18:13:39.797 INFO [main] org.apache.catalina.startup.Catalina.start Server startup in [8319] milliseconds
+2021/04/22 18:14:37 - Hop - Projects enabled
+2021/04/22 18:14:37 - Hop - Enabling project : 'default'
+----
+
+Once your container has started, Hop Web is available at http://localhost:8080/ui. You'll feel right at home!
+
+image:hop-web.png[Hop Web, width="90%"]
+
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 30a1b65..724fd7f 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
@@ -27,4 +27,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
+* xref:hop-gui/shortcuts.adoc[Keyboard Shortcuts]: a list of the keyboard shortcuts that are available in Hop Gui.
+* xref:hop-gui/hop-web.adoc[Hop Web (Experimental)]: a web version of Hop Gui that is not yet 100% ready for daily use, but getting closer every day
\ No newline at end of file