Commit Graph

31 Commits

Author SHA1 Message Date
Matthias Mair
005c8341bf
Improve devdocs (#4813)
* move devcontainer docs

* rename bare metal pages

* fix backlinks

* Add getting started for devs

* add mermaid

* include contrib in docs

* use another plugin

* include everything

* update doc checks

* fix install command

* remove mermaid

* remove inclusion tag

* remove empty list item

* readd include-markdown

* use non-conflicting syntax for include

* fix table rendering in mkdocs

* make controbuting embedable

* re-add mermaid

* remove empty section

* resturcture

* remove mermaid again
2023-06-09 10:16:30 +10:00
Oliver
81413e02c4
Update CONTRIBUTING.md (#4988)
Add notes about "migration" tag
2023-06-07 22:15:59 +10:00
Oliver
a4be6bc90b
New tags (#4971)
- feature
- experimental
2023-06-05 19:41:42 +10:00
Matthias Mair
21ed4b2081
Fix common spelling mistakes (#4956)
* add codespell

* first fixes

* doc fixes

* fix docstrings and comments

* functional changes

* docstrings again

* and docs again

* rename args

* add ignore

* use pre-commit for filtering instead

* ups

* fix typo in filter
2023-06-04 00:04:52 +10:00
Oliver
5e2bfaa43a
Update CONTRIBUTING.md (#4960)
Add documentation on new PR tags
2023-06-03 23:16:39 +10:00
miggland
11c5ce5f80
Test flexibility (#4945)
* Add option to specify which tests to run in invoke test

* Add information on testing in CONTRIBUTING.md
2023-06-01 23:54:06 +10:00
Matthias Mair
10c3d101e8
Replace mklint with djlint (#4746)
* remove markuplint

* remove dedicated html step - will be done by pre-commit

* add djlint for django template linting

* Fix T003: Endblock should have name

* Fix H013: Img tag should have an alt attribute

* Fix H014: Found extra blank lines

* Fix T003: Endblock should have name

* Fix H013: Img tag should have an alt attribute

* small fixes

* Fix T001: Variables should be wrapped in a single whitespace

* Fix T003: Endblock should have name

* small fixes

* fix form method

* add entry to contributing

* fix template changes

* another fix

* use current version
2023-05-02 20:03:52 +10:00
Oliver
2ffd2354eb
Documentation integration (#4653)
* Add documentation under docs/ directory

* Add CI workflow for mkdocs configuration checking

* Add documentation issue template

* update pip-tools?

* Update .gitignore files

* Fix .gitignore rules

* Improve release notes page

* remove references to old repo
2023-04-22 22:40:29 +10:00
Matthias Mair
c28c991591
Fix wget command and links in Readme (#4551)
* fix wget command in Readme
Fixes https://github.com/inventree/InvenTree/issues/4548
reported by @liuqun

* change doc links int markdown

* update bash script

* Add typing

* regenerate script

* fix link to contribute

* update more links

* remove additional whitespace
2023-04-02 07:34:53 +10:00
Matthias Mair
964d674884
Update issue templates to GH forms (#3495)
* move bug report to form

* add more options

* move FRs to templates

* add tag information
2022-08-08 11:12:52 +10:00
Matthias Mair
a77f21b17e
update trnaslation function name to new default (#3497) 2022-08-08 07:50:36 +10:00
Oliver
e9b0f02ecd
Update demo data hook to copy media files (#3441)
* Simplify settings.py / config.py

- get_setting function has been streamlined
- move some functions into config.py

* Spelling fix: IGNORRED is IGNORED

* Ensure yaml is installed as part of docker image

- invoke path is still mucking us around

* Fix broken migration

* Copy media files from demo dataset when installing test data

* Cleanup settings.py

* Fix for configuration file traversal

* Line fix

* Update quickstart guide for docker

* Allow plugin file and plugin dir to be specified in configuration file

* Cleanup config template file

* Allow secret_key information to be provided in configuration file

* Adjust root paths for CI tests

* resolve paths

* Revert paths for CI step

* remove dead code

* Revert configuration variables to old names

- Prevent breaking changes

* Simplify secret key generation

* Fix default timeout for background worker process

* Revert change for customization options
2022-07-31 23:16:58 +10:00
Oliver
3fc9a36d4b
Simplification of development docker-compose file (#3429)
* Simplification of development docker-compose file

- Rename .env file
- Remove requirement for variable interpolation within the docker-compose file itself

* Add debug flag to CI test

* Additional quick-start docs (for docker)

* docker-compose update

- Introspection did not work quite as expected
- Set project name inside docker-compose file

* Fixes for "setup_test" task

- Check if directory exists before first deleting it
- Parameterize the "path" variable
- Add option to ignore update step

* Add demo data dir to .gitignore

* Remove debug call

* Update CONTRIBUTING.md
2022-07-30 10:34:16 +10:00
Matthias Mair
e461a2c1ef
Development improvements (#3413)
* rename .env to make sure it is not loaded by default

* make sure migrations are run before import

* Add more messaget to setup_test

* add comments to setup-dev

* Add flag to setup-dev for setting up test data

* add flag to setup-test to also run development setup

* extend contributing with the flags

* change flag to tests

* Add option helptexts

* A nicer starter

* add 3 liner

* Revert "rename .env to make sure it is not loaded by default"

This reverts commit 95fa0bbc53.
2022-07-29 14:58:54 +10:00
Oliver
8a2cfa04d1
Adds release.yml file for auto-generating release notes (#3099)
* Adds release.yml file for auto-generating release notes

* Add more tags
2022-05-30 23:57:15 +10:00
Oliver
0e9ea1be0c
Update CONTRIBUTING.md 2022-05-25 19:58:14 +10:00
Matthias Mair
93b6934127 fix trailing 2022-05-20 13:20:55 +02:00
Matthias Mair
f98ec6cf35
Add pre-commit comment 2022-05-19 01:34:39 +02:00
Matthias
da36af2021
fix link 2022-05-16 01:19:07 +02:00
Matthias
a07fdb7c16
add docstring comment 2022-05-16 01:18:55 +02:00
Oliver
dbc0023c57
Update CONTRIBUTING.md
Update labels a bit
2022-05-04 12:10:00 +10:00
Matthias
e10ee91109
make names clearer 2022-05-03 01:19:08 +02:00
Matthias
1c0c3f9a72
Add tags 2022-05-03 01:16:44 +02:00
Matthias
f8a2811d90
change hierarchy 2022-05-03 00:55:29 +02:00
Matthias
105818dd0d
Add docs about target versions and upgrades 2022-05-01 22:44:36 +02:00
Oliver
dfd500097e Update contributing.md
(cherry picked from commit 398842d6e5)
2021-09-13 20:03:31 +10:00
Matthias
e34c27e360
removed translation part - is done now by action 2021-08-20 00:25:55 +02:00
Oliver Walters
07adee3c51 Update links to documenation 2020-09-21 22:44:48 +10:00
Oliver Walters
225ad0ffa6 Add note in contribution file regarding translations 2019-09-27 10:07:34 +10:00
Oliver
8d4e2ce498
Update CONTRIBUTING.md
Include notes about migration files
2019-09-15 22:34:22 +10:00
Oliver
927160c77f
Create CONTRIBUTING.md 2019-09-10 10:33:44 +10:00