Draft: customizable HTML Title
What does this MR do?
Customization of last element of HTML Title (currently hardcoded to "GitLab") using Admin Area -> Settings -> General.
NOTE: It is early prototype - please see Questions section at the end of this MR.
There is already older issue for this request:
- current issue #15075
- original issue in GitLab FOSS: gitlab-foss#14241 (moved)
- duplicate issue in GitLab FOSS: gitlab-foss#54088 (closed)
Screenshots or Screencasts (strongly suggested)
How to setup and validate locally (strongly suggested)
- Login to your GitLab
- Notice last element of HTML Title
- Go to Admin Area -> Settings -> General
- Expand "HTML Header"
- Verify that text-field "Site Name" value matches last element from HTML Title
- Change value of text-field "Site Name"
- click on "Save changes
- Verify that last element of HTML Title changes to value entered in text-field.
Does this MR meet the acceptance criteria?
Not yet. It is PoC.
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Migration Up/Down
Here is database migration dump:
$ gdk stop
$ gdk start postgresql
$ cd gitlab
$ rails db:migrate:up VERSION=20210906085213
== 20210906085213 AddSiteNameApplicationSetting: migrating ====================
-- add_column(:application_settings, :site_name, :string, {:default=>"GitLab", :null=>false})
-> 0.0051s
== 20210906085213 AddSiteNameApplicationSetting: migrated (0.0052s) ===========
$ rails db:migrate:down VERSION=20210906085213
== 20210906085213 AddSiteNameApplicationSetting: reverting ====================
-- remove_column(:application_settings, :site_name, :string, {:default=>"GitLab", :null=>false})
-> 0.0047s
== 20210906085213 AddSiteNameApplicationSetting: reverted (0.0570s) ===========
Questions
- I added this field
site_name
to modelapplication_setting
. Should I rather useappearance
for such purpose? - Should I add this field
site_name
as mandatory to API (thus breaking existing clients)?
Edited by Henryk Paluch