Skip to content

Commit

Permalink
Merge pull request #263 from flotiq/feature/24755-screens-update
Browse files Browse the repository at this point in the history
#24755 screens update
  • Loading branch information
KarolNet authored Aug 1, 2024
2 parents d5ab87d + baa0c9c commit c4d72c2
Show file tree
Hide file tree
Showing 226 changed files with 135 additions and 132 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To start server use:
```bash
# Use SOURCE_EDITOR_URL variable to point to speciffic dashboard url. By default, SOURCE_EDITOR_URL=https://editor.flotiq.com is used.
bash .github/scripts/get-plugins-docs.sh # Pull dynamically generated plugin docs.
mkdocs serve # Start devlopment server
mkdocs serve # Start devlopment server. Use --dirtyreload option to speed up reloading, but be aware, that this might break navigation on the preview.
```

After that, the documentation should be available on http://localhost:4000.
Expand Down
4 changes: 2 additions & 2 deletions docs/API/dynamic-content-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Part of the Content API are the beautiful API docs, along with code samples to s

There are 3 important parts of the API documentation that Flotiq provides for you:

![](images/dynamic-content-api-docs.png)
![](images/dynamic-content-api-docs-annotated.png){: .border}

1. Every time you create a Content Type Definition - your API is extended with endpoints that support this new Content Type.
2. The descriptions of these endpoints contain all the information regarding the structure and constraints of the Content Type you defined.
Expand All @@ -45,6 +45,6 @@ We currently support the following SDKs:

In a similar fashion - we also provide a downloadable Postman collection, which fully describes your entire Content API.

![](images/postman.jpeg)
![](images/postman.jpeg){: .border}

