Merge pull request #11 from matmair/content

todo section

_config.yml

@@ -7,7 +7,7 @@ plugin-link: https://repo.invenhost.com/
 
 description: >-
   InvenTree is an open-source inventory management system which provides intuitive parts management and stock control.
-  It is at the center of an ecosystem of addins for EDA and CAD tools, API wrapper, deeply integrated plugins and 3rd party tools.
+  It is at the center of an ecosystem of addins for EDA tools, API wrapper, deeply integrated plugins and 3rd party tools.
 
 baseurl: "/home.invenhost.com"
 url: ""

_data/for_business.yml

@@ -1,6 +1,6 @@
 ref: business
 link:
-  internal: business
+  internal: use/business
 title: For Business
 text: |
   lorem ipsum text

_data/for_edu.yml

@@ -1,6 +1,6 @@
 ref: edu
 link:
-  internal: education
+  internal: use/education
 title: For Education
 text: |
   Electronic Labs are creative places. Whether your institution works with K12 or post-grads - organisation and tooling is challenging. Let InvenTree help you calm the storm!

_data/for_maker.yml

@@ -1,6 +1,6 @@
 ref: maker
 link:
-  internal: maker
+  internal: use/maker
 title: For Maker
 text: |
   lorem ipsum text

_includes/fnc/link.html

@@ -1,11 +1,18 @@
+{% capture link %}
+{% if include.internal %}
+    {% link include.internal %}
+{% endif %}
 {% if include.item.site %}
     {{ site[include.item.site] }}
 {% elsif include.item.internal %}
     {{ include.item.internal | relativurl }}
 {% elsif include.item.link %}
-    {{ include.item.link }}
+    {{ include.item.link | include fnc/link.html }}
 {% elsif include.item.home %}
-    {{ '/' | relative_url }}
-{% else %}
+    {{  '/' | relative_url }}
+{% elsif include.item %}
     {{ include.item }}
-{% endif %}
+{% endif %}
+{% endcapture %}
+
+{{ link | strip }}

_includes/partial/alert.html

@@ -0,0 +1,11 @@
+<div class="bg-teal-100 border-t-4 border-teal-500 rounded-b text-teal-900 px-4 py-3 shadow-md" role="alert">
+    <div class="flex">
+        {% if include.style == 'info' %}
+            <svg class="fill-current h-6 w-6 text-teal-500 mr-4" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20"><path d="M2.93 17.07A10 10 0 1 1 17.07 2.93 10 10 0 0 1 2.93 17.07zm12.73-1.41A8 8 0 1 0 4.34 4.34a8 8 0 0 0 11.32 11.32zM9 11V9h2v6H9v-4zm0-6h2v2H9V5z"/></svg>
+        {% endif %}
+        <div>
+            <p class="font-bold">{{ include.title }}</p>
+            <p class="text-sm">{{ include.desc }}</p>
+        </div>
+    </div>
+</div>

_layouts/alternatives.html

@@ -0,0 +1,20 @@
+---
+layout: content
+---
+<article class="prose prose-sm sm:prose lg:prose-lg xl:prose-xl mx-auto min-h-screen">
+    {% include partial/alert.html
+        style='info'
+        title='caveat'
+        desc='Please keep in mind that this is the view of one or more devs of InvenTree. So there is an elemenet of bias involved.'
+    %}
+    {{ content }}
+
+    {% if page.oss %}
+    {% include partial/alert.html
+        style='info'
+        title='(F)OSS'
+        desc="This alternative is (F)OSS - let's celebrate this by heading over, giving it a good look and staring the project! Motiviation keeps projects and maintainers healthy."
+    %}
+    {% endif %}
+    View other <a href="{% link alternatives/index.md %}">Alternatives</a>.
+</article>

_layouts/content.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+
+
+<article class="prose prose-sm sm:prose lg:prose-lg xl:prose-xl mx-auto min-h-screen">
+    <h2>{{ page.title }}</h2>
+    {{ content }}
+</article>

