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

chore: add roadmap link in the footer #2291

Merged
merged 5 commits into from
Oct 10, 2024

Conversation

harshsbhat
Copy link
Contributor

@harshsbhat harshsbhat commented Oct 9, 2024

What does this PR do?

image

Fixes #2288

Adds a roadmap link in the footer which redirects to www.unkey.com/roadmap and then https://github.com/unkeyed/unkey/discussions/categories/roadmap similar to discord.

#2281 probably did not run pnpm fmt that's why the extra changes in plain and feedback component.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Scroll down to the footer and click on the roadmap it should open the GitHub discussions in a new tab.

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Updated error message in the Feedback component for clarity.
    • Added a "Roadmap" navigation link in the footer for easy access to the roadmap discussions.
    • Introduced a redirect function to guide users to the GitHub discussions page for the roadmap.
  • Bug Fixes

    • Enhanced transaction handling and error management across various API functionalities, improving overall reliability and user experience.

Copy link

changeset-bot bot commented Oct 9, 2024

⚠️ No Changeset found

Latest commit: 46207a5

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

Copy link

vercel bot commented Oct 9, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 9, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request include modifications to the validation schema for the message field in the Feedback component and the createPlainIssue procedure, ensuring a minimum length requirement. A new file for the RoadmapRedirect function has been added, which redirects users to the roadmap discussions on GitHub. Additionally, a new link to the roadmap has been incorporated into the footer navigation of the website.

Changes

File Path Change Summary
apps/dashboard/components/dashboard/feedback-component.tsx Updated validation schema for message field in Feedback component to use double quotes.
apps/dashboard/lib/trpc/routers/plain.ts Condensed input validation schema for createPlainIssue procedure, maintaining existing logic.
apps/www/app/roadmap/page.tsx Added new file exporting RoadmapRedirect function for user redirection to GitHub discussions.
apps/www/components/footer/footer.tsx Added "Roadmap" link to the footer navigation array, linking to "/roadmap".

Assessment against linked issues

Objective Addressed Explanation
Add a link to the roadmap in the footer. (#2288)
Redirect users to the roadmap discussions. (#2288)

Possibly related PRs

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e199faf and 9cd122e.

📒 Files selected for processing (1)
  • apps/www/components/footer/footer.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/www/components/footer/footer.tsx

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
🪧 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.

Copy link

vercel bot commented Oct 9, 2024

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 5:35pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 5:35pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 5:35pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 5:35pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 5:35pm

Copy link
Contributor

github-actions bot commented Oct 9, 2024

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
apps/www/components/footer/footer.tsx (1)

16-16: LGTM! Consider adding an external flag for consistency.

The addition of the "Roadmap" link in the footer navigation aligns perfectly with the PR objectives. The implementation is correct and consistent with the existing code structure.

For improved consistency with other external links in the navigation array, consider adding the external: true property to the "Roadmap" link. This would ensure that the link opens in a new tab, which is typically desirable for roadmap links that lead to external pages. Here's a suggested modification:

-      { title: "Roadmap", href: "/roadmap" },
+      { title: "Roadmap", href: "/roadmap", external: true },

This change would make the behavior consistent with other external links in the footer and improve user experience.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b68e117 and e199faf.

📒 Files selected for processing (4)
  • apps/dashboard/components/dashboard/feedback-component.tsx (1 hunks)
  • apps/dashboard/lib/trpc/routers/plain.ts (1 hunks)
  • apps/www/app/roadmap/page.tsx (1 hunks)
  • apps/www/components/footer/footer.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • apps/dashboard/components/dashboard/feedback-component.tsx
  • apps/dashboard/lib/trpc/routers/plain.ts
🧰 Additional context used
🔇 Additional comments (4)
apps/www/app/roadmap/page.tsx (4)

1-1: LGTM: Correct import for Next.js navigation.

The import statement is correct and appropriate for the intended functionality in a Next.js application.


3-5: LGTM: Correct implementation of the redirect function.

The RoadmapRedirect function is implemented correctly:

  • It's exported as default, which is appropriate for Next.js page components.
  • The function name clearly describes its purpose.
  • The implementation is simple and straightforward, which is suitable for a redirect page.

4-4: Verified: Correct redirect URL.

The redirect URL "https://github.com/unkeyed/unkey/discussions/categories/roadmap" matches the specifications in the PR objectives and correctly points to the GitHub discussions page for the roadmap.


1-5: Overall assessment: Excellent implementation of the roadmap redirect.

This file successfully implements the roadmap redirect functionality as requested in the PR objectives. The code is concise, follows Next.js best practices, and correctly redirects users to the specified GitHub discussions page for the roadmap. Great job!

@Pa04rth
Copy link

Pa04rth commented Oct 10, 2024

/assign

@oss-gg oss-gg bot assigned Pa04rth Oct 10, 2024
Copy link

oss-gg bot commented Oct 10, 2024

Assigned to @Pa04rth! Please open a draft PR linking this issue within 48h ⚠️ If we can't detect a PR from you linking this issue in 48h, you'll be unassigned automatically 🕹️ Excited to have you ship this 🚀

@Madan1500
Copy link

/assign

Copy link

oss-gg bot commented Oct 10, 2024

This issue is already assigned to another person. Please find more issues here.

1 similar comment
Copy link

oss-gg bot commented Oct 10, 2024

This issue is already assigned to another person. Please find more issues here.

apps/www/components/footer/footer.tsx Outdated Show resolved Hide resolved
@mcstepp mcstepp assigned mcstepp and unassigned Pa04rth Oct 10, 2024
@harshsbhat
Copy link
Contributor Author

@mcstepp DONE

Copy link
Collaborator

@mcstepp mcstepp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@mcstepp
Copy link
Collaborator

mcstepp commented Oct 10, 2024

/award 150

Copy link

oss-gg bot commented Oct 10, 2024

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

Copy link

oss-gg bot commented Oct 10, 2024

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

AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 14, 2024
* removed the wrong commits pushed with this PR

* adding roadmap after other info

---------

Co-authored-by: Meg Stepp <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Link To Roadmap to WWW Footer
5 participants