Skip to content

Commit

Permalink
updating links to absolute (#329)
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Zarate <[email protected]>
  • Loading branch information
smithjw1 and chriszarate authored Jan 28, 2025
1 parent f4c6d27 commit 947a1e4
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/extending/block-registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Example:

#### Search queries

Search queries must return a collection and must accept a string input variable of `search_terms`. The [Art Institute of Chicago](../../example/rest-api/art-institute/README.md) example looks like this:
Search queries must return a collection and must accept a string input variable of `search_terms`. The [Art Institute of Chicago](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/rest-api/art-institute/README.md) example looks like this:

```php
$search_art_query = HttpQuery::from_array([
Expand Down
8 changes: 4 additions & 4 deletions docs/extending/data-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ Headers will be set according to the properties of the array. When providing aut

## Additional parameters

You can add any additional parameters that are necessary for your data source. In our [Airtable example](../../example/airtable/events/register.php), you can see that we are setting values for the Airtable `base` and `table`.
You can add any additional parameters that are necessary for your data source. In our [Airtable example](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/airtable/events/register.php), you can see that we are setting values for the Airtable `base` and `table`.

Consider adding whatever configuration would be useful to queries. As an example, queries have an `endpoint` property. Our [Zip code example](../../example/rest-api/zip-code/register.php) sets the endpoint with a function:
Consider adding whatever configuration would be useful to queries. As an example, queries have an `endpoint` property. Our [Zip code example](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/rest-api/zip-code/zip-code.php) sets the endpoint with a function:

```php
$zipcode_query = HttpQuery::from_array( [
Expand Down Expand Up @@ -102,9 +102,9 @@ Headers will be set according to the properties of the array. When providing aut

## Additional parameters

You can add any additional parameters that are necessary for your data source. In our [Airtable example](../../example/airtable/events/register.php), you can see that we are setting values for the Airtable `base` and `table`.
You can add any additional parameters that are necessary for your data source. In our [Airtable example](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/airtable/events/register.php), you can see that we are setting values for the Airtable `base` and `table`.

Consider adding whatever configuration would be useful to queries. As an example, queries have an `endpoint` property. Our [Zip code example](../../example/rest-api/zip-code/register.php) sets the endpoint with a function:
Consider adding whatever configuration would be useful to queries. As an example, queries have an `endpoint` property. Our [Zip code example](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/rest-api/zip-code/zip-code.php) sets the endpoint with a function:

```php
$zipcode_query = HttpQuery::from_array( [
Expand Down
2 changes: 1 addition & 1 deletion docs/extending/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Once you've defined your data source and queries, you can [register a remote dat

## Examples

The [examples](../../example/README.md) provide detailed code samples of interacting with the plugin various methods of extending the plugin.
The [examples](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/README.md) provide detailed code samples of interacting with the plugin various methods of extending the plugin.

## Create a local development environment

Expand Down
4 changes: 2 additions & 2 deletions docs/extending/query-output_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Unless your API returns a single value, `type` will be constructed of an associa

## Single Entry Example

Using the [Zip Code example](../../example/rest-api/zip-code/README.md), the JSON response returned by the API looks like this:
Using the [Zip Code example](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/rest-api/zip-code/README.md), the JSON response returned by the API looks like this:

```json
{
Expand Down Expand Up @@ -69,7 +69,7 @@ Where `city_state` uses the genrate function to combine two elements from inside

## Collection Example

An example of collection JSON can be found in the [Chicago Institue of Art example](../../example/rest-api/art-institute/README.md). That API returns (in part):
An example of collection JSON can be found in the [Chicago Institue of Art example](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/rest-api/art-institute/README.md). That API returns (in part):

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Back on the data source list, click the three dots on the right of the row for y

## Step 3: Copy the zip code data source example

Copy the [zip code data source example](../example/rest-api/zip-code/zip-code.php) into your `/plugins` directory, set `EXAMPLE_ZIP_CODE_DATA_SOURCE_UUID` to the UUID copied above and then activate the plugin titled `Zip Code RDB Example`.
Copy the [zip code data source example](https://github.com/Automattic/remote-data-blocks/blob/trunk/example/rest-api/zip-code/zip-code.php) into your `/plugins` directory, set `EXAMPLE_ZIP_CODE_DATA_SOURCE_UUID` to the UUID copied above and then activate the plugin titled `Zip Code RDB Example`.

## Step 4: Customize the configuration

Expand Down

0 comments on commit 947a1e4

Please sign in to comment.