Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-12-18 23:05:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update CorpStats documentation.

Browse Source 
Internalize all doc images.
This commit is contained in:
Adarnof
2017-06-08 20:48:44 -04:00
parent fd8ab2688e
commit 0deb60ac2c
16 changed files with 33 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/features/corpstats.md
View File

@@ -29,13 +29,7 @@ If it fails an error message will be displayed.
This bar contains a dropdown menu of all available corps. If the user has the `add_corpstats` permission, a button to add a Corp Stats will be shown.
On the right of this bar is a search field. Press enter to search. It checks all characters in all Corp Stats you have view permission to and returns search results. Generic searches (such as 'a') will be slow.
### Registration Index
![Registration Index](/_static/images/features/corpstats/api_index.png)
This is a visual indication of the number of registered characters.
On the right of this bar is a search field. Press enter to search. It checks all characters in all Corp Stats you have view permission to and returns search results.
### Last Update
@@ -45,17 +39,38 @@ Corp Stats automatically update every 6 hours. An update can be performed immedi
Only superusers and the creator of the Corp Stat can trigger an immediate update.
### Member List
### Character Lists
![lists](/_static/images/features/corpstats/lists.png)
Three views are available:
- main characters and their alts
- registered characters and their main character
- unregistered characters
Each view contains a sortable and searchable table. The number of listings shown can be increased with a dropdown selector. Pages can be changed using the controls on the bottom-right of the table. Each list is searchable at the top-right. Tables can be re-ordered by clicking on column headings.
![table control locations](/_static/images/features/corpstats/table_controls.png)
#### Main List
![main list](/_static/images/features/corpstats/main_list.png)
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).
#### Member List
![member list](/_static/images/features/corpstats/member_list.png)
The list contains all characters in the corp. Red backgrounds means they are not registered in auth. If registered, and the user has the required permission to view APIs, a link to JackKnife will be present.
A link to zKillboard is present for all characters.
The list contains all characters in the corp. Red backgrounds means 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.
This view is paginated: use the navigation arrows to view more pages (sorted alphabetically by character name), or search for a specific character.
#### Unregistered List
![pagination buttons](/_static/images/features/corpstats/pagination.png)
![unregistered_list](/_static/images/features/corpstats/unregistered_list.png)
This list contains all characters not registered on auth. Each character has a link to [zKillboard](https://zkillboard.com).
## Search View
@@ -65,7 +80,6 @@ This view is essentially the same as the Corp Stats page, but not specific to a
The search query is visible in the search box.
Characters from all Corp Stats to which the user has view access will be displayed. APIs respect permissions.
This view is paginated: use the navigation arrows to view more pages (sorted alphabetically by character name).
## Permissions

4
docs/features/permissions_tool.md
View File

@@ -18,7 +18,7 @@ When a user has access to the tool they will see the "Permissions Audit" menu it
The first page gives you a general overview of permissions and how many users have access to each permission.
![permissions overview](https://i.imgur.com/XALVFtc.png)
![permissions overview](/_static/images/features/permissions_tool/overview.png)
**App**, **Model** and **Code Name** contain the internal details of the permission while **Name** contains the name/description you'll see in the admin panel.
@@ -34,6 +34,6 @@ Clicking on the **Code Name** link will take you to the [Permissions Audit Page]
The permissions audit page will give you an overview of all the users who have access to this permission either directly or granted via group membership.
![permissions audit](https://i.imgur.com/XjnfC9Z.png)
![permissions audit](/_static/images/features/permissions_tool/audit.png)
Please note that users may appear multiple times if this permission is granted via multiple sources.