Skip to content

Commit 842aba7

Browse files
stevsmitSteven Smith
stevsmit
and
Steven Smith
authored
Adds footer config fields to config guide (#1247)
Co-authored-by: Steven Smith <[email protected]>
1 parent cd25ddf commit 842aba7

File tree

4 files changed

+106
-6
lines changed

4 files changed

+106
-6
lines changed

‎config_quay/master.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ include::modules/config-fields-legacy.adoc[leveloffset=+2]
8989
include::modules/config-fields-v2-ui.adoc[leveloffset=+2]
9090
include::modules/config-fields-ipv6.adoc[leveloffset=+2]
9191
include::modules/config-fields-branding.adoc[leveloffset=+2]
92+
include::modules/config-fields-footer.adoc[leveloffset=+2]
9293
include::modules/config-fields-session-logout.adoc[leveloffset=+2]
9394

9495
include::modules/config-envvar-intro.adoc[leveloffset=+1]

‎modules/config-fields-footer.adoc

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
:_content-type: CONCEPT
2+
[id="config-fields-footer"]
3+
= UI footer configuration fields
4+
5+
The following configuration fields have been added to the original (v1) UI. You can use these fields to customize the footer of your on-prem v1 UI.
6+
7+
|===
8+
| Field | Type | Description
9+
10+
|*FOOTER_LINKS* |Object | Enable customization of footer links in {productname}'s UI for on-prem installations.
11+
12+
|*.TERMS_OF_SERVICE_URL* | String | Custom terms of service for on-prem installations. +
13+
+
14+
**Example:** +
15+
`https://index.hr`
16+
17+
|*.PRIVACY_POLICY_URL* | String | Custom privacy policy for on-prem installations. +
18+
+
19+
**Example:** +
20+
`https://example.hr`
21+
|*.SECURITY_URL* | String | Custom security page for on-prem installations. +
22+
+
23+
**Example:** +
24+
`https://example.hr`
25+
26+
| **.ABOUT_URL** | String | Custom about page for on-prem installations. +
27+
+
28+
**Example:** +
29+
`https://example.hr`
30+
|===
31+
32+
.Example footer links YAML
33+
[source,yaml]
34+
----
35+
FOOTER_LINKS:
36+
"TERMS_OF_SERVICE_URL": "https://www.index.hr"
37+
"PRIVACY_POLICY_URL": "https://www.example.hr"
38+
"SECURITY_URL": "https://www.example.hr"
39+
"ABOUT_URL": "https://www.example.hr"
40+
----

‎modules/config-updates-314.adoc

+47-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The following sections detail new configuration fields added in {productname} 3.14.
66

77
[id="model-card-rendering"]
8-
== Model card rendering
8+
== Model card rendering configuration fields
99

1010
The following configuration fields have been added to support model card rendering on the v2 UI.
1111

@@ -31,4 +31,49 @@ UI_MODELCARD_LAYER_ANNOTATION: <4>
3131
<1> Enables the ModelCard image tab in the UI.
3232
<2> Defines the model card artifact type. In this example, the artifact type is `application/x-mlmodel`.
3333
<3> Optional. If an image does not have an `artifactType` defined, this field is checked at the manifest level. If a matching annotation is found, the system then searches for a layer with an annotation matching `UI_MODELCARD_LAYER_ANNOTATION`.
34-
<4> Optional. If an image has an `artifactType` defined and multiple layers, this field is used to locate the specific layer containing the model card.
34+
<4> Optional. If an image has an `artifactType` defined and multiple layers, this field is used to locate the specific layer containing the model card.
35+
36+
[id="new-quay-footer-fields"]
37+
== Footer configuration fields
38+
39+
The following configuration fields have been added to the original (v1) UI. You can use these fields to customize the footer of your on-prem v1 UI.
40+
41+
[NOTE]
42+
====
43+
These fields are currently unavailable on the {productname} v2 UI.
44+
====
45+
46+
|===
47+
| Field | Type | Description
48+
49+
|*FOOTER_LINKS* |Object | Enable customization of footer links in {productname}'s UI for on-prem installations.
50+
51+
|*.TERMS_OF_SERVICE_URL* | String | Custom terms of service for on-prem installations. +
52+
+
53+
**Example:** +
54+
`https://index.hr`
55+
56+
|*.PRIVACY_POLICY_URL* | String | Custom privacy policy for on-prem installations. +
57+
+
58+
**Example:** +
59+
`https://index.hr`
60+
|*.SECURITY_URL* | String | Custom security page for on-prem installations. +
61+
+
62+
**Example:** +
63+
`https://index.hr`
64+
65+
| **.ABOUT_URL** | String | Custom about page for on-prem installations. +
66+
+
67+
**Example:** +
68+
`https://index.hr`
69+
|===
70+
71+
.Example footer links YAML
72+
[source,yaml]
73+
----
74+
FOOTER_LINKS:
75+
"TERMS_OF_SERVICE_URL": "https://www.index.hr"
76+
"PRIVACY_POLICY_URL": "https://www.example.hr"
77+
"SECURITY_URL": "https://www.example.hr"
78+
"ABOUT_URL": "https://www.example.hr"
79+
----

‎modules/rn_3_14_0.adoc

+18-4
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,25 @@ These fields are currently unavailable on the {productname} v2 UI.
9999
| Field | Type | Description
100100

101101
|*FOOTER_LINKS* |Object | Enable customization of footer links in {productname}'s UI for on-prem installations.
102-
|*.TERMS_OF_SERVICE_URL* | String | Custom terms of service for on-prem installations.
103-
|*.PRIVACY_POLICY_URL* | String | Custom privacy policy for on-prem installations
104-
|*.SECURITY_URL* | String | Custom security page for on-prem installations.
105-
|*.ABOUT_URL* | String | Custom about page for on-prem installations.
106102

103+
|*.TERMS_OF_SERVICE_URL* | String | Custom terms of service for on-prem installations. +
104+
+
105+
**Example:** +
106+
`https://index.hr`
107+
108+
|*.PRIVACY_POLICY_URL* | String | Custom privacy policy for on-prem installations. +
109+
+
110+
**Example:** +
111+
`https://index.hr`
112+
|*.SECURITY_URL* | String | Custom security page for on-prem installations. +
113+
+
114+
**Example:** +
115+
`https://index.hr`
116+
117+
| **.ABOUT_URL** | String | Custom about page for on-prem installations. +
118+
+
119+
**Example:** +
120+
`https://index.hr`
107121
|===
108122

109123
.Example footer links YAML

0 commit comments

Comments
 (0)