inventree/inventree-website
2
0
Fork 0
mirror of https://github.com/inventree/inventree-website.git synced 2025-04-27 21:16:45 +00:00
Code

Add a 'add a plugin' section to the readme

Browse Source
This commit is contained in:
Matthias Mair 2023-01-24 23:55:19 +01:00
parent 0322671d05
commit 64ad6eca4a
No known key found for this signature in database
GPG Key ID: A593429DDA23B66A
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -4,6 +4,27 @@ It is built on Jekyll and GitHub pages for backend / hosting, tailtwindcss for d
[![Netlify Status](https://api.netlify.com/api/v1/badges/f84340d0-bc2f-4f7f-ad4c-877c50b33a27/deploy-status)](https://app.netlify.com/sites/inventree-org-preview/deploys)
## Adding a plugin to the repository
Any maintainer of a plugin can add their plugin to the repository. The plugin will be listed on the website, we might provide a mechanism to discover plugins from within InvenTree in the future.
To add a plugin the following steps are required:
- Fork the repository
- Create a new branch. We recommend `plugin/<plugin-name>` as the branch name.
- Create a new file in `_repo`. We recommend using the package name as the file name.
- Copy the content from `_repo/template.md` into the new file.
- Fill out the details. Please make sure to use the correct format for the fields.
- If this is your first contribution to the repository, please add yourself to the `_publishers` folder.
- Use your GitHub username as the file name.
- Copy the content from `_publishers/_template.md` into the new file.
- Fill out the details. Please make sure to use the correct format for the fields.
- Commit your changes and create a pull request. We recommend using the title `[REPO] Add plugin <plugin-name>`.
Please note that the plugin repository is moderated as we see fit and we reserve the right to reject plugins that do not meet basic quality standards. We will try to provide feedback in the pull request if that is the case.
As a maintainer of a plugin we count on you to keep the information up to date. If you want to update the information, please create a pull request.
The plugin repository is just getting started as a static collection, we might enhance the features in the future. If we need more information or make significant changes to the repository, we will ping the maintainers via their GitHub handle - so please keep your main GitHub handle up to date in your publisher file.
## Architecture
The website consists of content, layouts and assets. Jekyll runs and builds out of these files static html files - that are then hosted on GitHub pages. Folders with an underscore prefixed are internal folders for Jekyll, folders without are rendered as subdirectories in the output.
@ -13,8 +34,8 @@ Content:
`_drafts` contains drafts for blog pages and news items
`_news` contains news entries
`_posts` contains blog entries
`_publishers` contains authors/publishers
`_repo` will contain plugin repo entries
`_publishers` contains authors/publishers of blog entries, news items and plugins
`_repo` contains plugin repo entries
Layouts:
`_includes` contains partials that can be used in layouts