inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-07-07 14:10:55 +00:00
Code Activity

Docs refactor (#9545)

Browse Source 
* Refactor / reognaize docs structure

* Refactor plugin docs structure

* More refactoring / cleanup

* Update build images

* Gallery updates

* Order images

* Update part docs

* Settings images

* Stock images

* Reitntroduce gallery

* Add custom icon macro

* Update icons

* Cleanup

* Fix link

* Fix internal links

* Revert some page moves

* Fix links

* Fix links
This commit is contained in:
Oliver
2025-04-22 08:18:32 +10:00
committed by GitHub
parent 9b489911e5
commit 6b08e45eac
240 changed files with 964 additions and 831 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/project/governance.md
View File

@ -1,6 +1,6 @@
As a MIT licensed open-source project, there are not legal obligations for the InvenTree project team or any contributor to provide support or maintenance. The software is provided "as-is" - without warranty of any kind.
However, the project team is committed to providing a reliable and [secure](security.md) code base with predictable upgrade paths.
However, the project team is committed to providing a reliable and [secure](../security.md) code base with predictable upgrade paths.
## Team organisation

38
docs/docs/project/privacy.md Normal file
View File

@ -0,0 +1,38 @@
---
title: Privacy
---
## InvenTree Privacy Statement
As far as is practicable, the InvenTree application (comprising the database, web server and associated software) does not record, track or share any identifiable information about its users. InvenTree does not share any user data (as stored in the product database) with other parties.
### Data Collection
The InvenTree application does not collect any user information beyond what is stored in the InvenTree database itself.
Data stored within the InvenTree database is used only for the purposes of fulfilling InvenTree functionality.
### Cookies
The InvenTree web application makes use of local cookies to perform core InvenTree functionality maintain a persistent user experience.
- These cookies are necessary for InvenTree functionality
- These cookies do not record or track any information which can be used to identify the user
- Stored data are not shared with any third parties
!!! info "Tracking Cookies"
The InvenTree web server does not make use of any tracking cookies, or any third party cookies which share user information with other parties.
### Data Sharing
The InvenTree application does not share any information with outside parties or servers. The InvenTree application is completely self contained on the server where it is hosted.
### Plugins
Any third party plugins which integrate with the InvenTree server should provide their own privacy notice. The privacy implications of plugins not provided directly by InvenTree may differ to the details on this page.
## InvenTree Documentation
The InvenTree documentation is hosted by [readthedocs](https://readthedocs.org/). You can read their privacy policy [here](https://docs.readthedocs.io/en/stable/privacy-policy.html).
Third party tracking cookies (e.g. Google Analytics) are *explicitly disabled* for the InvenTree documentation server.

55
docs/docs/project/security.md
View File

@ -1,55 +0,0 @@
The InvenTree project is committed to providing a secure and safe environment for all users. We know that many of our users rely on InvenTree to manage the inventory and manufacturing for their small and mid-size businesses, and we take that responsibility seriously.
To that end, we have implemented a number of security measures over the years, which we will outline in this document.
## Organisational measures
The InvenTree project is managed by a small team of developers, who are responsible for the ongoing development and maintenance of the software. Two geographically distributed users have administrative access to the InvenTree codebase. Merges are only done by one of these two users, the maintainer Oliver.
Read the Project [Governance](governance.md) document for more information.
InvenTree is open-source, and we welcome contributions from the community. However, all contributions are reviewed and scrutinised before being merged into the codebase.
We provide a written [Security Policy]({{ sourcefile("SECURITY.md") }}) in our main repo to ensure that all security issues are handled in a timely manner.
If we become aware of a security issue, we will take immediate action to address the issue, and will provide a public disclosure of the issue once it has been resolved. We support assigning CVEs to security issues where appropriate. Our [past security advisories can be found here](https://github.com/inventree/InvenTree/security/advisories).
## Technical measures
### Code hosting
The InvenTree project is hosted on GitHub, and we rely on the security measures provided by GitHub to help protect the integrity of the codebase.
Among those are:
- Short-lived tokens where possible
- Dependabot for automated dependency updates / alerts
- Integrated security reporting
- (Optional but encouraged) Two-factor authentication for user accounts
- (Optional but encouraged) Signed commits / actions
### Code style
We enforce style and security checks in our CI/CD pipeline, and we have several automated tests to ensure that the codebase is secure and functional.
Checks are run on every pull request, and we require that all checks pass before a pull request can be merged.
### Current versions
InvenTree is built using the Django framework, which has a strong focus on security. We follow best practices for Django development, and we are committed to keeping the codebase up-to-date with the latest security patches and within supported versions.
### Test coverage
We run coverage tests on our codebase to ensure that we have a high level of test coverage above 90%. This is public and can be found [here](https://app.codecov.io/gh/inventree/InvenTree).
### Pinning dependencies
We are pinning dependencies to specific versions - aiming for complete reproducibility of builds - wherever possible. Combined with continuous OSV checks, we are able to react quickly to security issues in our dependencies.
## Best practices
We follow most of GitHubs community best practices, check our compliance [here](https://github.com/inventree/InvenTree/community).
We also follow OpenSSF recommendations where applicable and take part in multiple of their security efforts:
- OSSF Best Practices, currently at a [level of passing](https://www.bestpractices.dev/de/projects/7179)
- OSSF Scorecard, running with each merge [check current state](https://securityscorecards.dev/viewer/?uri=github.com/inventree/InvenTree)