Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning that VTable is deprecated #859

Merged
merged 1 commit into from
Dec 8, 2023
Merged

Add warning that VTable is deprecated #859

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/guides/Master-Data/master-data-how-it-works/vtable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
updatedAt: "2022-07-28T21:27:21.269Z"
---

VTable is a dynamic user interface designed to handle data from Master Data v2 directly from VTEX Admin. It allows you to create custom applications for managing and visualizing data efficiently, using [JSON schemas](https://developers.vtex.com/vtex-rest-api/docs/starting-to-work-on-master-data-with-json-schema).
> ⚠️ VTable has been deprecated, which means it will not be updated, and support and maintenance are no longer provided.

VTable is a dynamic user interface designed to handle data from Master Data v2 directly from VTEX Admin. It allows you to create custom applications for managing and visualizing data from documents efficiently, using [JSON schemas](https://developers.vtex.com/vtex-rest-api/docs/starting-to-work-on-master-data-with-json-schema).

To render an app in VTable you must follow these steps:

Expand All @@ -15,6 +17,8 @@
- [Step 3 - Validating the app schema](#step-3---validating-the-app-schema)
- [Step 4 - Saving the app schema to Master Data](#step-4---saving-the-app-schema-to-master-data)

> ⚠️ VTable interface displays up to 14 documents in each app. It is not possible to increase this limit, since VTable is deprecated.

Below you can also learn more about all necessary [JSON schema configurations](#json-schema-configurations).

## Step by step
Expand All @@ -27,8 +31,8 @@

Check the [JSON schema configurations](#json-schema-configurations) section to learn how to configure each field for your specific needs.

<details>

Check warning on line 34 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:34:1 MD033/no-inline-html Inline HTML [Element: details]
<summary>Example JSON schema (request body)</summary>

Check warning on line 35 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:35:1 MD033/no-inline-html Inline HTML [Element: summary]

```json
[
Expand Down Expand Up @@ -80,8 +84,8 @@

You will validate your app schema's structure in the following step.

<details>

Check warning on line 87 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:87:1 MD033/no-inline-html Inline HTML [Element: details]
<summary>VTable app objects schema</summary>

Check warning on line 88 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:88:1 MD033/no-inline-html Inline HTML [Element: summary]

```json
{
Expand Down Expand Up @@ -222,8 +226,8 @@

</details>

<details>

Check warning on line 229 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:229:1 MD033/no-inline-html Inline HTML [Element: details]
<summary>Example app schema</summary>

Check warning on line 230 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:230:1 MD033/no-inline-html Inline HTML [Element: summary]

```json
{
Expand Down Expand Up @@ -317,8 +321,8 @@

VTable parses the JSON Schema configuration and each field to a corresponding UI component. These are some examples of possible configurations:

<details>

Check warning on line 324 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:324:1 MD033/no-inline-html Inline HTML [Element: details]
<summary>Checkbox</summary>

Check warning on line 325 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:325:1 MD033/no-inline-html Inline HTML [Element: summary]

Set the value of the `type` field as `boolean` to render a checkbox.

Expand All @@ -331,8 +335,8 @@

</details>

<details>

Check warning on line 338 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:338:1 MD033/no-inline-html Inline HTML [Element: details]
<summary>Dropdown</summary>

Check warning on line 339 in docs/guides/Master-Data/master-data-how-it-works/vtable.md

View workflow job for this annotation

GitHub Actions / runner / markdownlint 

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]

Raw Output:
docs/guides/Master-Data/master-data-how-it-works/vtable.md:339:1 MD033/no-inline-html Inline HTML [Element: summary]

Add the **enum** property to render dropdown options.

Expand Down