Open danieltott opened 3 years ago
Here from VC to start working on this issue!
Just some additional info on the github token if you're regenerating the member data: the token only needs permission for the user => read:user scope to function for this task 👇🏻
Thanks @shiftyp! - I updated the issue description with that ❤️
Hey @danieltott,
To make it smoother for our new members in adding their profile to our member page, we might want give the link to the members/members/_EXAMPLE.ts
.
We can, for example, do:
yourusername.ts
Thanks @adiati98! Just updated it!
@danieltott @BekahHW FYI, me and @dominicduffin1 found that this issue is closed with the changes in PR #920. We might want to reopen this issue and give clarification not to use closes, fixes, etc. when creating PR to prevent closing this issue.
Thank you! 😄
The best part of Virtual Coffee is our members ❤️
In order to showcase our collective awesomeness, let's put together a members page!
Members will individually add their GitHub username. At build time, we'll pull down their GitHub profile and display their info on a page located at /members.
This is the first iteration of this feature, so we'll add features to it as we go.
Note - only PRs from existing Virtual Coffee members will be accepted
Attending one of our Virtual Coffee events is the best way to learn how to become a member.
Adding yourself to the members page:
GitHub Profile Information
Members can edit their GitHub profile at https://github.com/settings/profile
virtualcoffee.io will only ever have access to the public profile information, never anything private.
Info we'll use to build the members page:
Before you submit a PR, take a moment and check out this information to make sure it's accurate and you feel comfortable displaying it on our site!
How to add or update your profile:
The steps below involve your GitHub username. For each of the steps below, replace
yourusername
with your actual GitHub username (mine isdanieltott
for example).members/yourusername
members/members/_EXAMPLE.ts
and name ityourusername.ts
virtual-coffee
, we'd want to change that tovirtualcoffee.ts
for the file name, and for the export name in the next step._EXAMPLE
on line 4 with your github usernamegithub
value to your username, and follow the comments in the file to customize any additional parts of your VC profilemembers/members/yourusername.ts
At this point, the pull request will create a Deploy Preview that you can use to preview your changes.
If you'd like to try updating the data on your own, here are the steps you can follow, but it's not required.
.env
and copy the contents from.env.example
. Then, uncomment theGITHUB_TOKEN
line, and replaceyourtoken
with your token created in the previous step.yarn start
to preview your changes!And you're done!
Our Contributing Guide has a lot of information about getting started with GitHub and Pull Requests, so you might want to take a look at that as well if you are new to this process.
Please feel free to add any questions here in the comments!