search

phetsims / sherpa

Third-party libraries and dependencies for PhET Simulations
http://scenerystack.org/
Other
8 stars 8 forks source link

The License URLs are problematic #49

Closed samreid closed 9 years ago

samreid commented 9 years ago

I have been including the license URLs in the MD output, but there are some problems:

  1. In many cases, the simulation doesn't have a custom or hosted license, just a pointer to a generic license. In these cases, I am pointing to the page that states the license, not the URL of the license itself. Hence it is not really a LicenseURL but rather a URLthatStatesTheLicense, which is kind of confusing.
  2. Many of the license URLs are "live versions" (e.g., master of a repo) which could change at any time. We have snapshots of the correct license in our sherpa repo, we should probably link to those instead.

Therefore I think we should link to our snapshots of the correct licenses. I recommend to leave the "LicenseURL" as an internal metadata to help us when trying to track down licenses for future versions, but suppressing them from the MD file. I also recommend to hyperlink the license name to the license text, to make it a bit cleaner.

samreid commented 9 years ago

Fixed above and the generated file looks much better. Nice work @samreid! Closing.

samreid commented 9 years ago

Likewise, I think we should omit these licenseURLs from the compiled HTML, should be done before https://github.com/phetsims/sherpa/issues/33

samreid commented 9 years ago

Since this licenseURL output is in the HTML, I'd like to get it done before redeploys, I'll tag it as such.

samreid commented 9 years ago

I recommend to leave the "LicenseURL" as an internal metadata to help us when trying to track down licenses for future versions, but suppressing them from the MD file.

Actually, given the project url, the licenses are all very easy to track down for our current set of projects. Since leaving in the licenseURL in the metadata would complicate stripping them out for the builds, I'm now recommending just to remove them altogether.

samreid commented 9 years ago

Fixed above and manually verified that the output looks good, closing.