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

⚕️ broken link to OpenINF MIT license showing non-org :octocat: 404 page #5

Open
1 task
DerekNonGeneric opened this issue Aug 3, 2022 · 1 comment
Open
1 task

Comments

@DerekNonGeneric
Copy link
Member

DerekNonGeneric commented Aug 3, 2022

🐛 Bug report

Location

Section of the site where the content exists

Affected URL(s):

Note: we are still missing org custom templates for our error pages, which is a separate 🐛 that still needs to get handled…

Description

Concise explanation of the problem

/**
 * @license
 * Copyright OpenINF All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://open.inf.is/license
 */

Earlier versions of source code in packages we shipped last year included a license blurb as a standalone JSDoc comment that consists of the @license tag, along with a link to the entire text of the license so that the license text does not need to be included in generated JavaScript files, which would cause unnecessary bloat.

This was done before determining that it would be best for the authors (i.e., contributors) to the OpenINF software be the copyright holders rather than any non-person entity (such as an org). We have since updated this as “Copyright (c) The OpenINF Authors. All Rights Reserved.” to reflect this re-distribution of rights to the contributors themselves.

This has two inescapable implications that we now need to act on:

  1. Each package repository should contain an AUTHORS file adjacent to the package.json file that gets deployed as part of the published package on the npm registry. The reason for this is for the purpose of both contributor attribution and their benefit as being another copyright holder of not only their code contribution or even solely to a particular project within the organization, but to all current and future software produced by this organization is licensed in this manner. This will also end up being picked up by the npm CLI tool, which will auto-populate the "contributors" stanza of the package.json that is shipped with an array of people information about those who have contributed. This is very convenient because we don't have to continuously keep making diffs to the package.json file adding more folks to the manifest as they contribute.

    • "contributors": [...]
       

    If there is an AUTHORS file in the root of your package, npm will treat each line as a Name <email> (url) format, where email and url are optional. Lines that start with a # or are blank, will be ignored.

     
    https://docs.npmjs.com/cli/v8/configuring-npm/package-json#default-values

  2. The OpenINF MIT license contained in this repository must (and very quickly can) be published to that URL that we had been linking to in the past (and perhaps presently + future too) as we can no longer change any of the links in the source code of our older published packages. As of right now, that link is broken and is currently a 404 error page (and a GitHub-pages branded one at that).
     
    image


  • I would like to work on this issue and submit a pull request.
@DerekNonGeneric
Copy link
Member Author

brief update to this issue, which i seem to have moved forward since then:

DerekNonGeneric referenced this issue in DerekNonGeneric/openinf-jekyll-asset-path-plugin Feb 26, 2024
DerekNonGeneric referenced this issue in DerekNonGeneric/openinf-jekyll-asset-path-plugin Feb 26, 2024
@OpenINFbot OpenINFbot transferred this issue from OpenINF/openinf.github.io Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant