From 947a1e4e7ce7256a87baf38787a4c6bab36dd041 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Mon, 27 Jan 2025 18:41:37 -0800 Subject: [PATCH] updating links to absolute (#329) Co-authored-by: Chris Zarate --- docs/extending/block-registration.md | 2 +- docs/extending/data-source.md | 8 ++++---- docs/extending/index.md | 2 +- docs/extending/query-output_schema.md | 4 ++-- docs/quickstart.md | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/extending/block-registration.md b/docs/extending/block-registration.md index 931bd0004..8451909ac 100644 --- a/docs/extending/block-registration.md +++ b/docs/extending/block-registration.md @@ -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([ diff --git a/docs/extending/data-source.md b/docs/extending/data-source.md index 7df208656..bc7d512ff 100644 --- a/docs/extending/data-source.md +++ b/docs/extending/data-source.md @@ -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( [ @@ -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( [ diff --git a/docs/extending/index.md b/docs/extending/index.md index a7282eacd..5e8b3011d 100644 --- a/docs/extending/index.md +++ b/docs/extending/index.md @@ -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 diff --git a/docs/extending/query-output_schema.md b/docs/extending/query-output_schema.md index 587753529..d236caa31 100644 --- a/docs/extending/query-output_schema.md +++ b/docs/extending/query-output_schema.md @@ -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 { @@ -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 { diff --git a/docs/quickstart.md b/docs/quickstart.md index cee191162..d20a67cd5 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -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