Documentation cleanup #276

tst-lsavoie · 2017-06-26T22:17:16Z

Fixes #244.

This PR fixes sections of the documentation that are out of date because of the transition to open source. It also includes several other minor documentation fixes. Some obsolete sections were not fixed under this PR; I have opened tickets #253, #270, #271, #272, #273, and #274 to fix these issues. Anything I missed can be fixed under a separate ticket.

You can see the updated documents here: https://tst-lsavoie.github.io/earthenterprise

tst-lsavoie · 2017-06-27T16:13:51Z

Also fixes #209.

tst-lsavoie · 2017-06-27T17:44:27Z

I'll fix the conflicts tomorrow, but the content of the changes will be the same.

Much of the documentation is obsolete due to open sourcing GEE. This PR updates much of the obsolete documentation, including things like installation instructions, removing references to Google support, fixing broken links, etc. It also includes some minor documentation clean up.

tst-lsavoie · 2017-06-28T15:51:24Z

I've now fixed the conflicts, so this is ready for review and merging.

bradh

Only had a quick skim, but looks like a lot of good fixes.

bradh · 2017-07-01T09:20:30Z

docs/geedocs/answer/1066449.html

@@ -45,7 +44,8 @@
 <li>Create a symbolic link from the custom folder to the original folder location:<br/>
 <code>ln -sf <em>/gevol/src/globes</em> /opt/google/gehttpd/htdocs/cutter/globes</code></li>
 <li>Change ownership of the custom folder to <code>geapacheuser:gegroup</code> and change permissions to 755 (rwxr-wr-w):<br/>
-<code>chown -R geapacheuser:gegroup <em>/gevol/src/globes</em> chmod -R 755 /gevol/src/globes</code></li>
+<code>chown -R geapacheuser:gegroup <em>/gevol/src/globes</em></code><br/>
+<code> chmod -R 755 /gevol/src/globes</code></li>


Space probably isn't needed.

bradh · 2017-07-01T09:24:11Z

docs/geedocs/answer/173078.html

 <li>Enter:<br/>
 <code>ps aux | grep ge</code></li>
 <li>Look for and stop any Fusion processes in the output.</li>
 <li>Make sure that you have enough free disk space, and then enter:<br/>
-<code>/etc/init.d/gefusion start /etc/init.d/gesystem start</code></li>
+<code>/etc/init.d/gefusion start</code><br/>
+<code>/etc/init.d/gesystem start</code></li>


Is there really a process for this? Perhaps geserver?

bradh · 2017-07-01T09:24:16Z

docs/geedocs/answer/173076.html

@@ -47,5 +47,6 @@
 <p>This appears in the vector Asset Log or when starting Fusion from the command line when the system daemons are not running.</p>
 <h2>Resolution</h2>
 <p>From the command line, enter:</p>
-<code>sudo /etc/init.d/gesystem stop</code> <code>sudo /etc/init.d/gesystem start</code>
+<code>sudo /etc/init.d/gesystem stop</code><br/>
+<code>sudo /etc/init.d/gesystem start</code>


Is there really a process for this? Perhaps geserver?

bradh · 2017-07-01T09:26:12Z

docs/geedocs/answer/2987876.html

@@ -22,7 +21,7 @@
 All rights reserved.</p>
 <p>Google, Google Earth, and Keyhole are trademarks or registered trademarks of Google, Inc. in the United States and elsewhere. Other trademarks not owned by Google, Inc. are the property of their respective owners.</p>
 <p>All Google and Keyhole logos and graphics are copyrighted. The content of this publication is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Google, Inc.</p>
-<p>This publication is provided pursuant to and subject to the terms of the Google Earth Enterprise <gkms:snippet contenteditable="false" id="2995331"></gkms:snippet> and <gkms:snippet contenteditable="false" id="2995333"></gkms:snippet>. This publication and the information herein may not be reverse engineered, reproduced, duplicated, modified, altered, disclosed, published, printed, or distributed to any third party whatsoever without the express written permission of Google, Inc.</p>
+<p>This publication is provided pursuant to and subject to the terms of Google Earth Enterprise. This publication and the information herein may not be reverse engineered, reproduced, duplicated, modified, altered, disclosed, published, printed, or distributed to any third party whatsoever without the express written permission of Google, Inc.</p>


These aren't consistent with the project license.

