From 62425246515abbddd32a44bbbe6c9646688ffd00 Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Tue, 17 May 2022 20:06:26 -0300 Subject: [PATCH 1/6] Create 2022-05-18-faststore.md --- docs/blog/2022-05-18-faststore.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/blog/2022-05-18-faststore.md diff --git a/docs/blog/2022-05-18-faststore.md b/docs/blog/2022-05-18-faststore.md new file mode 100644 index 0000000000..440622c520 --- /dev/null +++ b/docs/blog/2022-05-18-faststore.md @@ -0,0 +1,22 @@ +--- +description: The FastStore API types, queries and mutations have been documented. You can check it now by using GraphiQL. +tags: [faststore] +hide_table_of_contents: false +--- + +# FastStore API documentation updated + +We have made available FastStore API reference documentation. You can check it now by using [GraphiQL](https://github.com/graphql/graphiql). + +## What has changed? + +When locally running a FastStore project, you can head to this address to use **GraphiQL** and explore the API: +``` +http://localhost:4000/graphql +``` + +Now, when you do this you will see that each type, argument, querie and mutation has an associated description. + +## What needs to be done? + +In order to preview the descriptions via **GraphiQL**, you must install the latest version of the `@faststore/api` package. From 4ae854fbacdf64cf40e335aca1acc2804c3ea847 Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Wed, 18 May 2022 11:26:03 -0300 Subject: [PATCH 2/6] Correcting release note --- docs/blog/2022-05-18-faststore.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/blog/2022-05-18-faststore.md b/docs/blog/2022-05-18-faststore.md index 440622c520..97af808cc1 100644 --- a/docs/blog/2022-05-18-faststore.md +++ b/docs/blog/2022-05-18-faststore.md @@ -10,13 +10,15 @@ We have made available FastStore API reference documentation. You can check it n ## What has changed? -When locally running a FastStore project, you can head to this address to use **GraphiQL** and explore the API: -``` -http://localhost:4000/graphql -``` - -Now, when you do this you will see that each type, argument, querie and mutation has an associated description. +When working on a FastStore project, you can run it locally and use **GraphiQL** to explore the API. Now, when you do this you will see that each type, argument, querie and mutation has an associated description. ## What needs to be done? -In order to preview the descriptions via **GraphiQL**, you must install the latest version of the `@faststore/api` package. +To see these new docs follow these steps: +1. Run `yarn` in your project to reinstall the `@faststore/api` dependency. +2. Run `yarn develop` to start a local server. +3. Go to this address: +``` +http://localhost:8000/__graphql +``` +4. Click on the `Docs` button on the upper right corner. From cf29d35d4750f023a88430780b7045052273e4f0 Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Wed, 18 May 2022 15:09:05 -0300 Subject: [PATCH 3/6] Update 2022-05-18-faststore.md --- docs/blog/2022-05-18-faststore.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/blog/2022-05-18-faststore.md b/docs/blog/2022-05-18-faststore.md index 97af808cc1..72df34982c 100644 --- a/docs/blog/2022-05-18-faststore.md +++ b/docs/blog/2022-05-18-faststore.md @@ -22,3 +22,6 @@ To see these new docs follow these steps: http://localhost:8000/__graphql ``` 4. Click on the `Docs` button on the upper right corner. +5. On the docs tab you can browse through the definitions or search for types by name. + +![Screen capture of the procedure described above.](https://vtexhelp.vtexassets.com/assets/docs/src/viewing%20docs%20in%20graphiql%2018052022___8e00bfb24dcfc4c7cddcd45bc0863c8a.gif) From f22b74a7c4cfbe33e607cf2d3d0fe2fe4884126e Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Wed, 18 May 2022 15:22:57 -0300 Subject: [PATCH 4/6] Update 2022-05-18-faststore.md --- docs/blog/2022-05-18-faststore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/blog/2022-05-18-faststore.md b/docs/blog/2022-05-18-faststore.md index 72df34982c..07c79d8312 100644 --- a/docs/blog/2022-05-18-faststore.md +++ b/docs/blog/2022-05-18-faststore.md @@ -17,7 +17,7 @@ When working on a FastStore project, you can run it locally and use **GraphiQL** To see these new docs follow these steps: 1. Run `yarn` in your project to reinstall the `@faststore/api` dependency. 2. Run `yarn develop` to start a local server. -3. Go to this address: +3. Access GraphiQL by going to this address: ``` http://localhost:8000/__graphql ``` From c529326ef54b24250005477d9b183a98584bbc8c Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Wed, 18 May 2022 15:31:29 -0300 Subject: [PATCH 5/6] Updating `releases` file and release note title --- docs/blog/2022-05-18-faststore.md | 2 +- docs/static/data/releases.json | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/blog/2022-05-18-faststore.md b/docs/blog/2022-05-18-faststore.md index 07c79d8312..9e34b7118a 100644 --- a/docs/blog/2022-05-18-faststore.md +++ b/docs/blog/2022-05-18-faststore.md @@ -4,7 +4,7 @@ tags: [faststore] hide_table_of_contents: false --- -# FastStore API documentation updated +# FastStore API documentation available on GraphiQL We have made available FastStore API reference documentation. You can check it now by using [GraphiQL](https://github.com/graphql/graphiql). diff --git a/docs/static/data/releases.json b/docs/static/data/releases.json index 145290ba34..8b980dcb3e 100644 --- a/docs/static/data/releases.json +++ b/docs/static/data/releases.json @@ -1,4 +1,10 @@ [ + { + "title": "FastStore API documentation available on GraphiQL", + "product": "FastStore", + "fileName": "2022-05-18-faststore", + "description": "The FastStore API types, queries and mutations have been documented. You can check it now by using GraphiQL." + }, { "title": "Faster builds with new WebOps caching system", "product": "WebOps", From f6b3455bd69fe87ec7b237be78d93d7934a5b2c3 Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Wed, 18 May 2022 15:39:11 -0300 Subject: [PATCH 6/6] Update 2022-05-18-faststore.md --- docs/blog/2022-05-18-faststore.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/blog/2022-05-18-faststore.md b/docs/blog/2022-05-18-faststore.md index 9e34b7118a..7998b86bef 100644 --- a/docs/blog/2022-05-18-faststore.md +++ b/docs/blog/2022-05-18-faststore.md @@ -1,20 +1,20 @@ --- -description: The FastStore API types, queries and mutations have been documented. You can check it now by using GraphiQL. +description: The FastStore API types, queries and mutations have been documented. You can check it now via the GraphiQL IDE. tags: [faststore] hide_table_of_contents: false --- # FastStore API documentation available on GraphiQL -We have made available FastStore API reference documentation. You can check it now by using [GraphiQL](https://github.com/graphql/graphiql). +FastStore API reference documentation is now available. You can check it now via the [GraphiQL](https://github.com/graphql/graphiql) IDE. ## What has changed? -When working on a FastStore project, you can run it locally and use **GraphiQL** to explore the API. Now, when you do this you will see that each type, argument, querie and mutation has an associated description. +While working on your FastStore website, you can run your project locally and use **GraphiQL** to explore the API. Now, when you do this you will see that each type, argument, query and mutation has an associated description. ## What needs to be done? -To see these new docs follow these steps: +To explore the FastStore API reference documentation, follow these steps: 1. Run `yarn` in your project to reinstall the `@faststore/api` dependency. 2. Run `yarn develop` to start a local server. 3. Access GraphiQL by going to this address: