diff --git a/_config.yml b/_config.yml index 614eb261..86d21cee 100644 --- a/_config.yml +++ b/_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: "" diff --git a/_data/for_business.yml b/_data/for_business.yml index 907b7dab..80904856 100644 --- a/_data/for_business.yml +++ b/_data/for_business.yml @@ -1,6 +1,6 @@ ref: business link: - internal: business + internal: use/business title: For Business text: | lorem ipsum text diff --git a/_data/for_edu.yml b/_data/for_edu.yml index 1b160ab0..2c12e973 100644 --- a/_data/for_edu.yml +++ b/_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! diff --git a/_data/for_maker.yml b/_data/for_maker.yml index d26736f9..0d73e7c7 100644 --- a/_data/for_maker.yml +++ b/_data/for_maker.yml @@ -1,6 +1,6 @@ ref: maker link: - internal: maker + internal: use/maker title: For Maker text: | lorem ipsum text diff --git a/_includes/fnc/link.html b/_includes/fnc/link.html index 919b6a54..eda5ec42 100644 --- a/_includes/fnc/link.html +++ b/_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 %} \ No newline at end of file +{% endif %} +{% endcapture %} + +{{ link | strip }} \ No newline at end of file diff --git a/_includes/partial/alert.html b/_includes/partial/alert.html new file mode 100644 index 00000000..bcb50576 --- /dev/null +++ b/_includes/partial/alert.html @@ -0,0 +1,11 @@ + \ No newline at end of file diff --git a/_layouts/alternatives.html b/_layouts/alternatives.html new file mode 100644 index 00000000..837b61a4 --- /dev/null +++ b/_layouts/alternatives.html @@ -0,0 +1,20 @@ +--- +layout: content +--- +
+ {% 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 Alternatives. +
diff --git a/_layouts/content.html b/_layouts/content.html new file mode 100644 index 00000000..17e2f65c --- /dev/null +++ b/_layouts/content.html @@ -0,0 +1,9 @@ +--- +layout: default +--- + + +
+

{{ page.title }}

+ {{ content }} +
diff --git a/_layouts/plugin_highlight.html b/_layouts/plugin_highlight.html new file mode 100644 index 00000000..ef5cdf9e --- /dev/null +++ b/_layouts/plugin_highlight.html @@ -0,0 +1,12 @@ +--- +layout: content +--- +
+

{{ page.title }}

+ {{ content }} + {% if page.plugin %} +
+

Find out more about this plugin on the plugin site

+ {% include plugin_card.html plugin=page.plugin %} + {% endif %} +
diff --git a/about/credits.md b/about/credits.md new file mode 100644 index 00000000..cb824b75 --- /dev/null +++ b/about/credits.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Credits +--- + +# TODO diff --git a/about/imprint.md b/about/imprint.md new file mode 100644 index 00000000..9642bccf --- /dev/null +++ b/about/imprint.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Imprint +--- + +# TODO diff --git a/about/index.md b/about/index.md new file mode 100644 index 00000000..2f6deb69 --- /dev/null +++ b/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. diff --git a/about/privacy.md b/about/privacy.md new file mode 100644 index 00000000..1f16c22f --- /dev/null +++ b/about/privacy.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Privacy +--- + +# TODO diff --git a/about/social.md b/about/social.md new file mode 100644 index 00000000..cb824b75 --- /dev/null +++ b/about/social.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Credits +--- + +# TODO diff --git a/about/source.md b/about/source.md new file mode 100644 index 00000000..772aa977 --- /dev/null +++ b/about/source.md @@ -0,0 +1,6 @@ +--- +layout: content +title: How to get the source +--- + +# TODO diff --git a/about/team.md b/about/team.md new file mode 100644 index 00000000..20fd33a0 --- /dev/null +++ b/about/team.md @@ -0,0 +1,6 @@ +--- +layout: content +title: The core team +--- + +# TODO diff --git a/about/thanks.md b/about/thanks.md new file mode 100644 index 00000000..2fd7aae4 --- /dev/null +++ b/about/thanks.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Offical Social Media channels +--- + +# TODO diff --git a/alternatives/bomist.md b/alternatives/bomist.md new file mode 100644 index 00000000..8bd9f7db --- /dev/null +++ b/alternatives/bomist.md @@ -0,0 +1,8 @@ +--- +layout: alternatives +title: Partkeepr +oss: true +link: # TODO +--- + +# TODO diff --git a/alternatives/excel.md b/alternatives/excel.md new file mode 100644 index 00000000..8bd9f7db --- /dev/null +++ b/alternatives/excel.md @@ -0,0 +1,8 @@ +--- +layout: alternatives +title: Partkeepr +oss: true +link: # TODO +--- + +# TODO diff --git a/alternatives/index.md b/alternatives/index.md new file mode 100644 index 00000000..cc8d410d --- /dev/null +++ b/alternatives/index.md @@ -0,0 +1,20 @@ +--- +layout: content +title: Alternatives +--- + +InvenTree is by far not the only software for managing 'things', 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 diff --git a/alternatives/odoo.md b/alternatives/odoo.md new file mode 100644 index 00000000..4fc573d5 --- /dev/null +++ b/alternatives/odoo.md @@ -0,0 +1,8 @@ +--- +layout: alternatives +title: Odoo +oss: true +link: # TODO +--- + +# TODO diff --git a/alternatives/partkeepr.md b/alternatives/partkeepr.md new file mode 100644 index 00000000..8bd9f7db --- /dev/null +++ b/alternatives/partkeepr.md @@ -0,0 +1,8 @@ +--- +layout: alternatives +title: Partkeepr +oss: true +link: # TODO +--- + +# TODO diff --git a/alternatives/partsbox.md b/alternatives/partsbox.md new file mode 100644 index 00000000..2fb19ff3 --- /dev/null +++ b/alternatives/partsbox.md @@ -0,0 +1,8 @@ +--- +layout: alternatives +title: Bomist +oss: false +link: # TODO +--- + +# TODO diff --git a/alternatives/snipeit.md b/alternatives/snipeit.md new file mode 100644 index 00000000..3b78f467 --- /dev/null +++ b/alternatives/snipeit.md @@ -0,0 +1,8 @@ +--- +layout: alternatives +title: SnipeIT +oss: true +link: # TODO +--- + +# TODO diff --git a/alternatives/teamcenter.md b/alternatives/teamcenter.md new file mode 100644 index 00000000..40fca449 --- /dev/null +++ b/alternatives/teamcenter.md @@ -0,0 +1,8 @@ +--- +layout: alternatives +title: Teamcenter +oss: false +link: # TODO +--- + +# TODO diff --git a/contribute/code/architecture.md b/contribute/code/architecture.md new file mode 100644 index 00000000..894e8568 --- /dev/null +++ b/contribute/code/architecture.md @@ -0,0 +1,6 @@ +--- +layout: content +title: System Architecture +--- + +# TODO diff --git a/contribute/code/index.md b/contribute/code/index.md new file mode 100644 index 00000000..0a32fa55 --- /dev/null +++ b/contribute/code/index.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Contribute Code +--- + +# TODO \ No newline at end of file diff --git a/contribute/community.md b/contribute/community.md new file mode 100644 index 00000000..6ba775f9 --- /dev/null +++ b/contribute/community.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Help in the community +--- + +# TODO diff --git a/contribute/index.md b/contribute/index.md new file mode 100644 index 00000000..880172e6 --- /dev/null +++ b/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 diff --git a/contribute/sponsor.md b/contribute/sponsor.md new file mode 100644 index 00000000..6da21df5 --- /dev/null +++ b/contribute/sponsor.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Sponsoring +--- + +# TODO diff --git a/contribute/translate.md b/contribute/translate.md new file mode 100644 index 00000000..1551de38 --- /dev/null +++ b/contribute/translate.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Translations +--- + +# TODO diff --git a/deploy/bare-metal.md b/deploy/bare-metal.md new file mode 100644 index 00000000..a9869db8 --- /dev/null +++ b/deploy/bare-metal.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Deploying to Bare Metal +--- + +# TODO diff --git a/deploy/cloud.md b/deploy/cloud.md new file mode 100644 index 00000000..d7a535ee --- /dev/null +++ b/deploy/cloud.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Deploying to Cloud +--- + +# TODO diff --git a/deploy/docker.md b/deploy/docker.md new file mode 100644 index 00000000..0b4491fc --- /dev/null +++ b/deploy/docker.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Deploying to Docker +--- + +# TODO diff --git a/deploy/index.md b/deploy/index.md new file mode 100644 index 00000000..ec0f55f8 --- /dev/null +++ b/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). \ No newline at end of file diff --git a/extend/api.md b/extend/api.md new file mode 100644 index 00000000..7a1c87f5 --- /dev/null +++ b/extend/api.md @@ -0,0 +1,6 @@ +--- +layout: content +title: API +--- + +# TODO diff --git a/extend/index.md b/extend/index.md new file mode 100644 index 00000000..258a9bb2 --- /dev/null +++ b/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 diff --git a/extend/integrate/index.md b/extend/integrate/index.md new file mode 100644 index 00000000..18f8cdcb --- /dev/null +++ b/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 diff --git a/extend/integrate/kntree.md b/extend/integrate/kntree.md new file mode 100644 index 00000000..4e6cee34 --- /dev/null +++ b/extend/integrate/kntree.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Ki-n-Tree +--- + +# TODO diff --git a/extend/migrate/index.md b/extend/migrate/index.md new file mode 100644 index 00000000..59251448 --- /dev/null +++ b/extend/migrate/index.md @@ -0,0 +1,6 @@ +--- +layout: content +title: Migration tools +--- + +# TODO diff --git a/extend/plugin/digikey.md b/extend/plugin/digikey.md new file mode 100644 index 00000000..cf5b4985 --- /dev/null +++ b/extend/plugin/digikey.md @@ -0,0 +1,6 @@ +--- +layout: plugin_highlight +title: Integrate Digikey +--- + +# TODO diff --git a/extend/plugin/index.md b/extend/plugin/index.md new file mode 100644 index 00000000..3f051447 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/extend/plugin/octopart.md b/extend/plugin/octopart.md new file mode 100644 index 00000000..12367099 --- /dev/null +++ b/extend/plugin/octopart.md @@ -0,0 +1,6 @@ +--- +layout: plugin_highlight +title: Integrate Octopart +--- + +# TODO diff --git a/extend/plugin/printers.md b/extend/plugin/printers.md new file mode 100644 index 00000000..6f718b54 --- /dev/null +++ b/extend/plugin/printers.md @@ -0,0 +1,7 @@ +--- +layout: plugin_highlight +title: Integrate Printers +plugin: inventree_brother_plugin +--- + +# TODO diff --git a/extend/plugin/shopify.md b/extend/plugin/shopify.md new file mode 100644 index 00000000..e810a5b8 --- /dev/null +++ b/extend/plugin/shopify.md @@ -0,0 +1,7 @@ +--- +layout: plugin_highlight +title: Shopify +plugin: shopify +--- + +# TODO diff --git a/business.md b/use/business.md similarity index 100% rename from business.md rename to use/business.md diff --git a/education.md b/use/education.md similarity index 100% rename from education.md rename to use/education.md diff --git a/maker.md b/use/maker.md similarity index 100% rename from maker.md rename to use/maker.md