I think this entire page needs to be overhauled, so I just wrote #271 to cover it.

bradh · 2017-07-01T09:27:45Z

docs/geedocs/answer/3499938.html

@@ -62,18 +66,17 @@
 <li>SUSE Linux Enterprise Server 10</li>
 <li>Red Hat Enterprise Linux AS 4</li>


Has this actually been tried?

Same comment - I'm assuming Google did this testing.

bradh · 2017-07-01T09:27:55Z

docs/geedocs/answer/3499938.html

@@ -62,18 +66,17 @@
 <li>SUSE Linux Enterprise Server 10</li>


Has this been tried?

Since this is for an old version, I'm assuming Google did the testing before they released it.

I think we should disclose that in the landing page as one more OS and we can specify its not tests in OSS branch , or at least have a ticket to test it.

This is for 5.2.0. Whatever testing happened for it is already in the past. My understanding is that Google is not supporting that any longer, and we're only supporting the open source version. So I'd say we should change the text to read that these older versions were tested on these OS distributions, but it shouldn't read that any of them are supported.

We should say only the open source version is supported on the couple of OS distributions we intend to support.

Actually, I'm not sure we should even have documentation about what versions Google has tested on, or used to support. Unless, someone is going to look for that in the GEE open source documentation, we could, perhaps, just remove all of this information, and only keep what's relevant to the open source version.

tst-lsavoie · 2017-07-03T16:55:04Z

@bradh I've either fixed or responded to your comments. Let me know what you think.

bradh · 2017-07-04T00:21:13Z

My bad on the supported versions. I haven't done a full review but am happy with the changes.

tst-ppenev

Some questions and clarification comments.

tst-ppenev · 2017-07-05T21:29:53Z

docs/geedocs/answer/1066449.html

@@ -45,7 +44,8 @@
 <li>Create a symbolic link from the custom folder to the original folder location:<br/>
 <code>ln -sf <em>/gevol/src/globes</em> /opt/google/gehttpd/htdocs/cutter/globes</code></li>
 <li>Change ownership of the custom folder to <code>geapacheuser:gegroup</code> and change permissions to 755 (rwxr-wr-w):<br/>
-<code>chown -R geapacheuser:gegroup <em>/gevol/src/globes</em> chmod -R 755 /gevol/src/globes</code></li>
+<code>chown -R geapacheuser:gegroup <em>/gevol/src/globes</em></code><br/>
+<code>chmod -R 755 /gevol/src/globes</code></li>


Style: If the chowned path is emphasized, shouldn't the chmoded one be, as well?

tst-ppenev · 2017-07-05T21:35:29Z

docs/geedocs/answer/1089795.html

@@ -128,7 +128,7 @@
 <p>You can obtain a complete copy of the 2D Map layer display rules from the <a href="https://groups.google.com/group/google-earth-enterprise" target="_blank">Google Earth Enterprise</a> Google Group Files section. The maps and hybrid (Show Labels) map layers were built from three different datasets:</p>
 <ul class="spaced-list">
 <li>Global borders (filled and outlined) in the maps and hybrid layers were created from the the Thematic Mapping World Borders dataset, available under a Creative Commons license at <a href="http://thematicmapping.org/downloads/world_borders.php" target="_blank">http://thematicmapping.org/downloads/world_borders.ph</a></li>
-<li>USA state boundaries in the maps and hybrid layers were created from the USA States borders vector data hosted by the <a href="http://www.nationalatlas.gov/" target="_blank">National Atlas of the USA</a>.You can obtain the file from the "Raw Data Download" section at <a href="http://www.nationalatlas.gov/mld/statesp.html" target="_blank">http://www.nationalatlas.gov/mld/statesp.html</a>.</li>
+<li>USA state boundaries in the maps and hybrid layers were created from the USA States borders vector data hosted by the National Atlas of the USA.


I think The National Atlas is now The National Map. It has a download page at https://nationalmap.gov/small_scale/atlasftp.html. Perhaps, we could use the new URL and mention the renaming.

tst-ppenev · 2017-07-05T21:37:22Z

docs/geedocs/answer/172794.html

