console icon indicating copy to clipboard operation
console copied to clipboard

🐛 Fix: Docs button in create sites repositories section #2300

Open AryanBagade opened this issue 4 months ago • 2 comments

What does this PR do?

This PR fixes a broken "Docs" button in the Sites creation flow. The button in the "Missing a repository?" section had href="#" which created a broken link that didn't navigate anywhere.

Changes made:

  • Updated the docs button to link to the correct GitHub App configuration documentation
  • Added external prop to both docs and GitHub buttons for security and UX best practices
  • The link now points to: https://appwrite.io/docs/advanced/self-hosting/sites#configure-github-app

This specifically addresses the scenario described in the tooltip - helping users configure GitHub App permissions when repositories are missing.

Test Plan

Manual Testing:

  1. Navigate to Sites → Create Site → Connect a repository
  2. Look at the right sidebar "Missing a repository?" section
  3. Click the "Docs" button - now opens the correct documentation in a new tab
  4. Click the "Go to GitHub" button - also opens in new tab with proper security attributes

Automated Testing:

  • ✅ All tests pass: 211/211 tests successful
  • ✅ No linting errors: 0 errors, 0 warnings
  • ✅ Code formatting: Applied with pnpm run format
  • ✅ Diagnostics: Passed pnpm run check with no issues

Code Quality:

  • Follows existing code conventions
  • Added proper external prop for security (target="_blank" + rel="noopener noreferrer")
  • Maintains consistent styling and structure

Related PRs and Issues

  • Fixes appwrite/appwrite#2300 (Console repo issue)
  • References appwrite/console#2356 (Original issue reported in main repo)

This is a cross-repo fix - the issue was originally reported in the main appwrite repo but the fix belongs in the console frontend repo.

Have you read the Contributing Guidelines on issues?

Yes, I have read and followed the Contributing Guidelines:

  • ✅ Followed proper branch naming convention: fix-docs-button-create-sites
  • ✅ Ran all required checks: format, tests, and diagnostics
  • ✅ Used proper commit message format with issue references
  • ✅ Created corresponding issue in console repo before submitting PR
  • ✅ Followed code quality standards and existing patterns
  • ✅ Added proper security attributes for external links

Closes appwrite/appwrite#2300

Summary by CodeRabbit

  • New Features
    • Docs and Go to GitHub buttons now open externally, improving navigation and preventing context loss during site setup.
  • Documentation
    • Updated the Docs button to link directly to the self-hosting Sites configuration guide, replacing the placeholder link for clearer guidance.
    • Ensures users can quickly access the correct external resources without leaving the wizard unintentionally.

AryanBagade avatar Sep 02 '25 07:09 AryanBagade