_layouts/plugin_highlight.html

@@ -0,0 +1,12 @@
+---
+layout: content
+---
+<article class="prose prose-sm sm:prose lg:prose-lg xl:prose-xl mx-auto min-h-screen">
+    <h2>{{ page.title }}</h2>
+    {{ content }}
+    {% if page.plugin %}
+    <hr>
+    <p>Find out more about this plugin on the plugin site</p>
+    {% include plugin_card.html plugin=page.plugin %}
+    {% endif %}
+</article>

about/credits.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Credits
+---
+
+# TODO

about/imprint.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Imprint
+---
+
+# TODO

about/index.md

@@ -0,0 +1,28 @@
+---
+layout: content
+title: About
+---
+InvenTree is an open-source inventory management system which provides intuitive parts management and stock control.
+It is at the center of an ecosystem of addins for EDA tools, API wrapper, deeply integrated plugins and 3rd party tools.
+
+### Open Source
+We are open source all the way. Webserver, Docs, App and Website are MIT licensed. Please check the [source directory](source) if you want to look at the source code.
+
+### Open governance
+The roadmap for InvenTree is created by the [contributors](team). There is no solid roadmap but the team has general areas of intrest and [milestones](https://github.com/inventree/InvenTree/milestones) to provide an outlook to what is to come. As this project is done in spare/free time there is no set release timeline.
+
+Big ticket iteams that have the intrest of the maintainer or a dedicated dev get the label `roadmap` - those projects are likely to be worked on in the assigned milestones. [Take a peak](https://github.com/inventree/InvenTree/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap)
+
+### Goals
+
+The **main goal** is to keep existing instances **stable** and provide a transparent way to migrate to newer versions - no matter how old the install. This does not absolve the deployers from reading the changelogs!
+
+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/translate.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/sponsor.md %}) - we apprecicate it.

about/privacy.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Privacy
+---
+
+# TODO

about/social.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Credits
+---
+
+# TODO

about/source.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: How to get the source
+---
+
+# TODO

about/team.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: The core team
+---
+
+# TODO

about/thanks.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Offical Social Media channels
+---
+
+# TODO

alternatives/bomist.md

@@ -0,0 +1,8 @@
+---
+layout: alternatives
+title: Partkeepr
+oss: true
+link: # TODO
+---
+
+# TODO

alternatives/excel.md

@@ -0,0 +1,8 @@
+---
+layout: alternatives
+title: Partkeepr
+oss: true
+link: # TODO
+---
+
+# TODO

alternatives/index.md

@@ -0,0 +1,20 @@
+---
+layout: content
+title: Alternatives
+---
+
+InvenTree is by far not the only software for managing 'things'<tm>, there are even a few in the (F)OSS space that adress all your possible needs. We have compiled a list with (more or less) competitors and why they might be a better fit.  
+We are biased of course.
+
+PLMs:
+- [Partkeepr](partkeepr)
+- [Partsbox](partsbox) - for profit
+- [Bomist](bomist) - for profit
+- [Teamcenter](teamcenter) - for profit
+
+Asset Managemnt:
+- [SnipeIt](snipeit)
+- [Odoo](odoo)
+
+Other:
+- [Excel](excel) - for profit

alternatives/odoo.md

@@ -0,0 +1,8 @@
+---
+layout: alternatives
+title: Odoo
+oss: true
+link: # TODO
+---
+
+# TODO

alternatives/partkeepr.md

@@ -0,0 +1,8 @@
+---
+layout: alternatives
+title: Partkeepr
+oss: true
+link: # TODO
+---
+
+# TODO

alternatives/partsbox.md

@@ -0,0 +1,8 @@
+---
+layout: alternatives
+title: Bomist
+oss: false
+link: # TODO
+---
+
+# TODO

alternatives/snipeit.md

@@ -0,0 +1,8 @@
+---
+layout: alternatives
+title: SnipeIT
+oss: true
+link: # TODO
+---
+
+# TODO

alternatives/teamcenter.md

