From 1f1583a0de994b06055fe06467066f2715353c39 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Fri, 5 Aug 2022 12:19:20 +1000 Subject: [PATCH] Add / update contribution information --- _config.yml | 4 +++ _data/general/footer.yml | 18 ++--------- _includes/base/header.html | 4 ++- about/index.md | 4 +-- contribute.md | 56 +++++++++++++++++++++++++++++++++ contribute/code/architecture.md | 5 --- contribute/code/index.md | 5 --- contribute/index.md | 25 --------------- deploy.md | 2 +- plugins.html | 3 ++ 10 files changed, 72 insertions(+), 54 deletions(-) create mode 100644 contribute.md delete mode 100644 contribute/code/architecture.md delete mode 100644 contribute/code/index.md delete mode 100644 contribute/index.md diff --git a/_config.yml b/_config.yml index 7574a3d7..81579268 100644 --- a/_config.yml +++ b/_config.yml @@ -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" diff --git a/_data/general/footer.yml b/_data/general/footer.yml index ea248489..677135f4 100644 --- a/_data/general/footer.yml +++ b/_data/general/footer.yml @@ -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: diff --git a/_includes/base/header.html b/_includes/base/header.html index fe92cfff..42ba5bd6 100644 --- a/_includes/base/header.html +++ b/_includes/base/header.html @@ -8,10 +8,12 @@
{% if page.main_page %} diff --git a/about/index.md b/about/index.md index 0b73bd50..3431834e 100644 --- a/about/index.md +++ b/about/index.md @@ -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. diff --git a/contribute.md b/contribute.md new file mode 100644 index 00000000..144a690f --- /dev/null +++ b/contribute.md @@ -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* + + diff --git a/contribute/code/architecture.md b/contribute/code/architecture.md deleted file mode 100644 index bbc48ab2..00000000 --- a/contribute/code/architecture.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: System Architecture ---- - -# TODO diff --git a/contribute/code/index.md b/contribute/code/index.md deleted file mode 100644 index 9d4eb64d..00000000 --- a/contribute/code/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Contribute Code ---- - -# TODO diff --git a/contribute/index.md b/contribute/index.md deleted file mode 100644 index 34203866..00000000 --- a/contribute/index.md +++ /dev/null @@ -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 diff --git a/deploy.md b/deploy.md index a711ef08..5c6c5a82 100644 --- a/deploy.md +++ b/deploy.md @@ -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). \ No newline at end of file +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. \ No newline at end of file diff --git a/plugins.html b/plugins.html index c464531c..dd76b4bb 100644 --- a/plugins.html +++ b/plugins.html @@ -3,6 +3,9 @@ layout: default title: Plugins permalink: /plugins --- + + +

InvenTree Plugin Repository

{% for plugin in site.plugins %}