Github/plugins
1
0
Fork 0
mirror of synced 2024-06-26 06:18:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Create obsoletes.md

Browse Source
This commit is contained in:
Laurent 2021-10-14 14:31:01 +01:00 committed by GitHub
parent 49ee8ab114
commit c5b93d876e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
readme/obsoletes.md Normal file
View File

@ -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.