Make the 400 "missing license" page more informative
joeytwiddle opened this issue · 2 comments
What’s missing?
On this page, add some more information, so the user (developer) knows what to do next.
Why?
The user may not know what they should do next.
It's not clear what they should put in the @license field, or where they should go to find a list of valid licenses.
(Note: They can actually find a discussion of licenses on the "Terms of Service" page, but this was not intuitive for me. My first thought was to click the "Development" link.)
(Even when following the link Open Source Initiative (OSI) approved it doesn't really show what text needs to be pasted into the script. A couple of examples, using strings like BSD-3-Clause and GPL might help.)
Suggestion
Make the page look like this, with:
- an example or two, and
- a link to more information.
Alternative
Allow scripts scripts without a license to be imported, but give them the MIT license by default.
Make the 400 "missing license" page more informative
Status codes and status messages are limited on return values including lengths and content type. The "pretty" status page (Graceful failures) is a reflection of those limits. You may see those limits real time at your personal syncs page (You might recall this enhancement suggestion :) i.e. there aren't full pages in the "Messages" column.
The user may not know what they should do next.
https://openuserjs.org/user/add/scripts#user-block-license is available before a script is published... not to mention all the wiki's out there including GM's. e.g. https://sourceforge.net/p/greasemonkey/wiki/Metadata_Block/#license which is also linked at https://openuserjs.org/user/add/scripts#script-metadata
Allow scripts scripts without a license to be imported, but give them the MIT license by default.
Uh sorry but no. One should pick their OSI license from the drop up list at https://openuserjs.org/user/add/scripts/new which also links to https://openuserjs.org/user/add/scripts#user-block-license and this is part of the enforcement.
an example or two, and
While that looks pretty it's already implemented in pre-publish areas. See also first response here about Status codes and messages.
a link to more information.
Still considering migrating GM Port's documentation to the corresponding "user" account (Reserved) e.g. https://openuserjs.org/users/license and possibly doing a post hyperlink client-side JavaScript linkage to it... but that's a ton of work and definitely an upper Admin+ task which means nobody else can contribute directly (like images for our wiki but that is mitigated with GH adding files to an issue) ... hence the contemplation still.
Had an idea, or two, between now and then...
Don't use the accounts since they'll never be translated at any point in current site layout structure.
Do...
- use a client side DOM script to expand the accordion with a synthetic click for
https://openuserjs.org/user/add/scripts#user-block-license/https://openuserjs.org/user/add/lib#user-block-licenseif detects a supported@key. Been meaning to do this for Author Tools help links as well. So two birds with... as the saying goes. - Strip any HTML/MD that may have been added for the return value. NOTE There is still a limitation length on return values for GH... so no additional info should be added.