Updated Portable Documentation #323

tst-ppenev · 2017-07-12T21:41:47Z

Fixes #274
Updated documented procedures for using Portable Globe Server with the current Open Source implementation.

References to Mac OS X have been removed, since Portable Server hasn't been tested on Mac OS.
The answer document titled "Portable Globe and Server 4.4" has been renamed to "Portable Globe and Server 5.2", and should be removed, since it has been replaced by content in a number of other documents. That task hasn't been performed for this issue ticket.
References to OS installers for Portable have been replaced by references to the build instructions on the online Wiki and running Portable from the built Portable archive.
References to the Google Earth Plug-in have been augmented with notices that the plug-in has been discontinued.
Configuration file, and globe and map directory paths have been updated.
Command-line options for command-line utilities have been updated.
The instructions for enabling broadcasting on a served globe have been updated.
Broadcasting enabled and broadcasting disabled icons (<broadcast_true.gif> and <broadcast_false.gif>) have been copied to the documentation folder.
CSS classes have been added for displaying these icons inline in document text.

Conflicts: docs/geedocs/answer/3230746.html docs/geedocs/answer/3230807.html

googlebot · 2017-07-12T21:41:49Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If your company signed a CLA, they designated a Point of Contact who decides which employees are authorized to participate. You may need to contact the Point of Contact for your company and ask to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the project maintainer to go/cla#troubleshoot.
In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again.

tst-ppenev · 2017-07-12T21:42:14Z

I signed it!

tst-awankhede

My only comment is, before these changes go in , we should capture somewhere that Mac OS is support for Portable was part of original product, but just not tested. Also open a ticket to test Mac OS and update this doc upon completion of the same.

tst-awankhede

opened #333

tst-ppenev · 2017-07-13T15:42:26Z

@tst-awankhede: Mac OS is mentioned on the Wiki page for Portable.

I think we may have forgotten to migrate some of the tickets for testing on Mac OS. We can synchonize with #333.

tst-lsavoie · 2017-07-13T19:13:48Z

docs/geedocs/answer/3230746.html

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta charset="UTF-8"/>
-<title>Portable User Guide for Mac OS, Windows, and Linux</title>
+<title>Portable User Guide for Windows, and Linux</title>


Nit: I don't think the comma is necessary.

😃 I don't think we have a comma style for the documentation. I'd rather leave the documents as they are, and not go through looking for commas.

tst-lsavoie · 2017-07-13T19:13:55Z

docs/geedocs/answer/3230746.html

 </div>
 <div class="content"> <a name="top_of_file"></a>
  <p><img src="../art/common/googlelogo_color_260x88dp.png" width="130" height="44" alt="Google logo" /></p>
  <h1><a href="../index.html">Google Earth Enterprise Documentation Home</a> | Portable</h1>
-  <h2>Portable User Guide for Mac OS, Windows, and Linux</h2>
+  <h2>Portable User Guide for Windows, and Linux</h2>


tst-lsavoie · 2017-07-13T19:15:21Z

docs/geedocs/answer/3230746.html

@@ -43,8 +43,8 @@
  <h2><a name="Introduction">Introduction</a></h2>
  <h3>Google Earth Enterprise Portable</h3>
  <p>Google Earth Enterprise Portable (GEE Portable) lets you view portable globes and maps on your laptop or desktop without requiring network access. This is useful for emergency responses to disasters like earthquakes or floods, or for maps that contain private information that you don’t want to share on the internet.</p>
-  <p>You can install GEE Portable on a Windows, Mac OS X, or Linux machine. It starts within seconds and automatically launches a web browser to display one of the portable globes or maps that's been saved to the GEE Portable <code>maps</code> directory.</p>
-  <div class="note"> <strong>Note:</strong> Instead of using GEE Portable, you can also connect to a portable globe or map with the Google Earth Enterprise Client (Google Earth EC) or the Google Earth Plug-in. </div>
+  <p>You can install GEE Portable on a Windows, or Linux machine. It starts within seconds, and, then, you can launch a web browser to display one of the portable globes or maps that's been saved to the GEE Portable <code>data</code> directory.</p>


Commas, commas everywhere!

"seconds, and, then, you" - I'm pretty sure not all of those commas are needed.

I like commas.

Well, a comma, indicates a, pause, when you read something outloud. So, maybe this, sentence, is meant to be, read like you're, William Shatner.

