Skip to content

Commit 057f4af

Browse files
hkad98hkad98
committed
fix(gooddata-sdk): fix copyright year and docs format in appearance service
Update copyright from 2024 to 2026 in all new appearance module files. Migrate documentation from markdown tables to Hugo shortcodes (parameters-block/parameter) to match the existing documentation style. jira: trivial risk: nonprod
1 parent ed96aca commit 057f4af

15 files changed

Lines changed: 109 additions & 117 deletions

File tree

‎docs/content/en/latest/administration/appearance/create_color_palette.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@ weight: 220
99

1010
Create a new color palette.
1111

12-
## Parameters
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="color_palette" p_type="CatalogColorPalette" >}}
14+
A catalog color palette object to be created.
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
1317

14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| color_palette | CatalogColorPalette | A catalog color palette object to be created. |
17-
18-
## Returns
19-
20-
_None_
18+
{{% parameters-block title="Returns" None="yes"%}}
19+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/create_theme.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@ weight: 120
99

1010
Create a new theme.
1111

12-
## Parameters
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="theme" p_type="CatalogTheme" >}}
14+
A catalog theme object to be created.
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
1317

14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| theme | CatalogTheme | A catalog theme object to be created. |
17-
18-
## Returns
19-
20-
_None_
18+
{{% parameters-block title="Returns" None="yes"%}}
19+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/delete_color_palette.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,17 @@ weight: 240
99

1010
Delete a color palette.
1111

12-
## Parameters
13-
14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| color_palette_id | str | Color palette identification string e.g. "my_palette" |
17-
18-
## Returns
19-
20-
_None_
21-
22-
## Raises
23-
24-
| type | description |
25-
| -- | -- |
26-
| ValueError | Color palette does not exist. |
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="color_palette_id" p_type="string" >}}
14+
Color palette identification string e.g. "my_palette"
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
17+
18+
{{% parameters-block title="Returns" None="yes"%}}
19+
{{% /parameters-block %}}
20+
21+
{{% parameters-block title="Raises" %}}
22+
{{< parameter p_type="Value Error" >}}
23+
Color palette does not exist.
24+
{{< /parameter >}}
25+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/delete_theme.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,17 @@ weight: 140
99

1010
Delete a theme.
1111

12-
## Parameters
13-
14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| theme_id | str | Theme identification string e.g. "my_dark_theme" |
17-
18-
## Returns
19-
20-
_None_
21-
22-
## Raises
23-
24-
| type | description |
25-
| -- | -- |
26-
| ValueError | Theme does not exist. |
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="theme_id" p_type="string" >}}
14+
Theme identification string e.g. "my_dark_theme"
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
17+
18+
{{% parameters-block title="Returns" None="yes"%}}
19+
{{% /parameters-block %}}
20+
21+
{{% parameters-block title="Raises" %}}
22+
{{< parameter p_type="Value Error" >}}
23+
Theme does not exist.
24+
{{< /parameter >}}
25+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/get_color_palette.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ weight: 210
99

1010
Get an individual color palette.
1111

12-
## Parameters
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="color_palette_id" p_type="string" >}}
14+
Color palette identification string e.g. "my_palette"
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
1317

14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| color_palette_id | str | Color palette identification string e.g. "my_palette" |
17-
18-
## Returns
19-
20-
| type | description |
21-
| -- | -- |
22-
| CatalogColorPalette | Catalog color palette object containing structure of the color palette. |
18+
{{% parameters-block title="Returns" %}}
19+
{{< parameter p_type="CatalogColorPalette" >}}
20+
Catalog color palette object containing structure of the color palette.
21+
{{< /parameter >}}
22+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/get_theme.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ weight: 110
99

1010
Get an individual theme.
1111

12-
## Parameters
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="theme_id" p_type="string" >}}
14+
Theme identification string e.g. "my_dark_theme"
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
1317

14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| theme_id | str | Theme identification string e.g. "my_dark_theme" |
17-
18-
## Returns
19-
20-
| type | description |
21-
| -- | -- |
22-
| CatalogTheme | Catalog theme object containing structure of the theme. |
18+
{{% parameters-block title="Returns" %}}
19+
{{< parameter p_type="CatalogTheme" >}}
20+
Catalog theme object containing structure of the theme.
21+
{{< /parameter >}}
22+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/list_color_palettes.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@ weight: 200
99

1010
Returns a list of all color palettes in the current organization.
1111

12-
## Parameters
12+
{{% parameters-block title="Parameters" None="yes"%}}
13+
{{% /parameters-block %}}
1314

14-
_None_
15-
16-
## Returns
17-
18-
| type | description |
19-
| -- | -- |
20-
| list[CatalogColorPalette] | List of color palettes in the current organization. |
15+
{{% parameters-block title="Returns" %}}
16+
{{< parameter p_type="list[CatalogColorPalette]" >}}
17+
List of color palettes in the current organization.
18+
{{< /parameter >}}
19+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/list_themes.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@ weight: 100
99

1010
Returns a list of all themes in the current organization.
1111

12-
## Parameters
12+
{{% parameters-block title="Parameters" None="yes"%}}
13+
{{% /parameters-block %}}
1314

14-
_None_
15-
16-
## Returns
17-
18-
| type | description |
19-
| -- | -- |
20-
| list[CatalogTheme] | List of themes in the current organization. |
15+
{{% parameters-block title="Returns" %}}
16+
{{< parameter p_type="list[CatalogTheme]" >}}
17+
List of themes in the current organization.
18+
{{< /parameter >}}
19+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/update_color_palette.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,17 @@ weight: 230
99

1010
Update a color palette.
1111

12-
## Parameters
13-
14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| color_palette | CatalogColorPalette | A catalog color palette object to be updated. |
17-
18-
## Returns
19-
20-
_None_
21-
22-
## Raises
23-
24-
| type | description |
25-
| -- | -- |
26-
| ValueError | Color palette does not exist. |
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="color_palette" p_type="CatalogColorPalette" >}}
14+
A catalog color palette object to be updated.
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
17+
18+
{{% parameters-block title="Returns" None="yes"%}}
19+
{{% /parameters-block %}}
20+
21+
{{% parameters-block title="Raises" %}}
22+
{{< parameter p_type="Value Error" >}}
23+
Color palette does not exist.
24+
{{< /parameter >}}
25+
{{% /parameters-block %}}

‎docs/content/en/latest/administration/appearance/update_theme.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,17 @@ weight: 130
99

1010
Update a theme.
1111

12-
## Parameters
13-
14-
| parameter | type | description |
15-
| -- | -- | -- |
16-
| theme | CatalogTheme | A catalog theme object to be updated. |
17-
18-
## Returns
19-
20-
_None_
21-
22-
## Raises
23-
24-
| type | description |
25-
| -- | -- |
26-
| ValueError | Theme does not exist. |
12+
{{% parameters-block title="Parameters" %}}
13+
{{< parameter p_name="theme" p_type="CatalogTheme" >}}
14+
A catalog theme object to be updated.
15+
{{< /parameter >}}
16+
{{% /parameters-block %}}
17+
18+
{{% parameters-block title="Returns" None="yes"%}}
19+
{{% /parameters-block %}}
20+
21+
{{% parameters-block title="Raises" %}}
22+
{{< parameter p_type="Value Error" >}}
23+
Theme does not exist.
24+
{{< /parameter >}}
25+
{{% /parameters-block %}}

0 commit comments

Comments
 (0)