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 "Edit this page on GitHub" functionality for UDR #2690

Merged
merged 3 commits into from
Feb 19, 2025

Conversation

im2nguyen
Copy link
Contributor

@im2nguyen im2nguyen commented Feb 19, 2025

🔗 Relevant links

This PR adds githubFileUrl to UDR, giving it feature parity with existing learn-api. We need to merge the companion api change in UDR that adds githubFile to the specific docs api.

🗒️ What

🤷 Why

🛠️ How

📸 Design Screenshots

🧪 Testing

  1. Checkout this PR and create a local image dev-portal:github-link.
  2. Checkout web-unified-docs PR, update docker-compose to use local dev-portal image instead of hashicorp/dev-portal.
  3. Start UDR with make.
  4. Go to http://localhost:3000/terraform/plugin/framework/resources and confirm "Edit this page on GitHub" at the bottom of the page.
  5. Click on link to confirm it takes you to the correct URL.
  6. Go to http://localhost:3000/terraform/plugin/framework/v0.11.x (different version), click "Edit this page on GitHub" and confirm that it takes you to the correct versioned URL.
image

💭 Anything else?

Copy link

vercel bot commented Feb 19, 2025

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

Name Status Preview Comments Updated (UTC)
dev-portal ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 19, 2025 6:11pm

Copy link

github-actions bot commented Feb 19, 2025

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

This PR introduced no changes to the javascript bundle 🙌

@im2nguyen im2nguyen requested review from a team, mikegolus and RubenSandwich and removed request for a team and mikegolus February 19, 2025 16:09
Copy link
Collaborator

@RubenSandwich RubenSandwich left a comment

Choose a reason for hiding this comment

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

🚢

@im2nguyen im2nguyen merged commit a224189 into main Feb 19, 2025
12 checks passed
@im2nguyen im2nguyen deleted the im2nguyen/udr-edit-page-github branch February 19, 2025 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants