mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-12-18 23:05:07 +01:00
[FIX] Grammar and spelling
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Auto Groups
|
||||
|
||||
Auto groups allows you to automatically place users of certain states into Corp or Alliance based groups. These groups are created when the first user is added to them and removed when the configuration is deleted.
|
||||
Auto Groups allows you to automatically place users of certain states into corp or alliance-based groups. These groups are created when the first user is added to them and removed when the configuration is deleted.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -10,19 +10,19 @@ To install this app add `'allianceauth.eveonline.autogroups',` to your `INSTALLE
|
||||
|
||||
## Configuring a group
|
||||
|
||||
When you create an autogroup config you will be given the following options:
|
||||
When you create an autogroup config, you will be given the following options:
|
||||
|
||||

|
||||
|
||||
:::{warning}
|
||||
After creating a group you wont be able to change the Corp and Alliance group prefixes, name source and the replace spaces settings. Make sure you configure these the way you want before creating the config. If you need to change these you will have to create a new autogroup config.
|
||||
After creating a group, you won't be able to change the Corp and Alliance group prefixes, name source, and the replace spaces settings. Make sure you configure these the way you want before creating the config. If you need to change these, you will have to create a new autogroup config.
|
||||
:::
|
||||
|
||||
- States selects which states will be added to automatic Corp/Alliance groups
|
||||
- States select which states will be added to automatic Corp/Alliance groups
|
||||
- Corp/Alliance groups checkbox toggles Corp/Alliance autogroups on or off for this config.
|
||||
- Corp/Alliance group prefix sets the prefix for the group name, e.g. if your Corp was called `MyCorp` and your prefix was `Corp`, your autogroup name would be created as `Corp MyCorp`. This field accepts leading/trailing spaces.
|
||||
- Corp/Alliance name source sets the source of the Corp/Alliance name used in creating the group name. Currently the options are Full name and Ticker.
|
||||
- Replace spaces allows you to replace spaces in the autogroup name with the value in the Replace spaces with field. This can be blank.
|
||||
- Corp/Alliance group prefix sets the prefix for the group name, e.g., if your corp was called `MyCorp` and your prefix was `Corp`, your autogroup name would be created as `Corp MyCorp`. This field accepts leading/trailing spaces.
|
||||
- Corp/Alliance name source sets the source of the Corp/Alliance name used in creating the group name. Currently, the options are Full name and Ticker.
|
||||
- Replace spaces allows you to replace spaces in the autogroup name with the value in the replace spaces with field. This can be blank.
|
||||
|
||||
## Permissions
|
||||
|
||||
|
||||
@@ -12,13 +12,13 @@ Add `'allianceauth.corputils',` to your `INSTALLED_APPS` list in your auth proje
|
||||
|
||||
## Creating a Corp Stats
|
||||
|
||||
Upon initial install, nothing will be visible. For every Corp, a model will have to be created before data can be viewed.
|
||||
Upon initial installation, nothing will be visible. For every Corp, a model will have to be created before data can be viewed.
|
||||
|
||||

|
||||
|
||||
If you are a superuser, the add button will be immediate visible to you. If not, your user account requires the `add_corpstats` permission.
|
||||
If you are a superuser, the "add" button will be immediately visible to you. If not, your user account requires the `add_corpstats` permission.
|
||||
|
||||
Corp Stats requires an EVE SSO token to access data from the EVE Swagger Interface. Upon pressing the Add button, you will be prompted to authenticated. Please select the character who is in the Corporation you want data for.
|
||||
Corp Stats requires an EVE SSO token to access data from the EVE Swagger Interface. Upon pressing the Add button, you will be prompted to authenticate. Please select the character who is in the Corporation you want data for.
|
||||
|
||||

|
||||
|
||||
@@ -26,8 +26,8 @@ You will return to auth where you are asked to select a token with the green arr
|
||||
|
||||

|
||||
|
||||
If this works (and you have permission to view the Corp Stats you just created) you'll be returned to a view of the Corp Stats.
|
||||
If it fails an error message will be displayed.
|
||||
If this works (and you have permission to view the Corp Stats you just created), you'll be returned to a view of the Corp Stats.
|
||||
If it fails, an error message will be displayed.
|
||||
|
||||
## Corp Stats View
|
||||
|
||||
@@ -63,13 +63,13 @@ Each view contains a sortable and searchable table. The number of listings shown
|
||||
|
||||

|
||||
|
||||
This list contains all main characters in registered in the selected Corporation and their alts. Each character has a link to [zKillboard](https://zkillboard.com).
|
||||
This list contains all main characters registered in the selected Corporation and their alts. Each character has a link to [zKillboard](https://zkillboard.com).
|
||||
|
||||
#### Member List
|
||||
|
||||

|
||||
|
||||
The list contains all characters in the Corporation. Red backgrounds means they are not registered in auth. A link to [zKillboard](https://zkillboard.com) is present for all characters.
|
||||
The list contains all characters in the Corporation. Red backgrounds mean they are not registered in auth. A link to [zKillboard](https://zkillboard.com) is present for all characters.
|
||||
If registered, the character will also have a main character, main Corporation, and main Alliance field.
|
||||
|
||||
#### Unregistered List
|
||||
@@ -108,7 +108,7 @@ Users who add a Corp Stats with their token will be granted permissions to view
|
||||
|
||||
## Automatic Updating
|
||||
|
||||
By default Corp Stats are only updated on demand. If you want to automatically refresh on a schedule, add an entry to your project's settings file:
|
||||
By default, Corp Stats are only updated on demand. If you want to automatically refresh on a schedule, add an entry to your project's settings file:
|
||||
|
||||
```python
|
||||
CELERYBEAT_SCHEDULE['update_all_corpstats'] = {
|
||||
@@ -134,11 +134,11 @@ Only one Corp Stats may exist at a time for a given Corporation.
|
||||
|
||||
>Failed to gather corporation statistics with selected token.
|
||||
|
||||
During initial population, the EVE Swagger Interface did not return any member data. This aborts the creation process. Please wait for the API to start working before attempting to create again.
|
||||
During the initial population, the EVE Swagger Interface did not return any member data. This aborts the creation process. Please wait for the API to start working before attempting to create again.
|
||||
|
||||
### Failure to update Corp Stats
|
||||
|
||||
Any of the following errors will result in a notification to the owning user, and deletion of the Corp Stats model.
|
||||
Any of the following errors will result in a notification to the owning user and deletion of the Corp Stats model.
|
||||
|
||||
>Your token has expired or is no longer valid. Please add a new one to create a new CorpStats.
|
||||
|
||||
@@ -146,7 +146,7 @@ This occurs when the SSO token is invalid, which can occur when deleted by the u
|
||||
|
||||
>CorpStats for (corp name) cannot update with your ESI token as you have left corp.
|
||||
|
||||
The SSO token's character is no longer in the Corporation which the Corp Stats is for, and therefore membership data cannot be retrieved.
|
||||
The SSO token's character is no longer in the Corporation that the Corp Stats are for, and therefore membership data cannot be retrieved.
|
||||
|
||||
>HTTPForbidden
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ This app allows you to manage applications for multiple corporations in your all
|
||||
|
||||
- Define application questionnaires for corporations
|
||||
- Users can apply to corporations by filling outquestionnaires
|
||||
- Manage review and approval process of applications
|
||||
- Manage a review and approval process of applications
|
||||
|
||||

|
||||
|
||||
@@ -20,11 +20,11 @@ The most common task is creating ApplicationForm models for corps. Only when suc
|
||||
|
||||
The first step is to create questions. This is achieved by creating ApplicationQuestion models, one for each question. Titles are not unique.
|
||||
|
||||
Next step is to create the actual ApplicationForm model. It requires an existing EveCorporationInfo model to which it will belong. It also requires the selection of questions. ApplicationForm models are unique per Corporation: only one may exist for any given Corporation concurrently.
|
||||
The next step is to create the actual ApplicationForm model. It requires an existing EveCorporationInfo model to which it will belong. It also requires the selection of questions. ApplicationForm models are unique per Corporation: only one may exist for any given Corporation concurrently.
|
||||
|
||||
You can adjust these questions at any time. This is the preferred method of modifying the form: deleting and recreating will cascade the deletion to all received applications from this form which is usually not intended.
|
||||
You can adjust these questions at any time. This is the preferred method of modifying the form: deleting and recreating will cascade the deletion to all received applications from this form, which is usually not intended.
|
||||
|
||||
Once completed the Corporation will be available to receive applications.
|
||||
Once completed, the Corporation will be available to receive applications.
|
||||
|
||||
### Reviewing Applications
|
||||
|
||||
@@ -32,7 +32,7 @@ Superusers can see all applications, while normal members with the required perm
|
||||
|
||||
Selecting an application from the management screen will provide all the answers to the questions in the form at the time the user applied.
|
||||
|
||||
When a reviewer assigns themselves an application, they mark it as in progress. This notifies the applicant and permanently attached the reviewer to the application.
|
||||
When a reviewer assigns themselves an application, they mark it as in progress. This notifies the applicant and permanently attaches the reviewer to the application.
|
||||
|
||||
Only the assigned reviewer can approve/reject/delete the application if they possess the appropriate permission.
|
||||
|
||||
@@ -62,25 +62,25 @@ Users do not require any permission to apply to a corporation and fill out the f
|
||||
|
||||
A user with `auth.human_resources` can only see applications to their own corp.
|
||||
|
||||
Best practice is to bundle the `auth.human_resources` permission alongside the `hrapplications.approve_application` and `hrapplications.reject_application` permissions, as in isolation these don't make much sense.
|
||||
Best practice is to bundle the `auth.human_resources` permission alongside the `hrapplications.approve_application` and `hrapplications.reject_application` permissions, as in isolation these make little sense.
|
||||
|
||||
## Models
|
||||
|
||||
### ApplicationQuestion
|
||||
|
||||
This is the model representation of a question. It contains a title, and a field for optional "helper" text. It is referenced by ApplicationForm models but acts independently. Modifying the question after it has been created will not void responses, so it's not advisable to edit the title or the answers may not make sense to reviewers.
|
||||
This is the model representation of a question. It contains a title and a field for optional "helper" text. It is referenced by ApplicationForm models but acts independently. Modifying the question after it has been created will not void responses, so it's not advisable to edit the title or the answers may not make sense to reviewers.
|
||||
|
||||
### ApplicationForm
|
||||
|
||||
This is the template for an application. It points at a Corporation, with only one form allowed per Corporation. It also points at ApplicationQuestion models. When a user creates an application, they will be prompted with each question the form includes at the given time. Modifying questions in a form after it has been created will not be reflected in existing applications, so it's perfectly fine to adjust them as you see fit. Changing Corporations however is not advisable, as existing applications will point at the wrong Corporation after they've been submitted, confusing reviewers.
|
||||
This is the template for an application. It points at a Corporation, with only one form allowed per Corporation. It also points at ApplicationQuestion models. When a user creates an application, they will be prompted with each question the form includes at the given time. Modifying questions in a form after it has been created will not be reflected in existing applications, so it's perfectly fine to adjust them as you see fit. Changing corporations, however, is not advisable, as existing applications will point at the wrong Corporation after they've been submitted, confusing reviewers.
|
||||
|
||||
### Application
|
||||
|
||||
This is the model representation of a completed application. It references an ApplicationForm from which it was spawned which is where the Corporation specificity comes from. It points at a user, contains info regarding its reviewer, and has a status. Shortcut properties also provide the applicant's main character, the applicant's APIs, and a string representation of the reviewer (for cases when the reviewer doesn't have a main character or the model gets deleted).
|
||||
This is the model representation of a completed application. It references an ApplicationForm from which it was spawned, which is where the Corporation specificity comes from. It points at a user, contains info regarding its reviewer, and has a status. Shortcut properties also provide the applicant's main character, the applicant's APIs, and a string representation of the reviewer (for cases when the reviewer doesn't have a main character or the model gets deleted).
|
||||
|
||||
### ApplicationResponse
|
||||
|
||||
This is an answer to a question. It points at the Application to which it belongs, to the ApplicationQuestion which it is answering, and contains the answer text. Modifying any of these fields in dangerous.
|
||||
This is an answer to a question. It points at the Application to which it belongs, to the ApplicationQuestion which it is answering, and contains the answer text. Modifying any of these fields is dangerous.
|
||||
|
||||
### ApplicationComment
|
||||
|
||||
@@ -90,8 +90,8 @@ This is a reviewer's comment on an application. Points at the application, point
|
||||
|
||||
### No corps accepting applications
|
||||
|
||||
Ensure there are ApplicationForm models in the admin site. Ensure the user does not already have an application to these Corporations. If the users wishes to re-apply they must first delete their completed application
|
||||
Ensure there are ApplicationForm models in the admin site. Ensure the user does not already have an application to these Corporations. If the users wish to re-apply, they must first delete their completed application
|
||||
|
||||
### Reviewer unable to complete application
|
||||
|
||||
Reviewers require a permission for each of the three possible outcomes of an application, Approve Reject or Delete. Any user with the human resources permission can mark an application as in-progress, but if they lack these permissions then the application will get stuck. Either grant the user the required permissions or change the assigned reviewer in the admin site. Best practice is to bundle the `auth.human_resources` permission alongside the `hrapplications.approve_application` and `hrapplications.reject_application` permissions, as in isolation these don't serve much purpose.
|
||||
Reviewers require permission for each of the three possible outcomes of an application, Approve Reject or Delete. Any user with the human resources permission can mark an application as in-progress, but if they lack these permissions, then the application will get stuck. Either grant the user the required permissions or change the assigned reviewer in the admin site. Best practice is to bundle the `auth.human_resources` permission alongside the `hrapplications.approve_application` and `hrapplications.reject_application` permissions, as in isolation these serve little purpose.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Apps
|
||||
|
||||
**Alliance Auth** comes with a set of apps (also called plugin-apps) which provide basic functions useful to many organizations in Eve Online like a fleet schedule and a timerboard. This section describes which apps are available and how to install and use them. Please note that any app need to be installed before it can be used.
|
||||
**Alliance Auth** comes with a set of apps (also called plugin-apps) which provide basic functions useful to many organizations in Eve Online like a fleet schedule and a timerboard. This section describes which apps are available and how to install and use them. Please note that any app needs to be installed before it can be used.
|
||||
|
||||
:::{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Permissions Auditing
|
||||
|
||||
Access to most of Alliance Auth's features are controlled by Django's permissions system. In order to help you secure your services, Alliance Auth provides a permissions auditing tool.
|
||||
Access to most of Alliance Auth's features is controlled by Django's permissions system. To help you secure your services, Alliance Auth provides a permission auditing tool.
|
||||
|
||||
This is an optional app that needs to be installed.
|
||||
|
||||
@@ -10,9 +10,9 @@ To install it add `'allianceauth.permissions_tool',` to your `INSTALLED_APPS` li
|
||||
|
||||
### Access
|
||||
|
||||
In order to grant users access to the permissions auditing tool they will need to be granted the `permissions_tool.audit_permissions` permission or be a superuser.
|
||||
To grant users access to the permission auditing tool, they will need to be granted the `permissions_tool.audit_permissions` permission or be a superuser.
|
||||
|
||||
When a user has access to the tool they will see the "Permissions Audit" menu item under the "Util" sub menu.
|
||||
When a user has access to the tool, they will see the "Permissions Audit" menu item.
|
||||
|
||||
### Permissions Overview
|
||||
|
||||
|
||||
Reference in New Issue
Block a user