@@ -19,6 +19,5 @@
 <p>When you install GEE on a server, it queries for the name of the local host by issuing a <code>hostname -f</code> command. Each time you build a resource, project, or database on the server, the host name is added to all the files in each asset’s subdirectory. If you change the hostname or if you move assets to another server, you must also update the <code>assetroot host</code> entry to match the new host name.</p>
 <p>To change the asset root host entry, use the <code>geconfigureassetroot</code> command:</p>
 <code>sudo /opt/google/bin/geconfigureassetroot --fixmasterhost</code>
-<p>For more information about the <code>geconfigureassetroot</code> command, see the <em>Command Line Reference</em> chapter of the <em>Google Earth Enterprise Reference Guide.</em></p>


Can you clarify the reason for removing this paragraph? Do we not have that guide?

I'm not aware of any place that it's publicly available, so the easiest solution was to just remove the reference.

You could link to 6035839.html. It has a lot of info on geconfigureassetroot.

tst-ppenev · 2017-07-05T21:45:30Z

docs/geedocs/answer/2760674.html

 <p><strong>Note</strong>: You might be prompted to enter a username and password. If you are not using authentication for the Fusion server, you can ignore the prompts.</p>
 </li>
-<li>Email each result file (at <code>/tmp/geecheck-CUSTOMERNAME-SERVER-YYYY-MM-DD.txt</code>) to <a href="http://www.google.com/url?q=http%3A%2F%2Fc.na4.visual.force.com&amp;sa=D&amp;sntz=1&amp;usg=AFQjCNGOe9is8ysSYuFA5cs-0inbVQHH7A" target="_blank">technical support</a>.</li>
+<li>Examine the output for potential errors and problems.</li>


Should we mention using the output to report an issue on Git Hub?

tst-ppenev · 2017-07-05T21:47:44Z

docs/geedocs/answer/2880343.html

@@ -41,6 +41,6 @@
 <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> | Troubleshooting and error messages</h1><h2>GEE downloads to Mac</h2>
-<p>Macs that run OS X Mountain Lion do not yet list the Google Support Portal as an "identified developer," so they place Portal downloads in the trash as a quarantine measure. If you download EC or Earth plug-in from the Support Portal to a Mac running Mountain Lion with security set to "maximum", you'll need to move them into the appropriate directory after download. For more information, see <a href="http://support.apple.com/kb/HT5290" target="_blank">Apple support</a>.</p>
+<p>Macs that run OS X Mountain Lion may not list the OpenGEE team as an "identified developer," so they may place OpenGEE downloads in the trash as a quarantine measure. If you download EC or Earth plug-in from the Support Portal to a Mac running Mountain Lion with security set to "maximum", you may need to move them into the appropriate directory after download. For more information, see <a href="http://support.apple.com/kb/HT5290" target="_blank">Apple support</a>.</p>


Isn't the EC plug-in still registered by Google? Who is it distributed by? Or, is it distributed by anyone?

I don't know if this page is still relevant. I'm going to just delete it and we can add instructions back if someone reports a problem.

tst-ppenev · 2017-07-05T22:17:23Z

docs/geedocs/answer/4492599.html

@@ -37,7 +35,13 @@
 </h5>
 <div>
 <p><strong>Operating Systems</strong></p>
-<p>Google Earth Enterprise is tested and supported only on the 64-bit versions of the operating systems listed below.</p>
+<p>Google Earth Enterprise is supported only on the 64-bit versions of the operating systems listed below.</p>
+<p>Version 5.2.0:</p>


Same comments as above on 'supported' and listed versions.

tst-ppenev · 2017-07-05T22:17:40Z

docs/geedocs/answer/4492599.html

 <p><strong>Software Platforms</strong></p>
-<p>These supported software platforms and versions have been tested and certified by the Google Earth Enterprise team:</p>
+<p>The following software platforms are supported:</p>


tst-ppenev · 2017-07-05T22:19:33Z

docs/geedocs/answer/4492599.html

@@ -90,7 +93,7 @@
 <p><strong>Browsers</strong></p>
 <p>Google Earth Enterprise is supported on the following browsers on all operating systems:</p>
 <ul>
-<li dir="ltr">Google Chrome version 10 and later (32-bit)</li>
+<li dir="ltr">Google Chrome version 10 and later</li>


Do we have document somewhere (perhaps on the Git Hub Wiki) mentioning what OS distributions, and browser versions we are supporting? Otherwise, I'm not sure how accurate this document is going to be.

