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

Add your profile to our Members Page! #13

Open
danieltott opened this issue Oct 1, 2020 · 6 comments · Fixed by #920
Open

Add your profile to our Members Page! #13

danieltott opened this issue Oct 1, 2020 · 6 comments · Fixed by #920
Assignees
Labels
Issue for Full Member For full members who have attended a coffee session, filled out the new member for, and are in slack Members Page A PR adding a user to the Members page

Comments

@danieltott
Copy link
Member

danieltott commented Oct 1, 2020

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:

  • Name
  • Profile Picture
  • URL
  • Bio
  • Twitter Username

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 is danieltott for example).

  • Follow these steps to create a fork of this repository and clone it to your local machine.
  • Create a branch called members/yourusername
  • If you're adding your profile for the first time:
    • Create a copy of members/members/_EXAMPLE.ts and name it yourusername.ts
    • NOTE: for the file name and export name, please remove any dashes in your username. You can replace them with underscores or just remove them entirely. For example, if my username was virtual-coffee, we'd want to change that to virtualcoffee.ts for the file name, and for the export name in the next step.
    • Replace _EXAMPLE on line 4 with your github username
      - export const _EXAMPLE: MemberObject = {
      + export const yourusername: MemberObject = {
    • Update the github value to your username, and follow the comments in the file to customize any additional parts of your VC profile
    • Note - if you already have the local version running, you'll need to stop the server and restart it to see the new file.
    • Commit the new file
  • If you're already on the page but would like to update your profile:
    • Find members/members/yourusername.ts
    • Inside you will find the file all set up, follow the comments in the file to update any data you'd like
    • Commit the modified file
  • Push your branch up to your fork
  • Create a Pull Request and link to this issue

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.

  • To test locally, follow the Local Development steps listed in our README
  • After the site is installed, you'll need to follow these directions to create a Personal Access Token.
    • The token only needs permission for the user => read:user scope to function for this task:
      Screen shot of scopes form
  • Once you have your token, create a new file called .env and copy the contents from .env.example. Then, uncomment the GITHUB_TOKEN line, and replace yourtoken with your token created in the previous step.
  • Then run yarn start to preview your changes!
  • Again, these steps are not required for the PR to be accepted

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!

@danieltott danieltott added the Status: Needs Revision Needs editing before acceptance label Oct 1, 2020
@danieltott danieltott self-assigned this Oct 1, 2020
@danieltott danieltott added the Members Page A PR adding a user to the Members page label Oct 1, 2020
kierblk pushed a commit to kierblk/virtualcoffee.io that referenced this issue Oct 1, 2020
@BekahHW BekahHW mentioned this issue Oct 1, 2020
@danieltott danieltott removed the Status: Needs Revision Needs editing before acceptance label Oct 1, 2020
@Cerchie
Copy link
Sponsor Contributor

Cerchie commented Oct 1, 2020

Here from VC to start working on this issue!

@danieltott danieltott pinned this issue Oct 2, 2020
@danieltott danieltott changed the title Members Page Add yourself to our Members Page Oct 2, 2020
@adiati98

This comment was marked as resolved.

@danieltott danieltott reopened this Aug 25, 2023
@rishabh1S rishabh1S mentioned this issue Oct 2, 2023
danieltott pushed a commit that referenced this issue Oct 9, 2023
* add profile github ID to branch

* add profile information, prepare pull request

* Prettified Code!

* Remove badge and unnecessary spacing

* remove gps coordiante, save for next PR

* Prettified Code!

---------

Co-authored-by: iotalex <iotalex@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue for Full Member For full members who have attended a coffee session, filled out the new member for, and are in slack Members Page A PR adding a user to the Members page
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants