diff --git a/_config.yml b/_config.yml index a6f3831f..897b81c1 100644 --- a/_config.yml +++ b/_config.yml @@ -6,7 +6,8 @@ description: >- It is at the center of an ecosystem of addins for EDA tools, API wrapper, deeply integrated plugins and 3rd party tools. # Links -demo-link: https://inventree.readthedocs.io/en/latest/demo/ +demo-link: + internal: demo.md doc-link: https://inventree.readthedocs.io/en/latest/ deploy-link: internal: deploy.md @@ -14,6 +15,8 @@ blog-link: internal: blog.html plugin-link: internal: plugins.html +contribute-link: + internal: contribute.md # Hosting parameters baseurl: "/inventree-website" diff --git a/_data/general/footer.yml b/_data/general/footer.yml index ea248489..cde074af 100644 --- a/_data/general/footer.yml +++ b/_data/general/footer.yml @@ -1,38 +1,26 @@ - title: Quick cats: + - name: Demo + internal: demo.md + - name: Deploy + internal: deploy.md - name: Docs site: doc-link - - name: Demo - site: demo-link - 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 - - title: Ecosystem link: internal: extend/index.md cats: - name: API internal: extend/api.md + - name: Integrate + internal: extend/integrate/index.md - name: Plugins internal: extend/plugin/index.md - name: KiCad internal: extend/integrate/kntree.md - - name: Integrate - internal: extend/integrate/index.md - title: Sitemap cats: @@ -42,5 +30,6 @@ internal: alternatives/index.md - name: Blog internal: blog.html - - name: Deploy - internal: deploy.md + - name: Contribute + internal: contribute.md + diff --git a/_includes/base/footer.html b/_includes/base/footer.html index 746d4e37..d6229fbd 100644 --- a/_includes/base/footer.html +++ b/_includes/base/footer.html @@ -29,9 +29,15 @@

© 2021 {{ site.title }} by@inventree— website made with ♥ by@matmair

- + + + + + + +
diff --git a/_includes/base/header.html b/_includes/base/header.html index 07e9519f..ab4d9205 100644 --- a/_includes/base/header.html +++ b/_includes/base/header.html @@ -19,7 +19,7 @@ for business for edu - + Open demo {% endif %} diff --git a/about/index.md b/about/index.md index 0b73bd50..b2fcb028 100644 --- a/about/index.md +++ b/about/index.md @@ -18,10 +18,13 @@ 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. +### Motivations + +InvenTree is built and maintained by users who are passionate about the project. The core team members use InvenTree in their companies, laboratories and organisations to make their life easier. + +The InvenTree project is driven by the support of its developers and users. We all want to see the project grow and be embraced by others, who may in turn be inspired to contribute themselves. + +There is no inherent monetary interest but if you would like to [support the project]({% link contribute.md %}) - we apprecicate it. diff --git a/assets/reddit.svg b/assets/reddit.svg new file mode 100644 index 00000000..222028aa --- /dev/null +++ b/assets/reddit.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/twitter.svg b/assets/twitter.svg new file mode 100644 index 00000000..331023bc --- /dev/null +++ b/assets/twitter.svg @@ -0,0 +1,10 @@ + + + diff --git a/contribute.md b/contribute.md new file mode 100644 index 00000000..30e6b20d --- /dev/null +++ b/contribute.md @@ -0,0 +1,57 @@ +--- +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 is 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 the 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/demo.md b/demo.md new file mode 100644 index 00000000..e9967d0e --- /dev/null +++ b/demo.md @@ -0,0 +1,27 @@ +--- +title: InvenTree Demo +--- + +Want to take InvenTree for a spin? A working demo of InvenTree is available online at **[https://demo.inventree.org](https://demo.inventree.org)** + +### Login Details + +Multiple default accounts are provided, as detailed below. Each account is afforded a different set of permissions, so users can see the InvenTree roles/permission system in action + +| Username | Password | Description | Login | +| --- | --- | --- | --- | +| allaccess | nolimits | View / create / edit all pages and items | [log in](https://demo.inventree.org/accounts/login/?login=allaccess&password=nolimits) | +| reader | readonly | Can view all pages but cannot create, edit or delete database records | [log in](https://demo.inventree.org/accounts/login/?login=reader&password=readonly) | +| engineer | partsonly | Can manage parts, view stock, but no access to purchase orders or sales orders | [log in](https://demo.inventree.org/accounts/login/?login=engineer&password=partsonly) | +| admin | inventree | Superuser account, access all areas plus administrator actions | [log in](https://demo.inventree.org/accounts/login/?login=admin&password=inventree) | + +### Data Persistence + +The InvenTree demo database resets to a known state once per day. + +- Database records are reset to the latest state of the [demo dataset](https://github.com/inventree/demo-dataset) +- InvenTree software is kept up to date with the latest `inventree:master` available via docker + + \ No newline at end of file diff --git a/deploy.md b/deploy.md index f581cd40..73a50866 100644 --- a/deploy.md +++ b/deploy.md @@ -2,27 +2,24 @@ title: Deploying InvenTree --- -### Popular Deployment Methods for InvenTree +### Deployment Methods for InvenTree -There are multiple methods to deploy InvenTree. The most popular (and by the development team supported) methods are: +There are multiple methods to deploy InvenTree. The most popular methods (supported by the development team) are: -- [Bare Metal](#bare-metal) -- [Docker](#docker) -- [Cloud](#cloud) +#### Docker -### Deploying to Bare Metal +InvenTree supports a simple containerized installation via docker. An official [docker image](https://hub.docker.com/r/inventree/inventree/) is provided with regular updates. + +Refer to the [docker installation guide](https://inventree.readthedocs.io/en/latest/start/docker/) for more information + +#### Bare Metal + +A [bare metal installation guide](https://inventree.readthedocs.io/en/latest/start/intro/) is provided for users who are looking for a low-level or custom installation. + +#### Cloud # TODO -### Deploying to Docker - -# TODO - -### Deploying to the Cloud - -# TODO - - ### 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). 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 %}