Skip to content

obsoletes.md

Latest commit

 

History

History
28 lines (19 loc) · 1.47 KB

obsoletes.md

File metadata and controls

28 lines (19 loc) · 1.47 KB

About obsolete plugins

Marking a plugin as obsolete means it will no longer show up in search results.

It is used for example to exclude:

  • Plugins that no longer works;
  • Test plugins that do not need to appear in search results;
  • Plugins that are no longer maintained and may have too many bugs or security issues;
  • Plugins that have been superseded by a different, better plugin.

How to mark a plugin as obsolete

To mark a plugin as obsolete, please follow these steps:

  • Find the plugin in /manifests.json in this repository.
  • Cut the entire JSON block for this plugin (Make sure you actually delete that block, not just copy it)
  • Copy it to /manifestOverrides.json.
  • Add a new key "_obsolete": true to the JSON block.
  • Add a new key "_obsolete_reason": "" and provide a reason why the plugin is now obsolete. This is optional.
  • It's easy to forget a comma or a quote when manually editing JSON, and that would make the whole file invalid. So copy and paste manifests.json and manifestOverrides.json to https://jsonlint.com/ to ensure they are both valid.
  • Create a pull request with the two modified files.

Once the pull request is merged, the plugin will be immediately removed from the application search results. In the future, users who have the plugin installed will also see a message to tell them that it's obsolete.

Example

Here's an example of a correct commit: https://github.com/joplin/plugins/commit/a6ffbe3a421573f4be883e73e3daca496bee97fc