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

Contributors page and contributors listed on each accelerator page should have pictures #42

Closed
mtran-affirma opened this issue May 5, 2022 · 5 comments · Fixed by #89
Assignees
Milestone

Comments

@mtran-affirma
Copy link
Collaborator

mtran-affirma commented May 5, 2022

pictures should be pulled in dynamically from github based on the contributor's github alias so that it is in sync with whichever photo they choose to upload (or not) for their Github account

Related to #36

we will need to create custom scripts that leverage the public github api to retrieve information about the contributors for the git repo for a delivery accelerator page, parse the JSON request, and display that information, filtering out the following bot accounts:
microsoft-github-operations[bot]
microsoftopensource
dependabot[bot]

@mtran-affirma mtran-affirma changed the title Contributors page and contributors listed one each accelerator page should have pictures Contributors page and contributors listed on each accelerator page should have pictures May 10, 2022
@mtran-affirma mtran-affirma added this to the V1 milestone May 10, 2022
@mtran-affirma mtran-affirma changed the title Contributors page and contributors listed on each accelerator page should have pictures (pendingInfo) Contributors page and contributors listed on each accelerator page should have pictures May 19, 2022
@mtran-affirma
Copy link
Collaborator Author

pending #25

@mtran-affirma
Copy link
Collaborator Author

mtran-affirma commented Jun 3, 2022

hi @bmirza-affirma , assigning to you!

we will need to compile a script to retrieve the list of contributors from within the context of the github pages site we created.

this api example does give us the api url for retrieving information about github users such as a link to their profile! so we could use this to link on the Contributor's page, and also try to retrieve the location of the user's display picture to display on the page dynamically - this script could be shared and used in the individual accelerator pages as well to link and show information about the contributors):
image

@mtran-affirma mtran-affirma changed the title (pendingInfo) Contributors page and contributors listed on each accelerator page should have pictures Contributors page and contributors listed on each accelerator page should have pictures Jun 3, 2022
@mtran-affirma mtran-affirma removed their assignment Jun 7, 2022
@WillieAhlers1
Copy link
Collaborator

WillieAhlers1 commented Jun 7, 2022

@mtran-affirma , @Jbetts05 has a working script (python) that can be translated to javascript, to extract the required information
image

@Jbetts05
Copy link
Collaborator

Jbetts05 commented Jun 8, 2022

@mtran-affirma, @WillieAhlers1 Hi both, see attached the script- we decided to use a 'topic' for each repo called 'dstoolkit'. The api call retrieves all microsoft repos with the topic:dstoolkit and for each repo retrieves its contributors. Then it filters out the bot accounts and creates 3 json files:

  • user_profiles.json: user name and profile image url
  • contributors_per_repo.json: repo name and contributors
  • unique_contributors.json: contributors

it seems we can't access repos when they are private, I've added the dstoolkit topic to forecasting so once the repo is published the script should then be able to pick that up
[github_api.zip]

@mtran-affirma
Copy link
Collaborator Author

mtran-affirma commented Jun 8, 2022

hi @Jbetts05 @WillieAhlers1 , thank you for sharing your prototype scripts for the functionality! This helps us with examples for the specific API calls used to retrieve information about repos and contributors.

@bmirza-affirma fyi

update: After more discovery, we will be leveraging the dstoolkit tag after all since we don't have a database here and leveraging the tag on the git repos is more maintainable than needing to maintain a static list within code! (The only potential issue here is if someone incorrectly tags their own git repo with the topic "dstoolkit" and their contributors suddenly show up on our website - hopefully not something that would occur but fyi that it's technically possible.)

@mtran-affirma mtran-affirma linked a pull request Jun 9, 2022 that will close this issue
mtran-affirma added a commit that referenced this issue Jun 14, 2022
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

Successfully merging a pull request may close this issue.

4 participants