Merge pull request #24 from matmair/docs-links

Adding more content

_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"

_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
+  - name: Contribute
-    internal: deploy.md
+    internal: contribute.md
+

_includes/base/footer.html

@@ -29,9 +29,15 @@
     <div class="container mx-auto py-4 px-5 flex flex-wrap flex-col sm:flex-row">
       <p class="cm-gray-3 text-sm text-center sm:text-left">© 2021 {{ site.title }} by<a href="https://github.com/inventree" rel="noopener" class="cm-gray-2 ml-1" target="_blank">@inventree</a>— website made with &hearts; by<a href="https://github.com/matmair" rel="noopener" class="cm-gray-2 ml-1" target="_blank">@matmair</a></p>
       <span class="inline-flex sm:ml-auto sm:mt-0 mt-2 justify-center sm:justify-start">
-        <a href="https://github.com/inventree/inventree-website" alr="github repo" class="ml-3 cm-gray-3">
+        <a href="https://github.com/inventree/inventree" alr="github repo" class="ml-3 cm-gray-3">
           <img class="h-5 w-5" src="{{ '/assets/github.svg' | relative_url }}" />
         </a>
+        <a href="https://reddit.com/r/inventree" alr="Reddit" class="ml-3 cm-gray-3">
+          <img class="h-5 w-5" src="{{ '/assets/reddit.svg' | relative_url }}" />
+        </a>
+        <a href="https://twitter.com/inventreedb" alr="Twitter" class="ml-3 cm-gray-3">
+          <img class="h-5 w-5" src="{{ '/assets/twitter.svg' | relative_url }}" />
+        </a>
       </span>
     </div>
   </div>

_includes/base/header.html

@@ -19,7 +19,7 @@
             <a class="mr-2 hover:cm-gray-1" href="#business">for <strong>business</strong></a>
             <a class="mr-2 hover:cm-gray-1" href="#edu">for <strong>edu</strong></a>
         </nav>
-        <a href="{{site.demo-link}}" class="inline-flex items-center bg-gray-100 ml-2 border-0 py-1 px-3 focus:outline-none hover:bg-gray-200 rounded text-base mt-4 md:mt-0">
+        <a href="/demo.html" class="inline-flex items-center bg-gray-100 ml-2 border-0 py-1 px-3 focus:outline-none hover:bg-gray-200 rounded text-base mt-4 md:mt-0">
         Open demo
       </a> {% endif %}
     </div>

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?
+### Motivations
-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.  
+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.
-There is no inherent monetary intrest but if you would like to [support the org]({% link contribute/index.md %}) - we apprecicate it.
+
+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.

