Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the 400 "missing license" page more informative #1971

Open
joeytwiddle opened this issue Oct 11, 2022 · 2 comments
Open

Make the 400 "missing license" page more informative #1971

joeytwiddle opened this issue Oct 11, 2022 · 2 comments
Labels
CODE Some other Code related issue and it should clearly describe what it is affecting in a comment. enhancement Something we do have implemented already but needs improvement upon to the best of knowledge. UI Pertains inclusively to the User Interface.

Comments

@joeytwiddle
Copy link
Contributor

joeytwiddle commented Oct 11, 2022

What’s missing?

On this page, add some more information, so the user (developer) knows what to do next.

195138428-0c7c3c5a-95f0-4e08-b3ec-16e988432b5b-2

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:

  1. an example or two, and
  2. a link to more information.

195138283-196ede0b-acf3-43bc-99c3-40710c8f1576-2

Alternative

Allow scripts scripts without a license to be imported, but give them the MIT license by default.

@joeytwiddle joeytwiddle added the enhancement Something we do have implemented already but needs improvement upon to the best of knowledge. label Oct 11, 2022
@Martii
Copy link
Member

Martii commented Oct 12, 2022

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.

@Martii
Copy link
Member

Martii commented Jun 26, 2023

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-license if 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.

@Martii Martii added UI Pertains inclusively to the User Interface. CODE Some other Code related issue and it should clearly describe what it is affecting in a comment. labels Jun 26, 2023
@Martii Martii self-assigned this Sep 9, 2023
Martii added a commit to Martii/OpenUserJS.org that referenced this issue Sep 9, 2023
* Clean up excess on managed route and clarify
* Clarify bookmarks better... this will break some existing user content links.

Applies to OpenUserJS#1971 Post OpenUserJS#970 , OpenUserJS#944 etc.
Martii added a commit that referenced this issue Sep 9, 2023
* Clean up excess on managed route and clarify
* Clarify bookmarks better... this will break some existing user content links.

Applies to #1971 Post #970 , #944 etc.

Auto-merge
@Martii Martii removed their assignment Sep 9, 2023
Martii added a commit that referenced this issue Sep 11, 2023
Move to script to tail end of body

Post #2006 Applies to #1971 Post #970 , #944 etc.
Martii added a commit to Martii/OpenUserJS.org that referenced this issue Sep 11, 2023
Martii added a commit that referenced this issue Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CODE Some other Code related issue and it should clearly describe what it is affecting in a comment. enhancement Something we do have implemented already but needs improvement upon to the best of knowledge. UI Pertains inclusively to the User Interface.
Development

No branches or pull requests

2 participants