google / earthenterprise

Google Earth Enterprise - Open Source
Apache License 2.0
2.67k stars 890 forks source link

Should we move the contents of earth_enterprise to the root of the repo? #162

Open tst-ccamp opened 7 years ago

tst-ccamp commented 7 years ago

There really isn't a benefit to having all the contents of the repo under earth_enterprise rather than the root of the repo. This proposal is to move everything from that directory to the root. Git should be able to move all the files without losing history of the file. Be sure to use git mv. Also update any paths in files such as .gitignore and SConscript/SConstruct files that might reference earth_enterprise. To be sure do a grep through the entire repo for instances of earth_enterprise.

The documentation on the wiki will also need to be updated.

tst-ppenev commented 7 years ago

It does look slightly cleaner to have only introductory documents for the user in the top-level directory. (index.md seems to have boiler plate content, should it be removed, or replaced?) Although, many projects have all the files at the top level.

Having earth_enterprise inside earthenterprise does not seem very informative to me. Perhaps the inner earth_enterprise can be renamed to something like implementation, code, or src.

tst-ccamp commented 7 years ago

There aren't any subdirectories at the top level besides earth_enterprise and there is only one additional file inside earth_enterprise itself, so I don't think the move would cause any confusion. I do believe however it will solve some confusion that already exists. I'm not a big fan of renaming the earth_enterprise directory as an alternative though. That's basically the same amount of work but I think we'd get less benefit out of it.

tst-ppenev commented 7 years ago

I'm fine with merging earth_enterprise with its parent.

andreisel commented 7 years ago

Also, will need to update paths in SConscripts: delete '/../earth_enterpise' in paths like this: apache_source = File('#/../../earth_enterprise/third_party/apache2/%s.ta' 'r.gz' % apache_version.replace('apache', 'httpd')).abspath

tst-ccamp commented 7 years ago

@andreisel I made some updates to the description to reflect your comment