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

docs: fix useResource example & remove unused demo #6893

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

ianlet
Copy link
Contributor

@ianlet ianlet commented Sep 21, 2024

What is it?

  • Feature / enhancement
  • Bug
  • Docs / tests / types / typos
  • Infra

Description

Fixes https://github.com/orgs/QwikDev/projects/1/views/2?pane=issue&itemId=72272653

The previous useResource example was using the github api, which might get rate limited. Instead, the example now uses a free fake and stable API. Potential errors are also caught in order to avoid other issues.

In addition, this PR deletes the unused demo demo/tasks/resource

Note: the error mentioned in the issue doesn't actually happen in local. So this is a bit of a wild guess as to why it might fail in production.

Checklist:

  • My code follows the developer guidelines of this project
  • I have performed a self-review of my own code
  • I have ran pnpm change and documented my changes
  • I have made corresponding changes to the Qwik docs
  • Added new tests to cover the fix / functionality

@ianlet ianlet requested review from a team as code owners September 21, 2024 15:58
Copy link

changeset-bot bot commented Sep 21, 2024

🦋 Changeset detected

Latest commit: 278695a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@builder.io/qwik Patch
eslint-plugin-qwik Patch
@builder.io/qwik-city Patch
create-qwik Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

github-actions bot commented Sep 21, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
qwik-docs ✅ Ready (View Log) Visit Preview 278695a

@ianlet ianlet force-pushed the docs-fix-useresource branch 2 times, most recently from 32556f5 to 987d6b9 Compare October 6, 2024 20:59
* Replace github API call with a free fake & reliable API
* Wrap API call in try/catch to prevent future error 500
@ianlet ianlet mentioned this pull request Oct 7, 2024
9 tasks
Copy link
Contributor

@shairez shairez left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks @ianlet ! 🙏

@shairez shairez merged commit 97ed226 into QwikDev:main Oct 22, 2024
14 checks passed
@github-actions github-actions bot mentioned this pull request Oct 22, 2024
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