inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2026-07-19 21:17:03 +00:00
Code Activity

feat(docs): add architecture/roadmap (#9624)

Browse Source 
* feat(docs): Add architecture overview

* add strucutre for rough roadmap

* add stable reference

* document stable links

* test mermaid again

* fix loading

* fix format to reduce warnings

* use local js

* add architecture ovierview

* add more sub-points

* more structure

* add general backend text

* add sme bqsic docs for frontend

* fix list syntax

* fix typo
This commit is contained in:
Matthias Mair
2025-06-13 11:28:02 +10:00
committed by GitHub
parent c70583097c
commit 4b1eeefb1f
12 changed files with 2796 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/plugins/mixins/export.md
+5 -5
View File
@@ -24,7 +24,7 @@ Each plugin can dictate which datasets are supported using the `supports_export`
summary: False
members: []
extra:
show_sources: True
show_source: True
The default implementation returns `True` for all data types.
@@ -40,7 +40,7 @@ The `generate_filename` method constructs a filename for the exported file.
summary: False
members: []
extra:
show_sources: True
show_source: True
### Adjust Columns
@@ -54,7 +54,7 @@ The `update_headers` method allows the plugin to adjust the columns selected to
summary: False
members: []
extra:
show_sources: True
show_source: True
### Queryset Filtering
@@ -68,7 +68,7 @@ The `filter_queryset` method allows the plugin to provide custom filtering to th
summary: False
members: []
extra:
show_sources: True
show_source: True
### Export Data
@@ -82,7 +82,7 @@ The `export_data` method performs the step of transforming a [Django QuerySet]({
summary: False
members: []
extra:
show_sources: True
show_source: True
Note that the default implementation simply uses the builtin tabulation functionality of the provided serializer class. In most cases, this will be sufficient.
docs/docs/plugins/mixins/ui.md
+8 -8
View File
@@ -24,7 +24,7 @@ The entrypoint for user interface plugins is the `UserInterfaceMixin` class, whi
summary: False
members: []
extra:
show_sources: True
show_source: True
Note here that the `get_ui_features` calls other methods to extract the available features from the plugin, based on the requested feature type. These methods can be overridden to provide custom functionality.
@@ -43,7 +43,7 @@ The `get_ui_features` method should return a list of `UIFeature` objects, which
summary: False
members: []
extra:
show_sources: True
show_source: True
Note that the *options* field contains fields which may be specific to a particular feature type - read the documentation below on each feature type for more information.
@@ -79,7 +79,7 @@ The InvenTree dashboard is a collection of "items" which are displayed on the ma
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -93,7 +93,7 @@ The *options* field in the returned `UIFeature` object can contain the following
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -115,7 +115,7 @@ Many of the pages in the InvenTree web interface are built using a series of "pa
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -129,7 +129,7 @@ The *options* field in the returned `UIFeature` object can contain the following
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -151,7 +151,7 @@ The `get_ui_template_editors` feature type can be used to provide custom templat
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -165,7 +165,7 @@ The `get_ui_template_previews` feature type can be used to provide custom templa
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
docs/docs/plugins/mixins/validation.md
+10 -10
View File
@@ -26,7 +26,7 @@ A custom plugin may implement the `validate_model_deletion` method to perform cu
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -42,7 +42,7 @@ Any plugin which inherits the `ValidationMixin` can implement the `validate_mode
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -116,7 +116,7 @@ If the custom method determines that the part name is *objectionable*, it should
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -130,7 +130,7 @@ Validation of the Part IPN (Internal Part Number) field is exposed to custom plu
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -144,7 +144,7 @@ Validation of the Part IPN (Internal Part Number) field is exposed to custom plu
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -162,7 +162,7 @@ The `validate_batch_code` method allows plugins to raise an error if a batch cod
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -176,7 +176,7 @@ The `generate_batch_code` method can be implemented to generate a new batch code
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -196,7 +196,7 @@ Custom serial number validation can be implemented using the `validate_serial_nu
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -236,7 +236,7 @@ A custom plugin can implement the `convert_serial_to_int` method to determine ho
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []
@@ -255,7 +255,7 @@ For custom serial number schemes, it is important to provide a method to generat
show_root_heading: False
show_root_toc_entry: False
extra:
show_sources: True
show_source: True
summary: False
members: []