assets/reddit.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 800 800" xmlns="http://www.w3.org/2000/svg" width="2500" height="2500"><circle cx="400" cy="400" fill="#ff4500" r="400"/><path d="M666.8 400c.08 5.48-.6 10.95-2.04 16.24s-3.62 10.36-6.48 15.04c-2.85 4.68-6.35 8.94-10.39 12.65s-8.58 6.83-13.49 9.27c.11 1.46.2 2.93.25 4.4a107.268 107.268 0 0 1 0 8.8c-.05 1.47-.14 2.94-.25 4.4 0 89.6-104.4 162.4-233.2 162.4S168 560.4 168 470.8c-.11-1.46-.2-2.93-.25-4.4a107.268 107.268 0 0 1 0-8.8c.05-1.47.14-2.94.25-4.4a58.438 58.438 0 0 1-31.85-37.28 58.41 58.41 0 0 1 7.8-48.42 58.354 58.354 0 0 1 41.93-25.4 58.4 58.4 0 0 1 46.52 15.5 286.795 286.795 0 0 1 35.89-20.71c12.45-6.02 25.32-11.14 38.51-15.3s26.67-7.35 40.32-9.56 27.45-3.42 41.28-3.63L418 169.6c.33-1.61.98-3.13 1.91-4.49.92-1.35 2.11-2.51 3.48-3.4 1.38-.89 2.92-1.5 4.54-1.8 1.61-.29 3.27-.26 4.87.09l98 19.6c9.89-16.99 30.65-24.27 48.98-17.19s28.81 26.43 24.71 45.65c-4.09 19.22-21.55 32.62-41.17 31.61-19.63-1.01-35.62-16.13-37.72-35.67L440 186l-26 124.8c13.66.29 27.29 1.57 40.77 3.82a284.358 284.358 0 0 1 77.8 24.86A284.412 284.412 0 0 1 568 360a58.345 58.345 0 0 1 29.4-15.21 58.361 58.361 0 0 1 32.95 3.21 58.384 58.384 0 0 1 25.91 20.61A58.384 58.384 0 0 1 666.8 400zm-396.96 55.31c2.02 4.85 4.96 9.26 8.68 12.97 3.71 3.72 8.12 6.66 12.97 8.68A40.049 40.049 0 0 0 306.8 480c16.18 0 30.76-9.75 36.96-24.69 6.19-14.95 2.76-32.15-8.68-43.59s-28.64-14.87-43.59-8.68c-14.94 6.2-24.69 20.78-24.69 36.96 0 5.25 1.03 10.45 3.04 15.31zm229.1 96.02c2.05-2 3.22-4.73 3.26-7.59.04-2.87-1.07-5.63-3.07-7.68s-4.73-3.22-7.59-3.26c-2.87-.04-5.63 1.07-7.94 2.8a131.06 131.06 0 0 1-19.04 11.35 131.53 131.53 0 0 1-20.68 7.99c-7.1 2.07-14.37 3.54-21.72 4.39-7.36.85-14.77 1.07-22.16.67-7.38.33-14.78.03-22.11-.89a129.01 129.01 0 0 1-21.64-4.6c-7.08-2.14-13.95-4.88-20.56-8.18s-12.93-7.16-18.89-11.53c-2.07-1.7-4.7-2.57-7.38-2.44s-5.21 1.26-7.11 3.15c-1.89 1.9-3.02 4.43-3.15 7.11s.74 5.31 2.44 7.38c7.03 5.3 14.5 9.98 22.33 14s16 7.35 24.4 9.97 17.01 4.51 25.74 5.66c8.73 1.14 17.54 1.53 26.33 1.17 8.79.36 17.6-.03 26.33-1.17A153.961 153.961 0 0 0 476.87 564c7.83-4.02 15.3-8.7 22.33-14zm-7.34-68.13c5.42.06 10.8-.99 15.81-3.07 5.01-2.09 9.54-5.17 13.32-9.06s6.72-8.51 8.66-13.58A39.882 39.882 0 0 0 532 441.6c0-16.18-9.75-30.76-24.69-36.96-14.95-6.19-32.15-2.76-43.59 8.68s-14.87 28.64-8.68 43.59c6.2 14.94 20.78 24.69 36.96 24.69z" fill="#fff"/></svg>

assets/twitter.svg

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generator: Adobe Illustrator 24.2.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Logo" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 248 204" style="enable-background:new 0 0 248 204;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#1D9BF0;}
+</style>
+<g id="Logo_1_">
+	<path id="white_background" class="st0" d="M221.95,51.29c0.15,2.17,0.15,4.34,0.15,6.53c0,66.73-50.8,143.69-143.69,143.69v-0.04   C50.97,201.51,24.1,193.65,1,178.83c3.99,0.48,8,0.72,12.02,0.73c22.74,0.02,44.83-7.61,62.72-21.66   c-21.61-0.41-40.56-14.5-47.18-35.07c7.57,1.46,15.37,1.16,22.8-0.87C27.8,117.2,10.85,96.5,10.85,72.46c0-0.22,0-0.43,0-0.64   c7.02,3.91,14.88,6.08,22.92,6.32C11.58,63.31,4.74,33.79,18.14,10.71c25.64,31.55,63.47,50.73,104.08,52.76   c-4.07-17.54,1.49-35.92,14.61-48.25c20.34-19.12,52.33-18.14,71.45,2.19c11.31-2.23,22.15-6.38,32.07-12.26   c-3.77,11.69-11.66,21.62-22.2,27.93c10.01-1.18,19.79-3.86,29-7.95C240.37,35.29,231.83,44.14,221.95,51.29z"/>
+</g>
+</svg>

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*
+
+

contribute/code/architecture.md

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

contribute/code/index.md

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

contribute/index.md

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

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
+
+<div markdown="span" class="alert alert-info" role="alert">
+During the update period, the demo server may be inaccessible for a few minutes.
+</div>    

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](#docker)
-- [Cloud](#cloud)
 
-### 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).

plugins.html

@@ -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 %}