diff --git a/config_quay/master.adoc b/config_quay/master.adoc index a6f9e0faf..b5c5c42e8 100644 --- a/config_quay/master.adoc +++ b/config_quay/master.adoc @@ -69,6 +69,7 @@ include::modules/config-fields-misc.adoc[leveloffset=+2] include::modules/config-fields-legacy.adoc[leveloffset=+2] include::modules/config-fields-v2-ui.adoc[leveloffset=+2] include::modules/config-fields-ipv6.adoc[leveloffset=+2] +include::modules/config-fields-branding.adoc[leveloffset=+2] include::modules/config-envvar-intro.adoc[leveloffset=+1] include::modules/config-envvar-georepl.adoc[leveloffset=+2] diff --git a/manage_quay/master.adoc b/manage_quay/master.adoc index aa92b20de..90602476d 100644 --- a/manage_quay/master.adoc +++ b/manage_quay/master.adoc @@ -137,9 +137,13 @@ include::modules/restoring-red-hat-quay-standalone.adoc[leveloffset=+2] include::modules/garbage-collection.adoc[leveloffset=+1] +//branding +include::modules/branding-quay-deployment.adoc[leveloffset=+1] + include::modules/proc_manage-quay-troubleshooting.adoc[leveloffset=+1] include::modules/con_schema.adoc[leveloffset=+1] + [discrete] == Additional resources diff --git a/modules/branding-quay-deployment.adoc b/modules/branding-quay-deployment.adoc new file mode 100644 index 000000000..49ee96569 --- /dev/null +++ b/modules/branding-quay-deployment.adoc @@ -0,0 +1,34 @@ +:_content-type: CONCEPT +[id="branding-quay-deployment"] += Customizing a {productname} deployment + +You can customize your {productname} deployment by changing the registry title, logo, footer image, and by directing users to a website embedded in the footer image. + +.Procedure + +. Update your {productname} `config.yaml` file to add the following parameters: ++ +[source,yaml] +---- +BRANDING: + logo: <1> + footer_img: <2> + footer_url: <3> +--- +REGISTRY_TITLE: <4> +REGISTRY_TITLE_SHORT: <5> +---- +<1> The URL of the image that will appear at the top of your {productname} deployment. +<2> The URL of the image that will appear at the bottom of your {productname} deployment. +<3> The URL of the website that users will be directed to when clicking the footer image. +<4> The the long-form title for the registry. This is displayed in frontend of your {productname} deployment, for example, at the sign in page of your organization. +<5> The short-form title for the registry. The title is displayed on various pages of your organization, for example, as the title of the tutorial on your organization's *Tutorial* page. + +. Restart your {productname} deployment. After restarting, your {productname} deployment is updated with a new logo, footer image, and footer image URL. + +//// + +[role="_additional-resources"] +== Additional resources + +* \ No newline at end of file diff --git a/modules/config-fields-basic.adoc b/modules/config-fields-basic.adoc index e5f156306..c4f76a1e0 100644 --- a/modules/config-fields-basic.adoc +++ b/modules/config-fields-basic.adoc @@ -5,56 +5,56 @@ [cols="3a,1a,2a",options="header"] |=== | Field | Type | Description -| **REGISTRY_TITLE** | String | If specified, the long-form title for the registry. It should not exceed 35 characters. It will be displayed in the frontend of your {productname} deployment, for example, in your browser tab + - + -**Default:** + +| **REGISTRY_TITLE** | String | If specified, the long-form title for the registry. Displayed in frontend of your {productname} deployment, for example, at the sign in page of your organization. Should not exceed 35 characters. + + +**Default:** + `Red Hat Quay` -| **REGISTRY_TITLE_SHORT** | String | If specified, the short-form title for the registry. It will be displayed in the frontend of your {productname} deployment, for example, in your browser tab + - + -**Default:** + +| **REGISTRY_TITLE_SHORT** | String | If specified, the short-form title for the registry. Title is displayed on various pages of your organization, for example, as the title of the tutorial on your organization's *Tutorial* page. + + +**Default:** + `Red Hat Quay` | {nbsp} | {nbsp} |{nbsp} | **BRANDING** | Object | Custom branding for logos and URLs in the {productname} UI. -| **.logo** + -(Required) | String | Main logo image URL. + - + -**Example:** + +| **.logo** + +(Required) | String | Main logo image URL. + + + +**Example:** + `/static/img/quay-horizontal-color.svg` -| **.footer_img** | String | Logo for UI footer. + - + -**Example:** + +| **.footer_img** | String | Logo for UI footer. + + + +**Example:** + `/static/img/RedHat.svg` -| **.footer_url** | String | Link for footer image. + - + -**Example:** + +| **.footer_url** | String | Link for footer image. + + + +**Example:** + `https://redhat.com` | **CONTACT_INFO** | Array of String | If specified, contact information to display on the contact page. If only a single piece of contact information is specified, the contact footer will link directly. -|**[0]** | String | Adds a link to send an e-mail. + - + -**Pattern:** + -`^mailto:(.)+$` + -**Example:** + +|**[0]** | String | Adds a link to send an e-mail. + + + +**Pattern:** + +`^mailto:(.)+$` + +**Example:** + `mailto:support@quay.io` -|**[1]** | String | Adds a link to visit an IRC chat room. + - + -**Pattern:** + -`^irc://(.)+$` + -**Example:** + +|**[1]** | String | Adds a link to visit an IRC chat room. + + + +**Pattern:** + +`^irc://(.)+$` + +**Example:** + `irc://chat.freenode.net:6665/quay` |**[2]** | String | Adds a link to call a phone number.+ - + -**Pattern:** + -`^tel:(.)+$` + -**Example:** + + + +**Pattern:** + +`^tel:(.)+$` + +**Example:** + `tel:+1-888-930-3475` -|**[3]** | String |Adds a link to a defined URL. + - + -**Pattern:** + -`^http(s)?://(.)+$` + -**Example:** + +|**[3]** | String |Adds a link to a defined URL. + + + +**Pattern:** + +`^http(s)?://(.)+$` + +**Example:** + `https://twitter.com/quayio` |=== \ No newline at end of file diff --git a/modules/config-fields-branding.adoc b/modules/config-fields-branding.adoc new file mode 100644 index 000000000..01fa840a8 --- /dev/null +++ b/modules/config-fields-branding.adoc @@ -0,0 +1,28 @@ +:_content-type: CONCEPT +[id="config-fields-branding"] += Branding configuration fields + +.Branding configuration fields +[cols="3a,1a,2a",options="header"] +|=== +|Field | Type |Description +| **BRANDING** | Object | Configuration for {productname} branding. + +| **logo** | String | The URL scheme to be used for the top image of your {productname} deployment. + +| **footer_img** | String | The URL scheme to be used for the footer image of your {productname} deployment. + +| **footer_url** | String | The URL scheme of the website that users will be directed to when clicking the footer image. +|=== + +[id="example-config-fields-branding"] +== Example configuration for {productname} branding + +.Branding config.yaml example +[source,yaml] +---- +BRANDING: + logo: https://www.mend.io/wp-content/media/2020/03/5-tips_small.jpg + footer_img: https://www.mend.io/wp-content/media/2020/03/5-tips_small.jpg + footer_url: https://opensourceworld.org/ +---- \ No newline at end of file diff --git a/modules/proc_creating-ocp-secret-for-oauth-token.adoc b/modules/proc_creating-ocp-secret-for-oauth-token.adoc index a28a107b7..a5c8e2b8b 100644 --- a/modules/proc_creating-ocp-secret-for-oauth-token.adoc +++ b/modules/proc_creating-ocp-secret-for-oauth-token.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -[[creating-ocp-secret-for-oauth-token]] +[id="creating-ocp-secret-for-oauth-token"] = Creating an {ocp} secret for the OAuth token In this procedure, you will add the previously obtained access token to communicate with your {productname} deployment. The access token will be stored within {ocp} as a secret. diff --git a/modules/proc_creating-quay-integration-cr.adoc b/modules/proc_creating-quay-integration-cr.adoc index 3bf2105e5..fa356cf9b 100644 --- a/modules/proc_creating-quay-integration-cr.adoc +++ b/modules/proc_creating-quay-integration-cr.adoc @@ -1,6 +1,6 @@ :_content-type: PROCEDURE -[[creating-quay-integration-cr]] -== Creating the QuayIntegration custom resource +[id="creating-quay-integration-cr"] += Creating the QuayIntegration custom resource In this procedure, you will create a `QuayIntegration` custom resource, which can be completed from either the web console or from the command line. @@ -11,7 +11,7 @@ In this procedure, you will create a `QuayIntegration` custom resource, which ca * An {ocp} 4.6 or greater environment for which you have cluster administrator permissions. * Optional: You have installed the OpenShift CLI (oc). -=== Optional: Creating the QuayIntegration custom resource using the CLI +== Optional: Creating the QuayIntegration custom resource using the CLI Follow this procedure to create the `QuayIntegration` custom resource using the command line. diff --git a/modules/proc_installing-qbo-on-ocp.adoc b/modules/proc_installing-qbo-on-ocp.adoc index ffe0c94db..d8075bd5f 100644 --- a/modules/proc_installing-qbo-on-ocp.adoc +++ b/modules/proc_installing-qbo-on-ocp.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -[[installing-qbo-on-ocp]] +[id="installing-qbo-on-ocp"] = Installing the {qbo} on {ocp} In this procedure, you will install the {qbo} on {ocp}. diff --git a/modules/proc_setting-up-quay-for-qbo.adoc b/modules/proc_setting-up-quay-for-qbo.adoc index 10f88c90d..cf6509183 100644 --- a/modules/proc_setting-up-quay-for-qbo.adoc +++ b/modules/proc_setting-up-quay-for-qbo.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -[[setting-up-quay-for-qbo]] +[id="setting-up-quay-for-qbo"] = Setting up {productname} for the {qbo} In this procedure, you will create a dedicated {productname} organization, and from a new application created within that organization you will generate an OAuth token to be used with the {qbo} in {ocp}. diff --git a/modules/ref_quay-integration-config-fields.adoc b/modules/ref_quay-integration-config-fields.adoc index 08456df00..055ef44be 100644 --- a/modules/ref_quay-integration-config-fields.adoc +++ b/modules/ref_quay-integration-config-fields.adoc @@ -1,6 +1,5 @@ :_content-type: REFERENCE -[[quay-integration-config-fields]] - +[id="quay-integration-config-fields"] = QuayIntegration configuration fields The following configuration fields are available for the QuayIntegration custom resource: