Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to User Profile instead of email #54

Closed
emptymalei opened this issue Sep 5, 2021 · 1 comment
Closed

Link to User Profile instead of email #54

emptymalei opened this issue Sep 5, 2021 · 1 comment

Comments

@emptymalei
Copy link

Thank you for making such a useful plugin.

I am wondering if it is useful to provide an option to link to the user profile (e.g., GitHub profile) instead of email?

For example, return

[
    {
    'name' : 'Jane Doe',
    'email' : '[email protected]',
    'profile': 'https://github.com/jane',
    'last_datetime' : datetime.datetime(),
    'lines' : 200,
    'contribution' : '40.0%'
  }
]

Thanks.

@timvink
Copy link
Owner

timvink commented Sep 8, 2021

Yeah it would be, but it's not as straightforward as it might seem.

Some challenges:

  • profile could also be github, gitlab, bitbucket, azure devops, etc.
  • from the git commit logs, we can only find the name and email address. however, many users don't share their email publicly (including me), which means we cannot use the github API to find the profile. We could use name to search the github users api, but that does not guarantee a correct result.
  • We would need to make API calls, which means mkdocs build should have access to the internet. That's not always the case (f.e. when working behind a company proxy).

A more detailed analysis can be found in #15

Because there is not an elegant solution design for this, I don't want to pick this up now..

@timvink timvink closed this as completed Sep 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants