From d7bbe84fc8de26e3f797f42f6022e1106163081f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20Gon=C3=A7alves?= Date: Thu, 21 Mar 2024 15:25:01 -0300 Subject: [PATCH] chore: changes ref tables to reference section --- .../.sidebar/reference-guides/index.js | 31 ++++++++++ .../.sidebar/setup-adm/automation.js | 27 --------- .../docs/references/references.mdx | 11 +++- .../af-database-keywords/group.mdx | 2 +- .../af-database-keywords/kpi.mdx | 2 +- .../af-database-keywords/table.mdx | 2 +- .../af-database-keywords/trend.mdx | 2 +- .../af-database-keywords/value.mdx | 2 +- .../setup-and-administration/index.mdx | 59 +++++++++++++++++++ .../sql-database-keywords/charts.mdx | 2 +- .../sql-database-keywords/group.mdx | 2 +- .../sql-database-keywords/kpi.mdx | 2 +- .../sql-database-keywords/table.mdx | 2 +- .../automation/configuration/af-databases.mdx | 10 ++-- .../configuration/sql-databases.mdx | 8 +-- 15 files changed, 118 insertions(+), 46 deletions(-) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/af-database-keywords/group.mdx (88%) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/af-database-keywords/kpi.mdx (90%) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/af-database-keywords/table.mdx (88%) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/af-database-keywords/trend.mdx (90%) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/af-database-keywords/value.mdx (91%) create mode 100644 visual-kpi-docs/docs/references/setup-and-administration/index.mdx rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/sql-database-keywords/charts.mdx (96%) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/sql-database-keywords/group.mdx (92%) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/sql-database-keywords/kpi.mdx (92%) rename visual-kpi-docs/docs/{setup-and-administration/automation/reference => references/setup-and-administration}/sql-database-keywords/table.mdx (92%) diff --git a/visual-kpi-docs/.sidebar/reference-guides/index.js b/visual-kpi-docs/.sidebar/reference-guides/index.js index 19dfe00c..a85a59b8 100644 --- a/visual-kpi-docs/.sidebar/reference-guides/index.js +++ b/visual-kpi-docs/.sidebar/reference-guides/index.js @@ -4,4 +4,35 @@ module.exports = [ id: 'references/references', label: 'References', }, + { + type: 'category', + label: "Setup and Administration", + link: { + type: 'doc', + id: 'references/setup-and-administration/setup-and-administration-reference', + }, + items: [ + { + type: 'category', + label: "AF Database Keywords", + items: [ + 'references/setup-and-administration/af-database-keywords/kpi-keywords', + 'references/setup-and-administration/af-database-keywords/trend-keywords', + 'references/setup-and-administration/af-database-keywords/table-keywords', + 'references/setup-and-administration/af-database-keywords/group-keywords', + 'references/setup-and-administration/af-database-keywords/value-keywords', + ], + }, + { + type: 'category', + label: "SQL Database Keywords", + items: [ + 'references/setup-and-administration/sql-database-keywords/kpi-keywords', + 'references/setup-and-administration/sql-database-keywords/table-keywords', + 'references/setup-and-administration/sql-database-keywords/group-keywords', + 'references/setup-and-administration/sql-database-keywords/charts-keywords', + ], + }, + ], + }, ] \ No newline at end of file diff --git a/visual-kpi-docs/.sidebar/setup-adm/automation.js b/visual-kpi-docs/.sidebar/setup-adm/automation.js index 32aab419..9884239f 100644 --- a/visual-kpi-docs/.sidebar/setup-adm/automation.js +++ b/visual-kpi-docs/.sidebar/setup-adm/automation.js @@ -23,32 +23,5 @@ module.exports = { 'setup-and-administration/automation/configuration/rcs-sql-tutorial', // 'setup-and-administration/automation/rcs-and-visual-kpi-design', // 'setup-and-administration/automation/use-cases', - { - type: 'category', - label: "Reference", - items: [ - { - type: 'category', - label: "AF Database Keywords", - items: [ - 'setup-and-administration/automation/reference/af-database-keywords/kpi-keywords', - 'setup-and-administration/automation/reference/af-database-keywords/trend-keywords', - 'setup-and-administration/automation/reference/af-database-keywords/table-keywords', - 'setup-and-administration/automation/reference/af-database-keywords/group-keywords', - 'setup-and-administration/automation/reference/af-database-keywords/value-keywords', - ], - }, - { - type: 'category', - label: "SQL Database Keywords", - items: [ - 'setup-and-administration/automation/reference/sql-database-keywords/kpi-keywords', - 'setup-and-administration/automation/reference/sql-database-keywords/table-keywords', - 'setup-and-administration/automation/reference/sql-database-keywords/group-keywords', - 'setup-and-administration/automation/reference/sql-database-keywords/charts-keywords', - ], - }, - ], - }, ], }; diff --git a/visual-kpi-docs/docs/references/references.mdx b/visual-kpi-docs/docs/references/references.mdx index 6457e295..2ed94252 100644 --- a/visual-kpi-docs/docs/references/references.mdx +++ b/visual-kpi-docs/docs/references/references.mdx @@ -6,4 +6,13 @@ description: 'This pages could be used to list the existing reference pages. In tags: [] --- -This pages could be used to list the existing reference pages. In the future, we could move from the knowledge base to the documentation. +import LinkCards from '@site/src/components/Cards/LinkCards'; + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/group.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/group.mdx similarity index 88% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/group.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/group.mdx index d42e3409..093aa734 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/group.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/group.mdx @@ -1,7 +1,7 @@ --- id: group-keywords title: Group Keywords -slug: /setup-and-administration/af-databases/group-keywords +slug: /reference/setup-and-administration/af-databases/group-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/kpi.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/kpi.mdx similarity index 90% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/kpi.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/kpi.mdx index 69b64724..6c223335 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/kpi.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/kpi.mdx @@ -1,7 +1,7 @@ --- id: kpi-keywords title: KPI Keywords -slug: /setup-and-administration/af-databases/kpi-keywords +slug: /reference/setup-and-administration/af-databases/kpi-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/table.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/table.mdx similarity index 88% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/table.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/table.mdx index 94215d63..6b7df8b5 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/table.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/table.mdx @@ -1,7 +1,7 @@ --- id: table-keywords title: Table Keywords -slug: /setup-and-administration/af-databases/table-keywords +slug: /reference/setup-and-administration/af-databases/table-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/trend.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/trend.mdx similarity index 90% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/trend.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/trend.mdx index f2660d1b..8af13672 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/trend.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/trend.mdx @@ -1,7 +1,7 @@ --- id: trend-keywords title: Trend Keywords -slug: /setup-and-administration/af-databases/trend-keywords +slug: /reference/setup-and-administration/af-databases/trend-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/value.mdx b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/value.mdx similarity index 91% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/value.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/value.mdx index 0a942429..437d18a2 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/af-database-keywords/value.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/af-database-keywords/value.mdx @@ -1,7 +1,7 @@ --- id: value-keywords title: Value Keywords -slug: /setup-and-administration/af-databases/value-keywords +slug: /reference/setup-and-administration/af-databases/value-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/references/setup-and-administration/index.mdx b/visual-kpi-docs/docs/references/setup-and-administration/index.mdx new file mode 100644 index 00000000..6c8114c6 --- /dev/null +++ b/visual-kpi-docs/docs/references/setup-and-administration/index.mdx @@ -0,0 +1,59 @@ +--- +id: setup-and-administration-reference +title: Setup and Administration Reference +slug: /reference/setup-and-administration-reference +description: 'This pages could be used to list the existing reference pages. In the future, we could move from the knowladge base to the documentation.' +tags: [] +--- + +import LinkCards from '@site/src/components/Cards/LinkCards'; + +## AF Database Keywords + + + +## SQL Database Keywords + + \ No newline at end of file diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/charts.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/charts.mdx similarity index 96% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/charts.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/charts.mdx index dec186e3..6a16834c 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/charts.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/charts.mdx @@ -1,7 +1,7 @@ --- id: charts-keywords title: Charts Attributes & Keywords Reference -slug: /setup-and-administration/sql-databases/charts-keywords +slug: /reference/setup-and-administration/sql-databases/charts-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/group.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/group.mdx similarity index 92% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/group.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/group.mdx index e9f53809..2be225d6 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/group.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/group.mdx @@ -1,7 +1,7 @@ --- id: group-keywords title: Groups Attributes & Keywords Reference -slug: /setup-and-administration/sql-databases/group-keywords +slug: /reference/setup-and-administration/sql-databases/group-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/kpi.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/kpi.mdx similarity index 92% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/kpi.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/kpi.mdx index de7df1d1..b7b0fa17 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/kpi.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/kpi.mdx @@ -1,7 +1,7 @@ --- id: kpi-keywords title: KPIs Attributes & Keywords Reference Table -slug: /setup-and-administration/sql-databases/kpi-keywords +slug: /reference/setup-and-administration/sql-databases/kpi-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/table.mdx b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/table.mdx similarity index 92% rename from visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/table.mdx rename to visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/table.mdx index 277b98df..fef3d1dc 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/reference/sql-database-keywords/table.mdx +++ b/visual-kpi-docs/docs/references/setup-and-administration/sql-database-keywords/table.mdx @@ -1,7 +1,7 @@ --- id: table-keywords title: Tables Attributes & Keywords Reference Table -slug: /setup-and-administration/sql-databases/table-keywords +slug: /reference/setup-and-administration/sql-databases/table-keywords description: '' tags: [] --- diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx index c7f30c73..75910ff9 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/af-databases.mdx @@ -47,11 +47,11 @@ By default, your AF attributes will be mapped to a Visual KPI value. However, if Below you find all lists of keywords and Visual KPI mapping information for each attribute: -- **[KPI keywords](/docs/setup-and-administration/af-databases/kpi-keywords)** -- **[Trend keywords](/docs/setup-and-administration/af-databases/trend-keywords)** -- **[Table keywords](/docs/setup-and-administration/af-databases/table-keywords)** -- **[Group keywords](/docs/setup-and-administration/af-databases/group-keywords)** -- **[Value keywords](/docs/setup-and-administration/af-databases/value-keywords)** +- **[KPI keywords](/docs/reference/setup-and-administration/af-databases/kpi-keywords)** +- **[Trend keywords](/docs/reference/setup-and-administration/af-databases/trend-keywords)** +- **[Table keywords](/docs/reference/setup-and-administration/af-databases/table-keywords)** +- **[Group keywords](/docs/reference/setup-and-administration/af-databases/group-keywords)** +- **[Value keywords](/docs/reference/setup-and-administration/af-databases/value-keywords)** ## Use example diff --git a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx index 96859caa..986cc8d6 100644 --- a/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx +++ b/visual-kpi-docs/docs/setup-and-administration/automation/configuration/sql-databases.mdx @@ -43,10 +43,10 @@ Every definition query (KPI, Group, Chart) must include a column called **METAID For your reference, please see the links to the reference tables below: -- **[Groups Attributes & Keywords Reference Table](/docs/setup-and-administration/sql-databases/groups-keywords)** -- **[KPIs Attributes & Keywords Reference Table](/docs/setup-and-administration/sql-databases/kpi-keywords)** -- **[Charts Attributes & Keywords Reference Table](/docs/setup-and-administration/sql-databases/charts-keywords)** -- **[Tables Attributes & Keywords Reference Table](/docs/setup-and-administration/sql-databases/tables-keywords)** +- **[Groups Attributes & Keywords Reference Table](/docs/reference/setup-and-administration/sql-databases/group-keywords)** +- **[KPIs Attributes & Keywords Reference Table](/docs/reference/setup-and-administration/sql-databases/kpi-keywords)** +- **[Charts Attributes & Keywords Reference Table](/docs/reference/setup-and-administration/sql-databases/charts-keywords)** +- **[Tables Attributes & Keywords Reference Table](/docs/reference/setup-and-administration/sql-databases/table-keywords)** ## Tutorial