@@ -0,0 +1,8 @@
+---
+layout: alternatives
+title: Teamcenter
+oss: false
+link: # TODO
+---
+
+# TODO

contribute/code/architecture.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: System Architecture
+---
+
+# TODO

contribute/code/index.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Contribute Code
+---
+
+# TODO

contribute/community.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Help in the community
+---
+
+# TODO

contribute/index.md

@@ -0,0 +1,16 @@
+---
+layout: content
+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.
+
+Ways to help:
+- [Help with translations](translate)
+- [Answer quesions](community)
+- [Suggest features](community)
+- [Submit PRs / help with testing](code)
+- [Fund maintenance or new features](sponsor)
+
+# TODO

contribute/sponsor.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Sponsoring
+---
+
+# TODO

contribute/translate.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Translations
+---
+
+# TODO

deploy/bare-metal.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Deploying to Bare Metal
+---
+
+# TODO

deploy/cloud.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Deploying to Cloud
+---
+
+# TODO

deploy/docker.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Deploying to Docker
+---
+
+# TODO

deploy/index.md

@@ -0,0 +1,16 @@
+---
+layout: content
+title: Deploying InvenTree
+---
+
+###  Popular Deployment Methods for InvenTree
+
+There are multiple methods to deploy InvenTree. The most popular (and by the development team  supported) methods are:
+
+- [Bare Metal](bare-metal)
+- [Docker](docker)
+- [Cloud](cloud)
+
+### Other Options
+
+The core InvenTree server is built using the widely used python-based framework [Django](https://django.org/). 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).

extend/api.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: API
+---
+
+# TODO

extend/index.md

@@ -0,0 +1,13 @@
+---
+layout: content
+title: Ecosystem
+---
+
+InvenTree is designeds to be part of a larger system of tools to support both hobbyists and SMEs with their mangment needs.
+
+- [Plugins](plugin)
+- [API](api)
+- [Integrate](integrate) into other tools
+- Tools for [migrating to InvenTreen](migrate)
+
+# TODO

extend/integrate/index.md

@@ -0,0 +1,9 @@
+---
+layout: content
+title: Integrate
+---
+
+Tools and plugins that integrate into InvenTree via APIs or plugins.
+- [Ki-n-Tree](kntree) KiCad integration
+
+# TODO

extend/integrate/kntree.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Ki-n-Tree
+---
+
+# TODO

extend/migrate/index.md

@@ -0,0 +1,6 @@
+---
+layout: content
+title: Migration tools
+---
+
+# TODO

extend/plugin/digikey.md

@@ -0,0 +1,6 @@
+---
+layout: plugin_highlight
+title: Integrate Digikey
+---
+
+# TODO

extend/plugin/index.md

@@ -0,0 +1,20 @@
+---
+layout: content
+title: Plugins
+---
+We supply core-dev and community built plugins to get you started with extending InvenTree's functionality. Plugins can hook into many parts of the UI, buisness logic and webserver.
+We expose some internal python APIs to speed up your development and keep the instance running while you discover the possibilities. [Learn more](# TODO plugins)
+
+### Highlights
+Use APIs supplied by your vendors or part libraries.
+- [Digikey](digikey)
+- [Octopart](octopart)
+
+Add [printing capabilities](printers) for your network connected printers to the webinterface and apps.
+
+Integrate your Shopping or warehousing solution:
+- [Shopify](shopify)
+
+### Plugin repo
+
+# TODO 

extend/plugin/octopart.md

@@ -0,0 +1,6 @@
+---
+layout: plugin_highlight
+title: Integrate Octopart
+---
+
+# TODO

extend/plugin/printers.md

@@ -0,0 +1,7 @@
+---
+layout: plugin_highlight
+title: Integrate Printers
+plugin: inventree_brother_plugin
+---
+
+# TODO

extend/plugin/shopify.md

@@ -0,0 +1,7 @@
+---
+layout: plugin_highlight
+title: Shopify
+plugin: shopify
+---
+
+# TODO