From c5b93d876e37b6b0fd9eff0a121d7213d5ac8254 Mon Sep 17 00:00:00 2001 From: Laurent Date: Thu, 14 Oct 2021 14:31:01 +0100 Subject: [PATCH] Create obsoletes.md --- readme/obsoletes.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 readme/obsoletes.md diff --git a/readme/obsoletes.md b/readme/obsoletes.md new file mode 100644 index 0000000..9ed2f8f --- /dev/null +++ b/readme/obsoletes.md @@ -0,0 +1,23 @@ +# 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. +- Copy it to `/manifestOverrides.json`. +- Add a new key `"_obsolete": true` to the JSON block. +- 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.