tst-lsavoie · 2017-07-13T19:16:06Z

docs/geedocs/answer/3230746.html

-    <li>Red Hat Enterprise Linux versions 5.6 to 6.2, including the most recent security patches</li>
-    <li>Ubuntu 10.04 LTS and 12.04 LTS</li>
+    <li>Windows 7 and 10</li>
+    <li>Red Hat Enterprise Linux versions 6.9 and 7, including the most recent security patches</li>


Has this been tested on RHEL 6.9? We don't support fusion and server on 6.9 yet.

Hm. Maybe not, yet. Are we planning on supporting 6.9, or should I remove it from here.

We'll eventually (maybe even soon) add support for RHEL 6, but I'd suggest taking it out for now.

tst-lsavoie · 2017-07-13T19:26:42Z

docs/geedocs/answer/4485225.html

  <p>If you'd like to make your own custom Earth API application, make a copy of the included file from which to start.</p>
  <p>You can also reach the page listed above by clicking <strong>view in browser</strong> from the administration page at <code>http://localhost:9335</code>.</p>
  <hr/>
+  <!--


Are we keeping the commented out sections for a reason?

Oh, I can delete that. I wasn't completely sure if the new Portable Server no longer supports key authentication. It seems that it doesn't.

Oh, I can delete that. I wasn't sure if the new Portable Server no longer supports key authentication. It seems that it doesn't, but I haven't looked through the code thoroughly enough to be sure.

tst-lsavoie · 2017-07-13T19:27:39Z

docs/geedocs/answer/4485225.html

-    --dbroot_file=<em>filename</em> [--search_server=<em>server_name</em>]<br/>
-    [--search_port=<em>num]</em> [--kml_map_file=<em>filename]</em> [--kml_server=<em>server_name]</em><br/>
+    --dbroot_file=<em>filename</em>  --kml_map_file=<em>filename</em><br/>
+    [--search_service=<em>search_service_url</em>] [--kml_server=<em>server_name]</em><br/>


Just double checking - did this change from --search_server to --search_service?

Yeah, at least, according to what I have on my machine. server and port became service URL.

tst-lsavoie · 2017-07-13T19:28:10Z

docs/geedocs/answer/4580164.html

@@ -24,7 +24,7 @@
 <p>For information about new features and known issues, see What's new in Portable.</p>
 <h3>How to install, use, and customize Portable:</h3>
 <ul>
-<li><a href="../answer/3230746.html">Portable User Guide for Mac OS, Windows, or Linux</a>. Information about viewing portable globes and maps on your laptop or desktop computer.</li>
+<li><a href="../answer/3230746.html">Portable User Guide for Windows, or Linux</a>. Information about viewing portable globes and maps on your laptop or desktop computer.</li>


tst-lsavoie · 2017-07-13T20:38:05Z

docs/geedocs/answer/4485225.html

@@ -13,14 +13,14 @@
  <p class="sidebar-toc"><a href="../answer/4580164.html">Welcome to Portable 5.0</a></p>
  <p class="sidebar-toc"><a href="../answer/4594620.html">Portable Release Notes 5.0</a></p>
  <p class="sidebar-toc"><a href="../answer/3230746.html">Portable User Guide</a></p>
+  <p class="sidebar-toc"><a href="../answer/4485225.html" class="current-file">Portable Globe and Server 5.2</a></p>


I can't mark it in the right spot, but the page title (line 28 in the new document) still says 4.4.

tst-lsavoie · 2017-07-13T20:46:25Z

docs/geedocs/answer/4485225.html

-    <li>A <code>share.glr</code> file is created and saved to your browser's default download directory. This file can be sent to any user who requires a connection to your globe; the remote client must also be installed on their machine.</li>
+    <li>Make sure <code>disable_broadcasting</code> is set to <code>False</code> in your <code>portable.cfg</code>.</li>
+    <li>If you're not already serving a globe, select the globe to serve from the Portable Server interface.</li>
+    <li>On the Portable Server administrative page, click the broadcast icon (<img class="inline line-sized" alt="Broadcast globe icon" src="../art/fusion/portable/broadcast_false.gif"/>).</li>


Just want to double check that we've got the right icon in the right place. If you want to broadcast, you click the icon that shows that you're not broadcasting? Also, I don't see broadcast_true.gif being used anywhere.

