Add `Appearance` system configuration page #8403

timja · 2023-08-21T07:16:54Z

This adds a new system configuration page 'Appearance' for configuring the look and feel of Jenkins.
It moves a bit of config out of the main System page into a more appropriate place.

Screenshots

It implements the design from https://jenkins-redesign.vercel.app/settings/appearance

It complements #8379 but doesn't require it

I've gone through a number of plugins that contribute UI and have sent pull requests for:

TODO

Give feedback

Move configuration to appearance page simple-theme-plugin#156

6 of 6

enhancement
Edit...
Successfully updated the issue's project

There was an error updating the issue's project
Move configuration to appearance page theme-manager-plugin#210

6 of 6

enhancement
Edit...
Successfully updated the issue's project

There was an error updating the issue's project
Move configuration to appearance page customizable-header-plugin#15

6 of 6

breaking enhancement
Edit...
Successfully updated the issue's project

There was an error updating the issue's project
Move configuration to appearance page prism-api-plugin#109

6 of 6

enhancement
Edit...
Successfully updated the issue's project

There was an error updating the issue's project
Options

I have gone for ones that directly affect the look and feel of Jenkins rather than ones that affect builds like ansicolor.
Any other suggestions?

After #7268 is in the user profile page can be updated to match.

Could possibly move the Display notification URL provider to appearance too? (the thing that selects Classic, Blue Ocean or Pipeline Graph View)

Testing done

Started Jenkins with no plugins contributing to the appearance category, the page doesn't show.

Installed jenkinsci/theme-manager-plugin#210, the page shows up and theme manager is on the appearance page and not on the system configuration page.

Unit test wise I don't think there's much value for it will something in core uses it, although happy to add something if its thought to be needed

Proposed changelog entries

Add appearance system configuration page

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.

The Jira issue, if it exists, is well-described.
Options
Successfully updated the issue's project

