chore: Side Quest - Record your onboarding and first steps with Unkey

[aritradevelops]

Description

I have recorded myself going through the onboarding process and setup of an Unkey account, as well as integrating it into my app.

Video Link: Click Here

I recommend watching it at 1.25x or 1.5x speed.

What's Covered in the Video

Onboarding

1. Going through the landing page and discussing my understanding of the product from the landing page.
2. Signing up and going through the onboarding process.
3. Creating APIs, Permissions, Roles, and Keys.
4. Assigning permissions to roles.
5. Testing key verification.
6. Trying rate limiting (failed; I'll update the PR description if I find the cause, as I may have done something incorrectly).

Integration in My App

1. Generating keys for the API users with roles.
2. Verifying the keys and extracting roles from the payload.
3. Trying rate limiting (failed; I'll update the PR description if I find the cause, as I may have done something incorrectly).

My Observations

First of all, I just want to say it's a really amazing product. It covers all the requirements to manage public APIs. Now, for the issues I encountered:

1. I encountered issue Client-side Exception on "Add Existing Permissions" Focus in Create New Role Dialog #2319.
2. I encountered issue [oss.gg hackathon] Disabling key does not work #2587
3. There is some inconsistency regarding the Key's Owner Id attribute in the API documentation and the SDK.
   • The SDK still accepts ownerId, but the API documentation indicates that it is deprecated.
   
4. I have added this feature request [oss.gg hackathon] Feature Request - Provision for creating / importing multiple permissions at once. #2585.
5. I wish the Enable Key checkbox under the Keys Settings page would update on toggle without requiring the save button. I understand that this might affect UI consistency on that page, so it's up to you.

Summary by CodeRabbit

• New Features
  • Updated the onboarding document to include a new submission entry.
  • Added a new contributor entry for "aritradevelops" dated "27-October-2024."
  • Retained the previous entry by "Teddy ASSIH" dated "10-October-2024."

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1948323

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 27, 2024 3:15pm

[vercel]

@aritradevelops is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

📝 Walkthrough

Walkthrough

The document oss.gg/6_record_onboarding.md has been updated to include a new entry under the "Your turn" section, which reflects a new submission date and contributor. The previous entry by "Teddy ASSIH" dated "10-October-2024" remains unchanged, while a new entry for "aritradevelops" dated "27-October-2024" has been added. No other content or structural changes were made to the document.

Changes

File	Change Summary
oss.gg/6_record_onboarding.md	- Added new entry: » 27-October-2024 by aritradevelops
	- Retained existing entry: » 10-October-2024 by Teddy ASSIH

Possibly related issues

• [🕹️] Record your onboarding and first steps with Unkey #2248: This issue encourages recording onboarding experiences, which aligns with the updates made in the onboarding record document.
• [oss.gg hackathon] -- Side Quest: Record your onboarding and first steps wit Unkey #2559: This issue involves recording onboarding experiences as well, relevant to the new entries in the onboarding document.

Possibly related PRs

• feat: [🕹️] Record your onboarding and first steps with Unkey  #2301: This PR updates the same document (oss.gg/6_record_onboarding.md) and modifies entries related to the onboarding process.
• oss.gg side quest 3_follow_the_unkey_x_account.md #2399: This PR updates another document (oss.gg/3_follow_the_unkey_x_account.md) with a new entry for a user participating in a similar side quest.

Suggested labels

Needs Approval, 🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

• mcstepp
• chronark
• perkinsjr
• MichaelUnkey

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ca805ac and 1948323.

📒 Files selected for processing (1)

• oss.gg/6_record_onboarding.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• oss.gg/6_record_onboarding.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[chronark]

Thanks
/award 300

[oss-gg]

Awarding aritradevelops: 300 points 🕹️ Well done! Check out your new contribution on oss.gg/aritradevelops