From 7d6c04e3cf386df8fe2dcb2bb66877aae7d9f996 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Sat, 18 Mar 2023 21:41:00 +0100 Subject: [PATCH] Improved documentation --- README.md | 2 +- docs/upgrade_legacy.md | 5 +++-- templates/parts/import/parts_import.html.twig | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2ab62eba..1ae69b86 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ and multiple store locations and price information. Parts can be grouped using t * User system with groups and detailed (fine granular) permissions. Two-factor authentication is supported (Google Authenticator and Webauthn/U2F keys) and can be enforced for groups. Password reset via email can be setuped. * Optional support for single sign-on (SSO) via SAML (using an intermediate service like [Keycloak](https://www.keycloak.org/) you can connect Part-DB to an existing LDAP or Active Directory server) -* Import/Export system (partial working) +* Import/Export system for parts and datastructure. BOM import for projects from KiCAD is supported. * Project management: Create projects and assign parts to the bill of material (BOM), to show how often you could build this project and directly withdraw all components needed from DB * Event log: Track what changes happens to your inventory, track which user does what. Revert your parts to older versions. * Responsive design: You can use Part-DB on your PC, your tablet and your smartphone using the same interface. diff --git a/docs/upgrade_legacy.md b/docs/upgrade_legacy.md index 9f34a55f..ca9ee053 100644 --- a/docs/upgrade_legacy.md +++ b/docs/upgrade_legacy.md @@ -23,13 +23,14 @@ Some things changed however to the old version and some features are still missi * Configuration is now done via configuration files / environment variables instead of the WebUI (this maybe change in the future). * Database updated are now done via console instead of the WebUI * Permission system changed: **You will have to newly set the permissions of all users and groups!** +* Import / Export file format changed. Fields must be english now (unlike in legacy Part-DB versions, where german fields in CSV were possible) +and you maybe have to change the header line/field names of your CSV files. ## Missing features * No possibility to mark parts for ordering (yet) -* No import / export possibility for parts (yet), however you can import/export other datastructures like Categories, Footprints, etc. (yet) * No support for 3D models of footprints (yet) * No possibility to disable footprints, manufacturers globally (or per category). This should not have a big impact, when you forbid users to edit/create them. -* No resitor calculator or SMD labels tools +* No resistor calculator or SMD labels tools ## Upgrade process diff --git a/templates/parts/import/parts_import.html.twig b/templates/parts/import/parts_import.html.twig index e10117fc..794b6886 100644 --- a/templates/parts/import/parts_import.html.twig +++ b/templates/parts/import/parts_import.html.twig @@ -27,7 +27,7 @@ {% block card_content %}

{% trans %}parts.import.help{% endtrans %}
- {% trans with {'%link%': 'https://docs.part-db.de/'} %}parts.import.help_documentation{% endtrans %} + {% trans with {'%link%': 'https://docs.part-db.de/usage/import_export.html'} %}parts.import.help_documentation{% endtrans %}

{{ form(import_form) }}