Skip to content

Commit

Permalink
chore: Update links, docs, and other references (#2807)
Browse files Browse the repository at this point in the history
* Update links and references

* Update main readme

* Update codeowners file to appropriate team

* Update issue templates

* Update CODE_OF_CONDUCT.md
  • Loading branch information
kitten committed Nov 14, 2022
1 parent e7697fb commit 4d2cb17
Show file tree
Hide file tree
Showing 38 changed files with 152 additions and 170 deletions.
12 changes: 6 additions & 6 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
@@ -1,6 +1,6 @@
/.github/ @ryan-roemer @boygirl
/.changeset/config.json @ryan-roemer @boygirl
/scripts/actions/* @ryan-roemer @boygirl
/scripts/prepare/* @ryan-roemer @boygirl
/scripts/rollup/* @ryan-roemer @boygirl
/scripts/changesets/* @ryan-roemer @boygirl
/.github/ @urql-graphql/core
/.changeset/config.json @urql-graphql/core
/scripts/actions/* @urql-graphql/core
/scripts/prepare/* @urql-graphql/core
/scripts/rollup/* @urql-graphql/core
/scripts/changesets/* @urql-graphql/core
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Expand Up @@ -40,9 +40,9 @@ body:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: I can confirm that this is a bug report, and not a feature request, RFC, question, or discussion, for which [GitHub Discussions](https://github.com/FormidableLabs/urql/discussions) should be used
- label: I can confirm that this is a bug report, and not a feature request, RFC, question, or discussion, for which [GitHub Discussions](https://github.com/urql-graphql/urql/discussions) should be used
required: true
- label: Read the [docs](https://formidable.com/open-source/urql/docs/).
required: true
- label: Follow our [Code of Conduct](https://github.com/FormidableLabs/urql/blob/main/CODE_OF_CONDUCT.md)
- label: Follow our [Code of Conduct](https://github.com/urql-graphql/urql/blob/main/CODE_OF_CONDUCT.md)
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
@@ -1,6 +1,6 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
url: https://github.com/FormidableLabs/urql/discussions
url: https://github.com/urql-graphql/urql/discussions
about: Ask questions and discuss with other community members

6 changes: 3 additions & 3 deletions CODE_OF_CONDUCT.md
Expand Up @@ -57,9 +57,9 @@ further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team:

- lauren.eastridge@formidable.com
- phil.pluckthun@formidable.com
- Twitter DMs: @_philpl
- phil@0no.co
- grant.sander@formidable.com
- jovi@preact.dev

All complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
Expand Down
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Expand Up @@ -17,10 +17,10 @@ If you have an idea for a feature or want to fix a bug, consider opening an issu
first. We're also happy to discuss and help you open a PR and get your changes
in!

- If you have a question, try [creating a GitHub Discussions thread.](https://github.com/FormidableLabs/urql/discussions/new)
- If you think you've found a bug, [open a new issue.](https://github.com/FormidableLabs/urql/issues/new/choose)
- or, if you found a bug you'd like to fix, [open a PR.](https://github.com/FormidableLabs/urql/compare)
- If you'd like to propose a change [open an RFC issue.](https://github.com/FormidableLabs/urql/issues/new?labels=future+%F0%9F%94%AE&template=RFC.md&title=RFC%3A+Your+Proposal) You can read more about the RFC process [below](#how-do-i-propose-changes).
- If you have a question, try [creating a GitHub Discussions thread.](https://github.com/urql-graphql/urql/discussions/new)
- If you think you've found a bug, [open a new issue.](https://github.com/urql-graphql/urql/issues/new/choose)
- or, if you found a bug you'd like to fix, [open a PR.](https://github.com/urql-graphql/urql/compare)
- If you'd like to propose a change [open an RFC issue.](https://github.com/urql-graphql/urql/issues/new?labels=future+%F0%9F%94%AE&template=RFC.md&title=RFC%3A+Your+Proposal) You can read more about the RFC process [below](#how-do-i-propose-changes).

### What are the issue conventions?

Expand All @@ -35,9 +35,9 @@ or an undocumented quirk.
We follow an **RFC proposal process**. This allows anyone to propose a new feature or a change, and
allows us to communicate our current planned features or changes, so any technical discussion,
progress, or upcoming changes are always **documented transparently.** You can [find the RFC
template](https://github.com/FormidableLabs/urql/issues/new/choose) in our issue creator.
template](https://github.com/urql-graphql/urql/issues/new/choose) in our issue creator.

All RFCs are added to the [RFC Lifecycle board.](https://github.com/FormidableLabs/urql/projects/3)
All RFCs are added to the [RFC Lifecycle board.](https://github.com/urql-graphql/urql/projects/3)
This board tracks where an RFC stands and who's working on it until it's completed. Bugs and PRs may
end up on there too if no corresponding RFC exists or was necessary. RFCs are typically first added
to "In Discussion" until we believe they're ready to be worked on. This step may either be short,
Expand Down Expand Up @@ -248,5 +248,4 @@ Typically what we do is:

```sh
npm access grant read-write urql:developers [package]
npm access grant read-write formidable:formidable [package]
```
3 changes: 2 additions & 1 deletion LICENSE
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2018–2020 Formidable
Copyright (c) 2018–2020 Formidable,
Copyright (c) urql GraphQL Team and other contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
25 changes: 13 additions & 12 deletions README.md
Expand Up @@ -10,19 +10,16 @@

<br />
<br />
<a href="https://circleci.com/gh/FormidableLabs/urql">
<img alt="CI Status" src="https://github.com/FormidableLabs/urql/actions/workflows/ci.yml/badge.svg?branch=main" />
</a>
<a href="https://github.com/FormidableLabs/urql#maintenance-status">
<img alt="Maintenance Status" src="https://badgen.net/badge/maintenance/active/green" />
<a href="https://github.com/urql-graphql/urql/actions/workflows/ci.yml">
<img alt="CI Status" src="https://github.com/urql-graphql/urql/actions/workflows/ci.yml/badge.svg?branch=main" />
</a>
<a href="https://www.npmjs.com/package/urql">
<img alt="Weekly downloads" src="https://badgen.net/npm/dw/urql?color=blue" />
</a>
<a href="https://formidable.com/open-source/urql/docs/">
<img alt="Visit docs" src="https://badgen.net/badge/docs/visit site/orange" />
</a>
<a href="https://github.com/FormidableLabs/urql/discussions">
<a href="https://github.com/urql-graphql/urql/discussions">
<img alt="GitHub Discussions: Chat With Us" src="https://badgen.net/badge/discussions/chat%20with%20us/purple" />
</a>
<br />
Expand All @@ -37,9 +34,10 @@
- 🌱 Normalized caching via [`@urql/exchange-graphcache`](https://formidable.com/open-source/urql/docs/graphcache)
- 🔬 Easy debugging with the [`urql` devtools browser extensions](https://formidable.com/open-source/urql/docs/advanced/debugging/)

`urql` is a GraphQL client that exposes a set of helpers for several frameworks. It's built to be highly customisable and versatile so you can take it from getting started with your first GraphQL project all the way to building complex apps and experimenting with GraphQL clients.
`urql` is a GraphQL client that exposes a set of helpers for several frameworks. It's built to be highly customisable and versatile so
you can take it from getting started with your first GraphQL project all the way to building complex apps and experimenting with GraphQL clients.

While GraphQL is an elegant protocol and schema language, client libraries today typically come with large API footprints. We aim to create something more lightweight instead.
**📃 For more information, [check out the docs](https://formidable.com/open-source/urql/docs/).**

## Installation

Expand All @@ -49,6 +47,13 @@ yarn add urql graphql
npm install --save urql graphql
```

## 🙌 Contributing

**The urql project was founded by [Formidable](https://formidable.com/) and is actively developed
by the urql GraphQL team.**

If you'd like to get involved, [check out our Contributor's guide.](https://github.com/urql-graphql/urql/blob/main/CONTRIBUTING.md)

## 📃 [Documentation](https://formidable.com/open-source/urql/docs/)

The documentation contains everything you need to know about `urql`, and contains several sections in order of importance
Expand All @@ -62,8 +67,4 @@ when you first get started:

_You can find the raw markdown files inside this repository's `docs` folder._

## Maintenance Status

**Active:** Formidable is actively working on this project, and we expect to continue work on this project for the foreseeable future. Bug reports, feature requests and pull requests are welcome.

<img width="100%" src="docs/assets/urql-spoiler.png" />
2 changes: 1 addition & 1 deletion docs/advanced/README.md
Expand Up @@ -15,7 +15,7 @@ chapter.](../architecture.md)
Persisted Queries and File Uploads using the two respective packages.
- [**Server-side Rendering**](./server-side-rendering.md) guides us through how to set up server-side rendering and rehydration.
- [**Debugging**](./debugging.md) shows us the [`urql`
devtools](https://github.com/FormidableLabs/urql-devtools/) and how to add our own debug events
devtools](https://github.com/urql-graphql/urql-devtools/) and how to add our own debug events
for its event view.
- [**Retrying operations**](./retry-operations.md) shows the `retryExchange` which allows you to retry operations when they've failed.
- [**Authentication**](./authentication.md) describes how to implement authentication using the `authExchange`
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/debugging.md
Expand Up @@ -10,13 +10,13 @@ and those creating their own exchanges.

## Devtools

It's easiest to debug `urql` with the [`urql` devtools.](https://github.com/FormidableLabs/urql-devtools/)
It's easiest to debug `urql` with the [`urql` devtools.](https://github.com/urql-graphql/urql-devtools/)

It offers tools to inspect internal ["Debug Events"](#debug-events) as they happen, to explore data
as your app is seeing it, and to quickly trigger GraphQL queries.

[For instructions on how to set up the devtools, check out `@urql/devtools`'s readme in its
repository.](https://github.com/FormidableLabs/urql-devtools)
repository.](https://github.com/urql-graphql/urql-devtools)

![Urql Devtools Timeline](../assets/devtools-timeline.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/api/auth-exchange.md
Expand Up @@ -101,4 +101,4 @@ function addAuthToOperation: ({
}
```

[Read more examples in the documentation given here.](https://github.com/FormidableLabs/urql/tree/main/exchanges/auth#quick-start-guide)
[Read more examples in the documentation given here.](https://github.com/urql-graphql/urql/tree/main/exchanges/auth#quick-start-guide)
2 changes: 1 addition & 1 deletion docs/architecture.md
Expand Up @@ -150,7 +150,7 @@ Some of the exchanges that are available to us are:
- [`requestPolicyExchange`](./api/request-policy-exchange.md): Automatically upgrades `cache-only` and `cache-first` operations to `cache-and-network` after a given amount of time.
- [`refocusExchange`](./api/refocus-exchange.md): Tracks open queries and refetches them
when the window regains focus.
- `devtoolsExchange`: Provides the ability to use the [urql-devtools](https://github.com/FormidableLabs/urql-devtools)
- `devtoolsExchange`: Provides the ability to use the [urql-devtools](https://github.com/urql-graphql/urql-devtools)

We can even swap out our [document cache](./basics/document-caching.md), which is implemented by
`@urql/core`'s `cacheExchange`, with `urql`'s [normalized cache,
Expand Down
10 changes: 5 additions & 5 deletions docs/basics/ui-patterns.md
Expand Up @@ -5,7 +5,7 @@ order: 6

# UI Patterns

> This page is incomplete. You can help us expanding it by suggesting more patterns or asking us about common problems you're facing on [GitHub Discussions](https://github.com/FormidableLabs/urql/discussions).
> This page is incomplete. You can help us expanding it by suggesting more patterns or asking us about common problems you're facing on [GitHub Discussions](https://github.com/urql-graphql/urql/discussions).
Generally, `urql`'s API surface is small and compact. Some common problems that we're facing when building apps may look like they're not a built-in feature, however, there are several patterns that even a lean UI can support.
This page is a collection of common UI patterns and problems we may face with GraphQL and how we can tackle them in
Expand Down Expand Up @@ -87,9 +87,9 @@ const Search = () => {
Here we keep an array of all `variables` we've encountered and use them to render their
respective `result` page. This only rerenders the additional page rather than having a long
list that constantly changes. [You can find a full code example of this pattern in our example folder on the topic of Graphcache pagination.](https://github.com/FormidableLabs/urql/tree/main/examples/with-graphcache-pagination)
list that constantly changes. [You can find a full code example of this pattern in our example folder on the topic of Graphcache pagination.](https://github.com/urql-graphql/urql/tree/main/examples/with-graphcache-pagination)
We also do not need to use our normalized cache to achieve this. As long as we're able to split individual lists up into chunks across components, we can also solve this problem entirely in UI code. [Read our example code on how to achieve this.](https://github.com/FormidableLabs/urql/tree/main/examples/with-pagination)
We also do not need to use our normalized cache to achieve this. As long as we're able to split individual lists up into chunks across components, we can also solve this problem entirely in UI code. [Read our example code on how to achieve this.](https://github.com/urql-graphql/urql/tree/main/examples/with-pagination)
## Prefetching data
Expand Down Expand Up @@ -161,8 +161,8 @@ We can unpause the hook to start fetching, or, like in this example, call its re
In urql we leverage our extensibility pattern named "Exchanges" to manipulate the way
data comes in and goes out of our client.
- [Stale time](https://github.com/FormidableLabs/urql/tree/main/exchanges/request-policy)
- [Focus](https://github.com/FormidableLabs/urql/tree/main/exchanges/refocus)
- [Stale time](https://github.com/urql-graphql/urql/tree/main/exchanges/request-policy)
- [Focus](https://github.com/urql-graphql/urql/tree/main/exchanges/refocus)
When we want to introduce one of these patterns we add the package and add it to the `exchanges`
property of our `Client`. In the case of these two we'll have to add it before the cache
Expand Down

0 comments on commit 4d2cb17

Please sign in to comment.