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

Add / update contribution information

This commit is contained in:
Oliver Walters 2022-08-05 12:19:20 +10:00
parent c823a4bebc
commit 1f1583a0de
10 changed files with 72 additions and 54 deletions

View File

@ -15,6 +15,10 @@ blog-link:
internal: blog.html
plugin-link:
internal: plugins.html
support-link:
internal: support.md
contribute-link:
internal: contribute.md
# Hosting parameters
baseurl: "/inventree-website"

View File

@ -3,23 +3,11 @@
- name: Docs
site: doc-link
- name: Demo
site: demo-link
internal: demo.md
- name: News
internal: news.html
- title: Contribute
link:
internal: contribute/index.md
cats:
- name: Translate
internal: contribute/index.md
- name: Code
internal: contribute/code/index.md
- name: Community
link: https://github.com/inventree/InvenTree/issues/new/choose
internal: contribute/index.md
- name: Sponsor
internal: contribute/index.md
- name: Contribute
internal: contribute.md
- title: Ecosystem
link:

View File

@ -8,10 +8,12 @@
<div class="flex-grow xs:flex-none"></div>
<nav class="md:mr-auto md:py-1 xs:ml-4 xs:pl-4 xs:border-l xs:border-gray-400 flex flex-wrap items-center text-base justify-center">
<a class="mr-5 hover:cm-gray-1" href="{% include fnc/link.html item=site.blog-link %}">Blog</a>
<a class="mr-5 hover:cm-gray-1" href="{% include fnc/link.html item=site.demo-link %}">Demo</a>
<a class="mr-5 hover:cm-gray-1" href="{% include fnc/link.html item=site.deploy-link %}">Deploy</a>
<a class="mr-5 hover:cm-gray-1" href="{% include fnc/link.html item=site.doc-link %}">Docs</a>
<a class="mr-5 hover:cm-gray-1" href="{% include fnc/link.html item=site.blog-link %}">Blog</a>
<a class="mr-5 hover:cm-gray-1" href="{% include fnc/link.html item=site.contribute-link %}">Contribute</a>
<a class="mr-5 hover:cm-gray-1" href="{% include fnc/link.html item=site.plugins-link %}">Plugins</a>
</nav>
{% if page.main_page %}

View File

@ -18,10 +18,10 @@ The **main goal** is to keep existing instances **stable** and provide a transpa
We are also actively working on:
- **raising the profile** of InvenTree to get a wider developer base
- supporting **translation** into every wanted language - [learn more]({% link contribute/index.md %})
- supporting **translation** into every wanted language - [learn more]({% link contribute.md %})
- creating [integrations]({% link extend/plugin/index.md %}) into other business and EE-systems via the **plugin system**
### But why?
InvenTree is beeing build and maintained by **users of the systems**. The core-team uses InvenTree in their **companies**, **labs** and organisations to make their life easier.
This and a general intrest in 'computers' motivates and keeps the project running.
There is no inherent monetary intrest but if you would like to [support the org]({% link contribute/index.md %}) - we apprecicate it.
There is no inherent monetary intrest but if you would like to [support the project]({% link contribute.md %}) - we apprecicate it.

56
contribute.md Normal file
View File

@ -0,0 +1,56 @@
---
title: Contribute
---
InvenTree is an open source project which is supported by a small group of volunteer contributors. Developing and maintaining an open source project is a lot of work, and requires a lot of devloper time, a resouce which is quite scarce.
We welcome everyone to help with InvenTree however they can!
- [Sponsor](#sponsor)
- [Report Bugs](#report-bugs)
- [Code](#code)
- [Translate](#translate)
- [Documentation](#documentation)
- [Community](#community)
### Sponsor
If you or company use InvenTree, please consider sponsoring the project to show your support. Sponsorships help to keep this project sustainable, and buys time for the core developers to commit to the project. A recurring or one off sponsorship is a great way to help InvenTree development to continue at full steam!
- [Sponsor us on GitHub](https://github.com/sponsors/inventree)
- [Sponsor us on Patreon](https://www.patreon.com/inventree)
- [Sponsor us on Ko-fi](https://ko-fi.com/inventree)
Financial donations directly support the ongoing development of the InvenTree project. If you benefit from the InvenTree project, please consider contributing to maintain vibrant development of this software!
### Report Bugs
If you find a bug or a feature that does not work correctly, please report it on [GitHub](https://github.com/inventree/inventree/issues). Reporting bugs is critical to improving the software. If you are able and willing, providing a fix for any outstanding issues would be greatly appreciated.
### Code
InvenTree is built using [Python3](https://www.python.org/) and [Django](https://www.djangoproject.com/). Source code is available on [GitHub](https://github.com/inventree/inventree).
Contributions towards the core InvenTree code base are welcomed and encouraged; either extending current functionality, prodiving new features, or addressing outstanding issues.
### Translate
InvenTree provides a translation layer for both the web interface and mobile app. Native language translation requires effort from translators to provide multi-lingual support. If you wish to translate InvenTree to a new language (or improve an existing translation), such contributions would be greatly appreciated!.
Native language translation of the InvenTree web application is [community contributed via crowdin](https://crowdin.com/project/inventree).
_**Contributions are welcomed and encouraged!**._
To contribute to the translation effort, navigate to the [InvenTree crowdin project](https://crowdin.com/project/inventree), create a free account, and start making translations suggestions for your language of choice!
### Documentation
Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree-docs).
If you see any sections of the documentation that require work (i.e. denoted with "TODO") - please consider providing assistance in these sections!
## Community
*TODO*

View File

@ -1,5 +0,0 @@
---
title: System Architecture
---
# TODO

View File

@ -1,5 +0,0 @@
---
title: Contribute Code
---
# TODO

View File

@ -1,25 +0,0 @@
---
title: Contribute
---
We welcome everyone to help with InvenTree however they can!
While there are a few suggestion how you could do your part we are very much open for new ideas.
Common ways to help:
- [Translate](#translate)
- [Community](#community)
- [Code](code)
- [Sponsor](#sponsor)
## Translate
TODO
## Community
TODO
## Sponsor
TODO

View File

@ -22,4 +22,4 @@ A [bare metal installation guide](https://inventree.readthedocs.io/en/latest/sta
### Other Options
The core InvenTree server is built using the widely used python-based framework [Django](https://djangoproject.com/). Therefore there are deployment methods for nearly all plattforms and architectures. If you want to read more about InvenTree's structure and a typical installation read the [architecture overview](../contribute/code/architecture).
The core InvenTree server is built using the widely used python-based framework [Django](https://djangoproject.com/). Therefore there are deployment methods for nearly all plattforms and architectures.

View File

@ -3,6 +3,9 @@ layout: default
title: Plugins
permalink: /plugins
---
<div class="pt-3 pb-1 section-container">
<h1 class="header-text title-font mb-4 cm-gray-1">InvenTree Plugin Repository</h1>
{% for plugin in site.plugins %}