There is a list of supported OSs in the main README.md on github, but I don't know of a list of supported browsers. For that matter, we aren't doing any browser testing anyway, so we don't know for sure which ones work. You're right that it will be hard to keep this documentation updated, but I think it's OK not to solve that right now.

Can we have a ticket to state what browsers we are going to test with and support, and to update this documentation?

I wrote ticket #310 to set up a testing framework. I also updated the list of supported browsers.

tst-ppenev · 2017-07-05T22:21:22Z

docs/geedocs/answer/4492617.html

+<p><code>/etc/init.d/gefusion stop</code></p>
+</li>
+<li>Navigate to the location at which you initially cloned the GEE git repo.</li>
+<li>Within the GEE git repo, navigate to <code>earthenterprise/earth_enterprise/src/installer</code>


Same comment as above on requiring the repository to uninstall an already installed Fusion.

Same reply.

tst-ppenev · 2017-07-05T22:24:13Z

docs/geedocs/answer/6078762.html

@@ -67,7 +67,7 @@
        <tr>
          <td>17725523</td>
          <td>When attempting to install GEE 5.1.0 on RHEL 6 using the GUI installer, the process is likely to fail.</td>


Should we be documenting how to install GEE 5.1 in the GEE open source documentation?

These are just release notes for old versions. I suppose we could remove them, but I mostly left them as is.

tst-lsavoie · 2017-07-06T18:31:51Z

@tst-ppenev I think I've responded to all of your comments.

tst-ppenev

Yeah, that answers my comments.

I'm wondering what we're using a JRE for. It seems that some of the third-party libraries may be using it.

I haven't tested browsing this documentation from a rebuilt version of GEE and Fusion, but the changes look good to me.

tst-lsavoie · 2017-07-07T16:40:21Z

@tst-ppenev I removed the requirement to install Java and updated the list of supported browsers.

tst-ppenev · 2017-07-07T17:03:42Z

Cool, so we don't need new tickets for these. I've already approved this. If it works in a browser, we should merge.

tst-lsavoie · 2017-07-07T17:30:42Z

I believe I've handled all the comments and there's one approval, so I'm merging this.

bradh

Looks like a definite improvement.

tst-lsavoie force-pushed the doc-cleanup branch from 24bba67 to 3861778 Compare June 28, 2017 15:25

tst-lsavoie force-pushed the doc-cleanup branch from 3861778 to 3f73337 Compare June 28, 2017 15:47

bradh reviewed Jul 1, 2017

View reviewed changes

Additional minor cleanup

5a282dc

Add link to install instructions from main page

f7a0db4

tst-ppenev suggested changes Jul 5, 2017

View reviewed changes

tst-lsavoie added 3 commits July 6, 2017 10:49

Clean up per PR comments

40dd070

Remove help page about installing on OSx Mountain Lion

f5fa19c

Clean up install documentation

0f73147

tst-ppenev approved these changes Jul 6, 2017

View reviewed changes

Remove references to Java and update supported browsers

12646c7

tst-lsavoie merged commit 1071ed2 into google:master Jul 7, 2017

tst-lsavoie mentioned this pull request Jul 7, 2017

Review / remove answer 3499396 (installation process) #209

Closed

bradh reviewed Jul 7, 2017

View reviewed changes

tst-lsavoie deleted the doc-cleanup branch July 21, 2017 16:07

		@@ -62,18 +66,17 @@
		<li>SUSE Linux Enterprise Server 10</li>
		<li>Red Hat Enterprise Linux AS 4</li>

Documentation cleanup #276

Documentation cleanup #276

Conversation

tst-lsavoie commented Jun 26, 2017 • edited Loading

tst-lsavoie commented Jun 27, 2017

tst-lsavoie commented Jun 27, 2017

tst-lsavoie commented Jun 28, 2017

bradh 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

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 commented Jul 3, 2017

bradh commented Jul 4, 2017

tst-ppenev 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

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 commented Jul 6, 2017

tst-ppenev left a comment • edited Loading

Choose a reason for hiding this comment

tst-lsavoie commented Jul 7, 2017

tst-ppenev commented Jul 7, 2017

tst-lsavoie commented Jul 7, 2017

bradh left a comment

Choose a reason for hiding this comment

tst-lsavoie commented Jun 26, 2017 •

edited

Loading

tst-ppenev left a comment •

edited

Loading