mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-09 20:40:17 +02:00
Merge branch 'improve_developer_docs' into 'master'
Improve developer docs See merge request allianceauth/allianceauth!1292
This commit is contained in:
commit
c12fd2d7bc
@ -25,6 +25,11 @@ The development environment consists of the following components:
|
|||||||
|
|
||||||
We will use the build-in Django development webserver, so we don't need to setup a WSGI server or a web server.
|
We will use the build-in Django development webserver, so we don't need to setup a WSGI server or a web server.
|
||||||
|
|
||||||
|
```eval_rst
|
||||||
|
.. note::
|
||||||
|
This setup works with both WSL 1 and WSL 2. However, due to the significantly better performance we recommend WSL 2.
|
||||||
|
```
|
||||||
|
|
||||||
## Requirement
|
## Requirement
|
||||||
|
|
||||||
The only requirement is a PC with Windows 10 and Internet connection in order to download the additional software components.
|
The only requirement is a PC with Windows 10 and Internet connection in order to download the additional software components.
|
||||||
@ -361,8 +366,7 @@ Here is an example debug config for Celery:
|
|||||||
"module": "celery",
|
"module": "celery",
|
||||||
"cwd": "${workspaceFolder}/myauth",
|
"cwd": "${workspaceFolder}/myauth",
|
||||||
"console": "integratedTerminal",
|
"console": "integratedTerminal",
|
||||||
"args": [
|
"args": [
|
||||||
"-E",
|
|
||||||
"-A",
|
"-A",
|
||||||
"myauth",
|
"myauth",
|
||||||
"worker",
|
"worker",
|
||||||
@ -371,7 +375,8 @@ Here is an example debug config for Celery:
|
|||||||
"-P",
|
"-P",
|
||||||
"solo",
|
"solo",
|
||||||
],
|
],
|
||||||
"django": true
|
"django": true,
|
||||||
|
"justMyCode": true,
|
||||||
},
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -386,15 +391,14 @@ Finally it makes sense to have a dedicated debug config for running unit tests.
|
|||||||
"request": "launch",
|
"request": "launch",
|
||||||
"program": "${workspaceFolder}/myauth/manage.py",
|
"program": "${workspaceFolder}/myauth/manage.py",
|
||||||
"args": [
|
"args": [
|
||||||
"test",
|
"test",
|
||||||
"-v 2",
|
|
||||||
"--keepdb",
|
"--keepdb",
|
||||||
"--debug-mode",
|
"--debug-mode",
|
||||||
"--failfast",
|
"--failfast",
|
||||||
"example",
|
"example",
|
||||||
],
|
],
|
||||||
|
"django": true,
|
||||||
"django": true
|
"justMyCode": true
|
||||||
},
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -416,13 +420,31 @@ Finally you may also want to have a debug config to debug a non-Django Python sc
|
|||||||
|
|
||||||
## Additional tools
|
## Additional tools
|
||||||
|
|
||||||
The following additional tools are very helpful when developing for AA.
|
The following additional tools are very helpful when developing for AA with VS Code:
|
||||||
|
|
||||||
|
### Pylance
|
||||||
|
|
||||||
|
Pylance is an extension that works alongside Python in Visual Studio Code to provide performant language support: [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
|
||||||
|
|
||||||
### Code Spell Checker
|
### Code Spell Checker
|
||||||
|
|
||||||
Typos in your user facing comments can be quite embarrassing. This spell checker helps you avoid them.
|
Typos in your user facing comments can be quite embarrassing. This spell checker helps you avoid them: [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
|
||||||
|
|
||||||
Install from here: [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
|
### markdownlint
|
||||||
|
|
||||||
|
Extension for Visual Studio Code - Markdown linting and style checking for Visual Studio Code: [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
||||||
|
|
||||||
|
### GitLens
|
||||||
|
|
||||||
|
Extension for Visual Studio Code - Supercharge the Git capabilities built into Visual Studio Code: [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
|
||||||
|
|
||||||
|
### RST preview
|
||||||
|
|
||||||
|
A VS Code extension to preview restructured text and provide syntax highlighting: [RST Preview](https://marketplace.visualstudio.com/items?itemName=tht13.rst-vscode)
|
||||||
|
|
||||||
|
### Django Template
|
||||||
|
|
||||||
|
This extension adds language colorization support and user snippets for the Django template language to VS Code: [Django Template](https://marketplace.visualstudio.com/items?itemName=bibhasdn.django-html)
|
||||||
|
|
||||||
### DBeaver
|
### DBeaver
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ models
|
|||||||
===========
|
===========
|
||||||
|
|
||||||
.. autoclass:: allianceauth.notifications.models.Notification
|
.. autoclass:: allianceauth.notifications.models.Notification
|
||||||
:members: view, set_level, LEVEL_CHOICES
|
:members: LEVEL_CHOICES, mark_viewed, set_level
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
|
|
||||||
managers
|
managers
|
||||||
|
@ -42,11 +42,12 @@ Auto Groups are configured via models in the Admin Interface, a user will requir
|
|||||||
+-------------------------------------------+------------------+----------------+
|
+-------------------------------------------+------------------+----------------+
|
||||||
| Permission | Admin Site | Auth Site |
|
| Permission | Admin Site | Auth Site |
|
||||||
+===========================================+==================+================+
|
+===========================================+==================+================+
|
||||||
| eve_autogroups.add_autogroupsconfig | Can create model | None. |
|
| eve_autogroups.add_autogroupsconfig | Can create model | None. |
|
||||||
+-------------------------------------------+------------------+----------------+
|
+-------------------------------------------+------------------+----------------+
|
||||||
| eve_autogroups.change_autogroupsconfig | Can edit model | None. |
|
| eve_autogroups.change_autogroupsconfig | Can edit model | None. |
|
||||||
+-------------------------------------------+------------------+----------------+
|
+-------------------------------------------+------------------+----------------+
|
||||||
| eve_autogroups.delete_autogroupsconfig | Can delete model | None. |
|
| eve_autogroups.delete_autogroupsconfig | Can delete model | None. |
|
||||||
+-------------------------------------------+------------------+----------------+
|
+-------------------------------------------+------------------+----------------+
|
||||||
```
|
```
|
||||||
|
|
||||||
There exists more models that will be automatically created and maintained by this module, they do not require end-user/admin interaction. `managedalliancegroup` `managedcorpgroups`
|
There exists more models that will be automatically created and maintained by this module, they do not require end-user/admin interaction. `managedalliancegroup` `managedcorpgroups`
|
||||||
|
@ -38,14 +38,14 @@ To install we need a copy of the server. You can find the latest version from [t
|
|||||||
|
|
||||||
Download the server, replacing the link with the link you got earlier.
|
Download the server, replacing the link with the link you got earlier.
|
||||||
|
|
||||||
```url
|
```text
|
||||||
http://dl.4players.de/ts/releases/3.13.2/teamspeak3-server_linux_amd64-3.13.2.tar.bz2
|
http://dl.4players.de/ts/releases/3.13.2/teamspeak3-server_linux_amd64-3.13.2.tar.bz2
|
||||||
```
|
```
|
||||||
|
|
||||||
Now we need to extract the file.
|
Now we need to extract the file.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tar -xf teamspeak3-server_linux_amd64-3.1.0.tar.bz2
|
tar -xf teamspeak3-server_linux_amd64-3.1.0.tar.bz2
|
||||||
```
|
```
|
||||||
|
|
||||||
### Create User
|
### Create User
|
||||||
|
Loading…
x
Reference in New Issue
Block a user