Read more on how to configure Postman to work with Flotiq in [API access → Postman](../#postman)
2 changes: 1 addition & 1 deletion docs/API/generate-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Flotiq provides SDKs, or client libraries, to access your Content,

On your Flotiq dashboard, you can find links to download client libraries (SDK packages) for several frameworks and languages.

![Available frameworks and languages](images/frameworkslogos.png)
![Available frameworks and languages](images/frameworkslogos.png){: .width25 .center .border}

Currently supported generators are:

Expand Down
2 changes: 1 addition & 1 deletion docs/API/generate-package/sdk-nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Flotiq provides SDK NodeJS to access your Content.

On your Flotiq dashboard, you can find link to download client library SDK NodeJS.

![Available frameworks and languages](../images/frameworkslogos-nodejs.png)
![Available frameworks and languages](../images/frameworkslogos-nodejs.png){: .width25 .center .border}

These package is automatically generated every time you modify your Content Type definitions, just like your API documentation.

Expand Down
Binary file added docs/API/images/api-keys-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/api-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/api-keys_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/api-keys_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/api-keys_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/api-keys_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/API/images/datasource/datasource-page.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/dynamic-content-api-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/API/images/edit-content-type-definitions.png
Binary file not shown.
Binary file removed docs/API/images/example-response.png
Binary file not shown.
Binary file removed docs/API/images/flotiq.png
Binary file not shown.
Binary file modified docs/API/images/frameworkslogos-nodejs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/frameworkslogos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/API/images/personalizacja.jpg
Binary file not shown.
Binary file removed docs/API/images/personalizacja2.jpg
Binary file not shown.
Binary file removed docs/API/images/personalizacja3.jpg
Binary file not shown.
Binary file removed docs/API/images/small_logo.png
Binary file not shown.
Binary file removed docs/API/images/user-profile.png
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/API/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

All API endpoints that are published in Flotiq are currently using an API-key authorization method.

There are two types of API keys - [Application Keys](#application-api-keys) and [User Defined Keys](#user-defined-api-keys). Both types of keys can be retrieved from the API Keys page in the Flotiq Panel (click on your avatar to open the menu):
There are two types of API keys - [Application Keys](#application-api-keys) and [User Defined Keys](#user-defined-api-keys). Both types of keys can be retrieved from the API Keys page in the Flotiq Panel:

![](images/user-profile.png){: .center .border}
![](images/api-keys-menu.png){: .center .width25 .border}

All keys restrict access to not only CRUD of the Content Objects, but also to their hydration and search; the same restrictions apply to GraphQL endpoint.

Expand Down
2 changes: 1 addition & 1 deletion docs/API/workflow/content-publishing-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Custom workflows can be defined in Flotiq, for example a simple editorial workfl

with the following possible transitions

![](./images/publishing-workflow.svg)
![](./images/publishing-workflow.svg){: .center}

can be used to help teams curate content, manage publication and archiving of content.

Expand Down
8 changes: 4 additions & 4 deletions docs/Deep-Dives/Building-a-blog-in-3-minutes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ First off - you will need to define how your content will be structured in Floti

We labeled the new Content Type `Blog Post` and gave it an API name `blogpost`. Once you do that - you'll have to add the properties that will be defined for each of the entries. The `Add property` button will open a form, where you will define the characteristics of each of the fields (like if it's required, what kind of a field it is, etc.):

![](images/building-a-blog-in-3-minutes/3-minute-blog-content-type-title-field.png){: .center .width75 }
![](../panel/images/AddContentTypeDefinitionsTitle.png)


Here are the details of the fields we added for this tutorial:
Expand All @@ -29,13 +29,13 @@ Here are the details of the fields we added for this tutorial:

and this is how the Content Type Editor should look like in the end:

![](images/building-a-blog-in-3-minutes/3-minute-blog-content-type-all-fields.png){: .center .width75 }
![](../panel/images/AddContentTypeDefinitions.png)

If you're happy with the result - click the `Save` button and navigate to `Content``Blog Posts` in the side menu.

!!! hint
At this point you can also verify the result of your work in the [Dynamic Content API](../API/dynamic-content-api.md) - head to you API docs and see how the API has automatically expanded to support your new Content Type:
![](images/building-a-blog-in-3-minutes/3-minute-blog-content-api.png)
![](../API/images/dynamic-content-api-docs.png)

Three important things to note here:

Expand All @@ -52,7 +52,7 @@ If you're happy with the result - click the `Save` button and navigate to `Conte

It's now time to write your first post! The first time you go to the `Blog Posts` item in the `Content` menu you will be prompted with a screen encouraging to create your first Content Object, go ahead and click the `Add new Blog Post object` button. You will see an empty form that is automatically generated based on the Content Type Definition you provided in the previous step. Fill it in, however you like!

![](images/building-a-blog-in-3-minutes/3-minute-blog-first-post.png){: .center .width75 }
![](../panel/images/AddBlogPost.png){: .border }

That's it. Now make sure you have your [read-only API key](../API/index.md) in your clipboard!

Expand Down
Binary file removed docs/Deep-Dives/images/add-ctd-1.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/Deep-Dives/images/create-definition-recipe.png
Diff not rendered.
Binary file removed docs/Deep-Dives/images/flotiq-blog.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ If you'd like to dig a little deeper into this recipe website, here's your quick

Create your [Flotiq.com](https://flotiq.com) account. Next, create the `Recipe` Content Type:

![Recipe content type in flotiq](images/jamstack-recipes-complex-data-structures/add-definition-type-recipe.png){: .center .width75 .border}
![Recipe content type in flotiq](../panel/images/definition-builder-create-recipe.png){: .center .width75 .border}

_Note: You can also create `Recipe` using [Flotiq REST API](https://flotiq.com/docs/API/)._

Expand Down
4 changes: 2 additions & 2 deletions docs/Deep-Dives/mobile-expo-product-showcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ The screen you will see allows you to connect with your Flotiq account, but we w
Now it's time to create the Content Type definition in the Flotiq. You can use our predefined
types to speed up the modelling process. You can update the Content Type definition in further development.

Go to the Content Type definitions tab and choose `Products`.
Go to the Content Type definitions tab and choose `Product`.
Save your Content Type definition. Now you can add your products to the Flotiq.

![](images/mobile-expo-product-showcase/create-product-ctd.png){: .border}
![](../panel/images/definition-builder-create-product.png){: .border}

## Code updates

Expand Down
4 changes: 2 additions & 2 deletions docs/Deep-Dives/node-js-ecommerce-snipcart-gatsby-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The most crucial step - you have to tell Flotiq what kind of data you want to st

When you first log in - it's going to be pretty empty. No content, nothing. Head over to the `Type definitions` screen.

![Predefined Content Type Definitions](images/snipcart-gatsby-demo/predefined-content-type-definitions.png){: .center .border}
![Predefined Content Type Definitions](../panel/images/TypeDefinitionsTiles.png){: .center .width75 .border}


Here you find a list of simple boilerplate content types, which are a great start if you're in a hurry.
Expand Down Expand Up @@ -92,7 +92,7 @@ SNIPCART_API_KEY="YOUR SNIPCART API KEY"

You can find your Flotiq API keys in `API Keys` section:

![Flotiq user API key](images/snipcart-gatsby-demo/flotiq-user-api-key.png){: .border}
![Flotiq user API key](../API/images/api-keys-menu.png){: .border .width25 .center}

!!! caution
We strongly recommend that you create a scoped API key (read more about [API access](../API/index.md)), but for development, you can use the default Read Only key provided in the interface.
Expand Down
Binary file removed docs/Flotiq-Mobile-Expo/images/logo-github.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
7 changes: 5 additions & 2 deletions docs/Universe/deployment/netlify-nextjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,14 @@ The essential two environment variables needed for every Gatsby project are **FL

For example, if you're using the [Gatsby and Snipcart starter](https://github.com/flotiq/gatsby-starter-products) you will also provide the Snipcart API key. The project Readme always described the needed variables.

To obtain the Flotiq API key - in your Flotiq account, click your profile icon in the sidebar and go to **API keys**: ![](images/flotiq-api-keys-button.png){: .center .width25 .border}
To obtain the Flotiq API key - in your Flotiq account, click `API keys` in the sidebar:

![](../../API/images/api-keys-menu.png){: .center .width25 .border}


You can either select the application-wide read-only key:

![](images/flotiq-api-keys-gui.png){: .center .width75 .border}
![](../../API/images/api-keys_1.png){: .center .width75 .border}

Or, as a safer option, create a scoped read-only API key that will only be used for the Netlify build. Read more about [Flotiq API access](https://flotiq.com/docs/API/).

Expand Down
7 changes: 3 additions & 4 deletions docs/Universe/deployment/vercel-gatsby.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,14 @@ The essential environment variable needed for every Gatsby project is **GATSBY_F

For example, if you're using the [Gatsby and Snipcart starter](https://github.com/flotiq/gatsby-starter-products) you will also provide the Snipcart API key. The project Readme always describes the needed variables.

To obtain the Flotiq API key - go to your Flotiq account and click your profile icon in the sidebar and go to [API keys](https://editor.flotiq.com/api-keys):
To obtain the Flotiq API key - in your Flotiq account, click `API keys` in the sidebar:


![](images/flotiq-api-keys-button.png){: .center .width25 .border}
![](../../API/images/api-keys-menu.png){: .center .width25 .border}


You can either select the application-wide read-only key:

![](images/flotiq-api-keys-gui.png){: .center .width75 .border}
![](../../API/images/api-keys_1.png){: .center .width75 .border}


Or, as a safer option, create a scoped read-only API key that will only be used for the Vercel build. Read more about [Flotiq API access](https://flotiq.com/docs/API/).
Expand Down
7 changes: 3 additions & 4 deletions docs/Universe/deployment/vercel-nextjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,15 +101,14 @@ The essential two environment variables needed for every Gatsby project are `FLO

For example, if you're using the [Gatsby and Snipcart starter](https://github.com/flotiq/gatsby-starter-products) you will also provide the Snipcart API key. The project Readme always described the needed variables.

To obtain the Flotiq API key - in your Flotiq account, click your profile icon in the sidebar and go to `API keys`:
To obtain the Flotiq API key - in your Flotiq account, click `API keys` in the sidebar:

![](images/flotiq-api-keys-button.png){: .center .width25 .border}
![](../../API/images/api-keys-menu.png){: .center .width25 .border}


You can either select the application-wide read-only key:


![](images/flotiq-api-keys-gui.png){: .center .width75 .border}
![](../../API/images/api-keys_1.png){: .center .width75 .border}


Or, as a safer option, create a scoped read-only API key that will only be used for the Vercel build. Read more about [Flotiq API access](https://flotiq.com/docs/API/).
Expand Down
Binary file modified docs/Universe/images/gatsby/gatsby-starters.png
Binary file removed docs/Universe/images/n8n/add_gmail_node.png
Diff not rendered.
Binary file removed docs/Universe/images/n8n/example_data.png
Diff not rendered.
Binary file removed docs/Universe/images/n8n/example_data_n8n.png
Diff not rendered.
Binary file removed docs/Universe/images/n8n/webhook_params.png
Diff not rendered.
Binary file modified docs/Universe/images/nextjs/nextjs-starters.png
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ There are 2 primary ways to interact with Flotiq: 1. through the [user interface

Data model in Flotiq is created by adding one or more Content Type Definitions (we often refer to them as CTDs). CTDs are a key part of the system, where you - the user - describe the content (data model) you will be storing in Flotiq. The [Content Type builder](panel/content-types.md) is the tool we provide for you to easily define your Content Types, using a graphical User Interface. Type Definitions are like classes in object-oriented programming, they describe object properties.

![](panel/images/EditContentTypeDefinitions.png)
![](panel/images/EditContentTypeDefinitions.png){.center .width50 .border}

Read more about how to use the Content Type editor in the [Panel docs](panel/content-types.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/panel/Plugins/Gatsby-cloud-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ For example, if you're using the [Gatsby and Snipcart starter](https://github.co

To obtain the Flotiq API key - in your Flotiq account, click your profile icon in the sidebar and go to `API keys`:

![Access Flotiq API keys](../../API/images/user-profile.png){: .center .width25 .border}
![Access Flotiq API keys](../../API/images/api-keys-menu.png){: .center .width25 .border}

You can either select the application-wide read-only key:

Expand Down
Diff not rendered.
Loading

0 comments on commit c4d72c2

Please sign in to comment.