There was an error updating the issue's project
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see [examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.

The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
Options
Successfully updated the issue's project

There was an error updating the issue's project
There is automated testing or an explanation as to why this change has no tests.

There is automated testing or an explanation as to why this change has no tests.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.

New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.

New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New or substantially changed JavaScript is not defined inline and does not call `eval` to ease future introduction of Content Security Policy (CSP) directives (see [documentation](https://www.jenkins.io/doc/developer/security/csp/)).

New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
Options
Successfully updated the issue's project

There was an error updating the issue's project
For dependency updates, there are links to external changelogs and, if possible, full differentials.

For dependency updates, there are links to external changelogs and, if possible, full differentials.
Options
Successfully updated the issue's project

There was an error updating the issue's project
For new APIs and extension points, there is a link to at least one consumer.

For new APIs and extension points, there is a link to at least one consumer.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.

Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.

Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Proper changelog labels are set so that the changelog can be generated automatically.

Proper changelog labels are set so that the changelog can be generated automatically.
Options
Successfully updated the issue's project

There was an error updating the issue's project
If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](https://github.com/jenkinsci/jenkins/pull/4387)).

If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
Options
Successfully updated the issue's project

There was an error updating the issue's project
If it would make sense to backport the change to LTS, a Jira issue must exist, be a _Bug_ or _Improvement_, and be labeled as `lts-candidate` to be considered (see [query](https://issues.jenkins.io/issues/?filter=12146)).

If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

TobiX · 2023-08-22T09:22:40Z

Nice. https://plugins.jenkins.io/test-results-analyzer/ looks like an additional candidate, but mixes appearance settings with other settings...

Kevin-CB · 2023-08-24T16:53:29Z

From a security perspective, I see no blockers!

timja · 2023-08-24T21:47:49Z

Nice. plugins.jenkins.io/test-results-analyzer looks like an additional candidate, but mixes appearance settings with other settings...

I've had a look but I don't think it fits with the page that well.
I'm trying to have it be more for things that affect look and feel as a whole rather than some niche plugin config

janfaracik · 2023-08-25T19:51:11Z

I think this is great! LGTM.

Would be good to see something similar in #7268 if it's going forward.

NotMyFault

That's awesome!

timja · 2023-08-28T07:35:26Z

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

daniel-beck · 2023-08-28T08:02:22Z

It moves a bit of config out of the main System page into a more appropriate place.

Previously, creation of new config categories were motivated by overcrowding on the global configuration (Tools, Clouds, possibly Security as well – matrix-auth gets huge quickly). This doesn't seem to be the case here. What motivates this change, what's special about this config page that does not apply to tons of other potential categories?

Also, we should better define what goes here so plugin maintainers know what's appropriate to put there. The discussion about some plugins above indicates this isn't the case.

timja · 2023-08-28T09:59:35Z

Previously, creation of new config categories were motivated by overcrowding on the global configuration (Tools, Clouds, possibly Security as well – matrix-auth gets huge quickly). This doesn't seem to be the case here. What motivates this change, what's special about this config page that does not apply to tons of other potential categories?

This groups related elements together, originally I had started jenkinsci/theme-manager-plugin#105 but that would've been a breaking change at configuration level. This pull request #8379 then reminded of the design https://jenkins-redesign.vercel.app/settings/appearance. Which seemed like a much cleaner approach to solve the problem.

It means that you can configure the look and feel of Jenkins from one place without having to scroll all over the place to find it.

what's special about this config page that does not apply to tons of other potential categories

Other sensible categories could likely be added if there are enough sensible elements that would go there? e.g. possibly notifications?

Also, we should better define what goes here so plugin maintainers know what's appropriate to put there. The discussion about some plugins above indicates this isn't the case.

22b858b (#8403)

daniel-beck · 2023-08-28T10:23:29Z

Other sensible categories could likely be added if there are enough sensible elements that would go there? e.g. possibly notifications?

That makes sense if we move from "this is unwieldy, split it up" to "categories are based on loosely coupled semantic relationships between elements". That seems like a JEP-level change though given the downstream impact.

timja · 2023-08-28T12:04:21Z

Other sensible categories could likely be added if there are enough sensible elements that would go there? e.g. possibly notifications?

That makes sense if we move from "this is unwieldy, split it up" to "categories are based on loosely coupled semantic relationships between elements". That seems like a JEP-level change though given the downstream impact.

The javadoc already says that as far as I can tell

jenkins/core/src/main/java/jenkins/model/GlobalConfigurationCategory.java

Line 11 in 8ff1445

* Grouping of related {@link GlobalConfiguration}s.

jonesbusy · 2023-09-12T05:10:28Z

Looks login-theme-plugin was forgotten.

I've open a PR here : jenkinsci/login-theme-plugin#37

Regards,

KalleOlaviNiemitalo · 2023-11-21T07:59:25Z

On the System configuration page, I see a few settings that could perhaps be moved to Appearance:

"System Message" (Jenkins.systemMessage). Especially because the Customizable Header plugin has its own "System Message" setting on the Appearance page.
"ANSI Color": was already rejected above.
"Additional Sidebar Links" (Sidebar Link plugin): Didn't find an existing issue for this.
"Prism Syntax Highlighting Configuration" (Prism API plugin): Didn't find an existing issue for this.

If there's no objection, I think I'll file issues for the last two in a few days.

uhafner · 2023-11-21T09:28:53Z

"Prism Syntax Highlighting Configuration" (Prism API plugin): Didn't find an existing issue for this.

https://github.com/jenkinsci/prism-api-plugin/releases/tag/v1.29.0-9

jonesbusy · 2023-11-21T09:40:58Z

"Additional Sidebar Links" (Sidebar Link plugin): Didn't find an existing issue for this.

As a user of sidebar-link I think it should be moved to appearance as well. But you should check with maintainer. Not sure if there is "guidelines" of what is appearance and what is not

timja · 2023-11-21T14:44:28Z

"Additional Sidebar Links" (Sidebar Link plugin): Didn't find an existing issue for this.

As a user of sidebar-link I think it should be moved to appearance as well. But you should check with maintainer. Not sure if there is "guidelines" of what is appearance and what is not

Yeah it makes sense for that to go there, https://github.com/jenkinsci/jenkins/blob/master/core/src/main/java/jenkins/appearance/AppearanceCategory.java#L30-L41

Add Appearance system configuration page

3e12ca2

timja force-pushed the apperance-extension-point branch from eb29185 to 3e12ca2 Compare August 21, 2023 07:25

timja and others added 2 commits August 21, 2023 22:08

Use one-column layout

952f817

Merge branch 'master' into apperance-extension-point

1fac289

timja mentioned this pull request Aug 22, 2023

Move configuration to appearance page jenkinsci/theme-manager-plugin#210

Merged

timja added rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted web-ui The PR includes WebUI changes which may need special expertise labels Aug 22, 2023

timja mentioned this pull request Aug 22, 2023

Move configuration to appearance page jenkinsci/simple-theme-plugin#156

Merged

Kevin-CB added the security-approved @jenkinsci/core-security-review reviewed this PR for security issues label Aug 24, 2023

This was referenced Aug 24, 2023

Move configuration to appearance page jenkinsci/customizable-header-plugin#15

Merged

Move configuration to appearance page jenkinsci/prism-api-plugin#109

Merged

timja marked this pull request as ready for review August 24, 2023 21:48

timja requested a review from a team August 24, 2023 21:51

janfaracik approved these changes Aug 25, 2023

View reviewed changes

timja requested a review from a team August 25, 2023 20:04

NotMyFault approved these changes Aug 28, 2023

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Aug 28, 2023

Add developer guidance

22b858b

timja merged commit d7da362 into jenkinsci:master Aug 29, 2023
18 checks passed

timja deleted the apperance-extension-point branch August 29, 2023 08:32

jonesbusy mentioned this pull request Sep 12, 2023

Move configuration to appearance page jenkinsci/login-theme-plugin#37

Merged

daniel-beck mentioned this pull request Sep 27, 2023

[JENKINS-71715] Allow plugins with alternate build log visualizations to handle console links from core and other plugins #8321

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Appearance` system configuration page #8403

Add `Appearance` system configuration page #8403

timja commented Aug 21, 2023 •

edited

TODO

Submitter checklist

Maintainer checklist

TobiX commented Aug 22, 2023

Kevin-CB commented Aug 24, 2023

timja commented Aug 24, 2023 •

edited

janfaracik commented Aug 25, 2023

NotMyFault left a comment

timja commented Aug 28, 2023

daniel-beck commented Aug 28, 2023 •

edited

timja commented Aug 28, 2023

daniel-beck commented Aug 28, 2023

timja commented Aug 28, 2023

jonesbusy commented Sep 12, 2023

KalleOlaviNiemitalo commented Nov 21, 2023

uhafner commented Nov 21, 2023

jonesbusy commented Nov 21, 2023

timja commented Nov 21, 2023

Add Appearance system configuration page #8403

Add Appearance system configuration page #8403

Conversation

timja commented Aug 21, 2023 • edited

TODO

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

TobiX commented Aug 22, 2023

Kevin-CB commented Aug 24, 2023

timja commented Aug 24, 2023 • edited

janfaracik commented Aug 25, 2023

NotMyFault left a comment

Choose a reason for hiding this comment

timja commented Aug 28, 2023

daniel-beck commented Aug 28, 2023 • edited

timja commented Aug 28, 2023

daniel-beck commented Aug 28, 2023

timja commented Aug 28, 2023

jonesbusy commented Sep 12, 2023

KalleOlaviNiemitalo commented Nov 21, 2023

uhafner commented Nov 21, 2023

jonesbusy commented Nov 21, 2023

timja commented Nov 21, 2023

Add `Appearance` system configuration page #8403

Add `Appearance` system configuration page #8403

timja commented Aug 21, 2023 •

edited

timja commented Aug 24, 2023 •

edited

daniel-beck commented Aug 28, 2023 •

edited