Skip to content

Commit

Permalink
Add a team report example using login aliases
Browse files Browse the repository at this point in the history
This use case has not been documented yet. Let's include at least
a simple example demonstrating how the login aliases work.
  • Loading branch information
psss committed Nov 28, 2023
1 parent 10e2cfc commit e91b752
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,31 @@ This allows to override the default value for individual stats::
See :class:`did.base.User` for detailed information about the
advanced email/login alias support.


Team
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When multiple email addresses are provided in the config file, a
team report can be easily created as well::

[general]
email =
Petr Šplíchal <[email protected]>; github:psss; gitlab:psssssss,
Lukáš Zachar <[email protected]>; github:lukaszachy

[github]
type = github
url = https://api.github.com/

[gitlab]
type = gitlab
url = https://gitlab.com

Note in the example above that if user logins to be used in the
search query are different from the email address prefix you need
to specify them explicitly.


Order
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit e91b752

Please sign in to comment.