Yeah, the icon changes from broadcast_false to broadcast_true when you click it. If you click the broadcast_true one, you'd be stopping the broadcasting.

I didn't use broadcast_true.gif anywhere, but I thought, if we have one, we should have the other, as well, in case we need to use it later on when we update the documentation.

* Fix as reported in pull request comments by Lee.

tst-lsavoie · 2017-07-14T17:03:02Z

Everything looks good to me. I'm going to keep it open for now in case @tst-ccamp or @tst-awankhede have anything else to add.

tst-ccamp

I just have some minor change requests. It should only take a few minutes to do.

tst-ccamp · 2017-07-14T18:23:22Z

docs/geedocs/answer/3230777.html

@@ -67,7 +67,7 @@
 <h3>Composite globes and maps</h3>
 <p>Portable globes and maps can also be assembled into layers to create a composite globe or map, a single file (<code>.glc</code>) that contains all the geospatial data for assembled layers. To assemble a composite file, you supply a KML polygon to cut your area of interest, then specify the layers and order in which they display. See <a href="../answer/4643041.html">Create composite globes and maps</a>.</p>
 <h2><a name="creating_a_portable_globe"></a>Create a portable globe or map</h2>
-<p>Cutting a globe or map is accomplished with a simple web interface. You use your mouse, or import KML, to define a polygon, which defines your 'area of interest.' This polygon not only defines the area that displays high-resolution imagery, but is also used by Fusion to create a localized search database.</p>
+<p>Cutting a globe or map is accomplished with a simple web interface. You import KML, or use your mouse, to define a polygon, which defines your 'area of interest.' This polygon not only defines the area that displays high-resolution imagery, but is also used by Fusion to create a localized search database.</p>


Nit: we should use double quotes in documentation instead of single quotes

I can change this one, but I can't promise what's used in the rest of the documentation. These quotes are unchanged from what they were before.

tst-ccamp · 2017-07-14T18:26:37Z

docs/geedocs/answer/3230777.html

@@ -123,6 +123,7 @@ <h3 id="globe_name">Map or globe name</h3>
 <h3 id="drawing_the_polygon">Drawing the polygon</h3>
 <p>Once the globe or map name has been specified, you can define the geographic region to be cut by drawing a polygon on the globe. There are two ways to draw the polygon.</p>
 <h4>Hand drawing the polygon</h4>
+<div class="alert"><p>This method is only available if you are running the discontinued Google Earth Plug-in in your browser.</p></div>


This is only true on globes. You can still draw the polygon on maps without the plugin. This should be updated with that distinction.

tst-ccamp · 2017-07-14T18:29:30Z

docs/geedocs/answer/3230807.html

@@ -42,19 +42,19 @@
 <p>You can customize or extend GEE Portable, or create applications that work with it.</p>
 <p>To help you get started, Google provides two <code>Hello World!</code> files that you can copy and use as templates. These files (<code>Hello_Maps.html</code> for 2D maps and <code>Hello_Earth.html</code> for 3D globes) call the required scripts, load the globe or map, define the <code>.css</code> file, and so on. The files include JSON and, if needed, KML polygons.</p>
 <p>See the resources linked to below to learn how to edit and extend the <code>Hello_Maps.html</code> and <code>Hello_Earth.html</code> files.</p>
-<p><strong>Note</strong>: Although it is possible to configure GEE Portable to display multiple globes or maps at the same time, this isn't recommended or supported. The additional configuration requires you to build the globe or map to reference a specific port number, so you can no longer re-use it for any other ports.</p>
+<p><strong>Note</strong>: Although it is possible to configure GEE Portable to display multiple globes or maps at the same time, this isn't recommended or supported.</p>


Nit: This seems like a strange place for this disclaimer. Maybe it should be moved to a "Limitations" section on the page.

I'm, actually, not sure it even applies the way it's written. I think in Portable Server 5, you'll have to run two separate instances of the server on different ports to serve multiple globes or maps. I don't think you can server them from a single server.

I think I may just remove that paragraph.

tst-ccamp · 2017-07-14T19:55:19Z

docs/geedocs/answer/4485225.html

    </li>
-    <li>Click <strong>start serving</strong> next to the globe you wish to serve.</li>
+    <li>Navigate to the Portable Server administrative page at <code>http://localhost:9335</code>, using whatever <code>port</code> you've used in <code>portable.cfg</code>.</li>


