Orbit

Orbit User Guides

Check out these guides and resources for getting the most out of Orbit. Email [email protected] with any questions or feedback. Let's jump right in!

Get Started    API Reference

Member profile page

This guide will dive deep into the different areas of the member profile page and share some ideas about how to use each feature.

Overview

The member profile page provides the single view of a community member and includes several types of data, including social bios, company, interests, activity in your community, and even data like preferred pronoun and t-shirt size.

First, we'll walk through the main profiles sections and the Timeline view, then look at the Detail view below.

A screenshot of a member profile page, with 11 sections annotated.

  1. Bio info
    • automatically pulled from GitHub, Clearbit, and Twitter
  2. Orbit Model metrics
    • Orbit automatically tracks the Orbit Level, Love, Reach, and Points for each member
    • click Edit to change the Orbit level
  3. Edit the member's bio info and Orbit Level
  4. Merge multiple members
    • Merging profiles will combine timelines and tags into a single profile
  5. Timeline of your member's experience
    • This includes automatically generated activities from our GitHub and Twitter integrations, activities from the Orbit API, notes you have added, and content you've saved to the profile
  6. Manually add an activity to the timeline

A screenshot of the manual activity creation form.

Read more about manual activity creation

  1. Save a note about this member
    • notes will also appear in the Activity view
  2. Save tweets, videos, blog posts and more
  3. Filter the timeline
  4. Add tags
    • Just click "Add tags," or hit "t" on your keyboard, to add tags to any member's profile. You can also add tags via the API.
  5. Topics and languages are added automatically based on the member's GitHub username

Now we'll explore the Detail view of the member profile:

A screenshot of a member detail view, with 7 sections annotated.

  1. Key dates are saved automatically by Orbit
  2. Pronouns, birthday, and swag info are manually entered or added via the API
  3. Activity in your repos
    • a count of Activities completed in your repos as well as a list of the repos the member has been active on
  4. Orbit Model stats are generated automatically
  5. The member's general activity on all of GitHub
  6. A list of the member's pinned repos
  7. A list of repos they have contributed to

Adding tags

Just click "Add tags," or hit "t" on your keyboard, to add tags to any member's profile. You can also add tags via the API.

A screenshot of the tags section of a members profile.

Tip: You can filter the Member's page by tags. When tags are applied, search results will be constrained only to tagged members:

A screenshot highlighting the tags select on the members page.

Tracking contextual and relationship info with Orbit

There are several ways to track important details about your relationship with a community.

📘

Icons will indicate when a user's profile has contextual info attached:

An example of icons and tags in the members page. The tags read: Teammate, DevRel, Paris

New contextual info will also appear in a member's activity feed:

Notes

You can add free-form notes to anyone in your workspace:

💡 How to use notes

  • add notes from meetings, emails, or DMs so others on your team will have visibility
  • include key points about the member's activity, like "Hosts the JAMStack Paris meetup" or "is a core maintainer on Next.js"
  • New notes will appear in your workspace Activity feed

An example of a note added to a member. the note reads: “Had a nice call with REDACTED today. He’s currently on the job and looking forward to bringing Orbit into wherever he lands. Said he’s a big fan of our blog content.”


Content

For many teams, it's important to keep track of relevant content generated by community members. The Content tab allows you to paste-in URLs of relevant content to save for future reference.

💡 How to use Content

  • when someone tweets about your product or community, add the tweet to the member's profile
  • same thing for blog posts
  • New content will appear in your workspace Activity feed

A screenshot showing attached content, here an article posted on dev.to

Delete / block members

Sometimes you'll want to remove members from your workspace. They might be company accounts who have mentioned you on Twitter, GitHub bots that create a lot of noise, or maybe the person is just spammy.

To delete a member, navigate to their Member Profile, click the Delete icon and confirm.

The Delete button is under the member overview section in the left panel.

When deleting a member, you have the option to block their identities. A blocked member will not get re-created if, for example, they mention your account or again, and will not influence calculated metrics like Love and Activities. This prevention of re-creating the member is based on the specific GitHub handle, Twitter handle, and/or email address attached to their profile (the identity). If members or activities are created in the future with any of the identities of the deleted member, they will be rejected.

For teammates

To keep track of teammates but to hide them from the default views on most pages - e.g. Members, Activities, Reports, and Search - edit their profile as and select Teammate for the affiliation radio button.

The affiliation can be toggled between Member and Teammate with a radio button.

📘

Tip: You can still see teammates on those pages by changing the filters near the top.

Updated about a month ago


Member profile page


This guide will dive deep into the different areas of the member profile page and share some ideas about how to use each feature.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.