diff --git a/docs/reference/Admin_Actions.md b/docs/reference/Admin_Actions.md index 34208a81..af656521 100644 --- a/docs/reference/Admin_Actions.md +++ b/docs/reference/Admin_Actions.md @@ -4,6 +4,30 @@ When you consider that most backend services are a black box of code and decisio With that said this document will serve as the ongoing history of administrative actions that must be taken against the backend. +## 2023 - April 15 + +### Uber-Juno + +The [Uber-Juno](https://github.com/JunoLab/uber-juno) package uses an older unsupported coding style, sometimes called JavaScript Sloppy Mode, that's no longer supported in newer versions of NodeJS. Meaning the package crashes as soon as installed, and cannot be used without the user manually editing the source code. + +One of the Pulsar contributors has [submitted a fix](https://github.com/JunoLab/uber-juno/pull/85) for this issue, although it has not been updated on the Pulsar Package Registry. + +Additionally, Uber-Juno relies on Atom-Ink, which is also broken without any fixes, as mentioned below. + +Due to these issues of the package, while the `main` branch is fixed, but it relies on broken dependencies, that render's the package as a whole still broken, and in which case will receive a [`broken`](./badge-spec.md#broken) badge. + +### Atom-Ink + +The [Atom-Ink](https://github.com/JunoLab/atom-ink) package has many coding practices that are no longer valid in JavaScript/NodeJS, such as using reserved words, or using variables without declaring them first, causing the package to crash without manually being edited on Pulsar. + +One of the Pulsar contributors has [submitted a fix](https://github.com/JunoLab/atom-ink/pull/289) for this bug, but after four months of inactivity from the maintainer of the package it seems unlikely this will be resolved. + +The package is MIT licensed, so if any devs out there would like to pick up the reigns, and get this package functional as a fork, please feel free to do so, and you'd be encouraged to contact the Pulsar Admins about this, so we can update the badges on this package appropriately. + +It is for this reason it is **not** recommended to install the `atom-ink` package. It will not work, unless you are comfortable editing the source code of the package manually, or until a community member decides to maintain a fork of said package, which in that event, installing that package would be the recommendation here, rather than not installing. + +With the above said, `atom-ink` will receive a [`broken`](./badge-spec.md#broken) badge. + ## 2023 - March 29 Allowed for a seamless takeover of the `language-pegjs` name. diff --git a/docs/reference/badge-spec.md b/docs/reference/badge-spec.md index 4393b52e..b01cf4af 100644 --- a/docs/reference/badge-spec.md +++ b/docs/reference/badge-spec.md @@ -70,3 +70,11 @@ That is, if a Pulsar users on a supported platform, indepent of any other issues This badge would be added on a case by case basis, and would likely only be added if Pulsar users are reporting the error. As with all other badges this badge may be removed at any time, and if you, as a package maintainer have updated a package and did not see this badge removed automatically, or within a reasonable time, feel free to [create an issue](https://github.com/pulsar-edit/package-backend/issues) asking for it to be removed. + +## Broken + +The `Broken` badge is used to indicate that the package available on the Pulsar Package Registry does not work at all in it's current form, on any supported platform. Either requiring manual changes to the source code, or otherwise being unrealistic to fix from the users perspective. + +This package likely emits warnings immediately, or may even cause the editor to crash as a whole. Installation of these packages is not recommended by the Pulsar team, and instead it is encouraged to work with the original maintainer to get these packages working, or otherwise the community is encouraged to maintain and manage a fork of said package. + +If a community member does decide to maintain a fork of a package with a `Broken` status, it's recommended to make the Pulsar Admins or Pulsar Backend Admins aware of this, so any warnings and links on the original package can be changed to recommend installation of your functional fork.