This sounds a little confusing, like you need to configure the port manually.
How about this?

Navigate to the Portable Server administrative page at <code>http://localhost:9335</code>. If you have set a custom <code>port</code> number in <code>portable.cfg</code>, substitute that instead of "9335".

tst-ccamp · 2017-07-14T19:58:08Z

docs/geedocs/answer/4485225.html

  <h3 id="portable_cfg">Defining options in portable.cfg</h3>
-  <p>The <strong>Tools</strong> directory (<code>.apps</code> on OS X) in the portable server folder hierarchy contains the main configuration file, <code>portable.cfg</code>. This file defines a number of options, but is primarily used to change the port on which the globe is served, if required.</p>
+  <p>The <strong>server</strong> directory under the directory the Portable Server archive is unpacked contains the main configuration file, <code>portable.cfg</code>. This file defines a number of options, but is primarily used to change the port on which the globe is served, if required.</p>


This wording is awkward. Try "The server directory under the Portable Server installation path contains..."

tst-ppenev added 3 commits July 12, 2017 01:35

GP-218: Initial update to User Guide and Portable and Globe Server.

43dede3

GP-218: Fixes to Mac OS, GEE pre-open source references.

e1e3ddf

Merge branch 'master' into GP-218_Updated-Portable-documentation

fea74fe

Conflicts: docs/geedocs/answer/3230746.html docs/geedocs/answer/3230807.html

tst-awankhede reviewed Jul 13, 2017

View reviewed changes

tst-lsavoie reviewed Jul 13, 2017

View reviewed changes

tst-ppenev added 2 commits July 13, 2017 16:07

GP-218: Remove reference to RHEL 6.9 for now.

4df821c

GP-218: Remove commented-out sections on .glr and keys.

146db52

tst-lsavoie reviewed Jul 13, 2017

View reviewed changes

GP-218: Fix Portable version number.

ec6707a

* Fix as reported in pull request comments by Lee.

tst-lsavoie approved these changes Jul 14, 2017

View reviewed changes

tst-ccamp changed the title ~~GP-218: Updated Portable Documentation~~ Updated Portable Documentation Jul 14, 2017

tst-ccamp suggested changes Jul 14, 2017

View reviewed changes

\google#274: Small changes in response to pull request comments.

79727df

tst-ccamp approved these changes Jul 17, 2017

View reviewed changes

tst-ccamp merged commit 3d411d5 into google:master Jul 17, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated Portable Documentation #323

Updated Portable Documentation #323

tst-ppenev commented Jul 12, 2017 •

edited by tst-ccamp

Loading

googlebot commented Jul 12, 2017

tst-ppenev commented Jul 12, 2017 •

edited

Loading

tst-awankhede left a comment

tst-awankhede left a comment

tst-ppenev commented Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-ppenev Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-ppenev Jul 13, 2017

tst-ccamp Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-ppenev Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-ppenev Jul 13, 2017

tst-ppenev Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-ppenev Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-lsavoie Jul 13, 2017

tst-ppenev Jul 14, 2017

tst-lsavoie Jul 13, 2017 •

edited

Loading

tst-ppenev Jul 14, 2017

tst-lsavoie commented Jul 14, 2017

tst-ccamp left a comment

tst-ccamp Jul 14, 2017

tst-ppenev Jul 14, 2017

tst-ccamp Jul 14, 2017

tst-ccamp Jul 14, 2017

tst-ppenev Jul 14, 2017

tst-ccamp Jul 14, 2017

tst-ccamp Jul 14, 2017

Updated Portable Documentation #323

Updated Portable Documentation #323

Conversation

tst-ppenev commented Jul 12, 2017 • edited by tst-ccamp Loading

googlebot commented Jul 12, 2017

tst-ppenev commented Jul 12, 2017 • edited Loading

tst-awankhede left a comment

Choose a reason for hiding this comment

tst-awankhede left a comment

Choose a reason for hiding this comment

tst-ppenev commented Jul 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tst-lsavoie Jul 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tst-lsavoie commented Jul 14, 2017

tst-ccamp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tst-ppenev commented Jul 12, 2017 •

edited by tst-ccamp

Loading

tst-ppenev commented Jul 12, 2017 •

edited

Loading

tst-lsavoie Jul 13, 2017 •

edited

Loading