move the add/edit description button to the app-bar #9271

mawinter69 · 2024-05-13T19:04:42Z

So far the add/edit description button is rendered on its own line to the far right. This leads to additional space between the description or the title and the following content.

This change moves the add/edit description button to the app-bar where applicable (jobs, runs, computers, users and labels). For views it stays as it is as they don't have a title/app-bar. One also can't just allow to change the description via the configure page as the All View has no configure page.

The change is backwards compatible so plugins using the editableDescription taglib will work as before.

Requires changes in Matrix-project and maven-project plugins to align the new layout

Before/after:

Job:

Before:

After:

A pipeline job:

Run:

Before:

After:

After clicking the Add Description button

User:

Before:

After:

Computer:

Before:

After:

Label:

Before:

After:

Testing done

Manual Testing

Proposed changelog entries

Move Add/Edit description to app bar

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

So far rhe add/edit description button is rendered as button on its own line to the far right. This leads to additional space the description or the title and the following content. This change moves the add/edit description button to the app-bar where applicable (jobs, runs, computers, users). For views it stays as it is as they don't have title/app-bar. One also can't just allow to change the description via the configure page as the All View has no configure page.

mawinter69 · 2024-05-14T20:17:13Z

Some questions to think about

make the add/edit description button a secondary button?
should I directly create an overflow button that takes add/edit description?

On the run page

also move the keep build forever to overflow?
move the info about when the build started and how long it took to the left like e.g. the info about the cause.

mawinter69 · 2024-05-18T13:05:23Z

@jenkinsci/sig-ux

janfaracik · 2024-05-19T21:07:48Z

Like it 👍

make the add/edit description button a secondary button?

Seems sensible yeah.

should I directly create an overflow button that takes add/edit description?

Could do, I do wonder how much benefit/use the 'Add description' button gets to warrant it existing - rather than just existing in the 'Configure' page.

also move the keep build forever to overflow?

Sounds good.

move the info about when the build started and how long it took to the left like e.g. the info about the cause.

Want to eventually move this section into its own extendable card (in a similar fashion to https://jenkins-redesign.vercel.app/project/build/375). I don't think the current summary components are the best use of space.

core/src/main/resources/hudson/model/Job/index.jelly

war/src/main/webapp/scripts/hudson-behavior.js

mawinter69 · 2024-05-20T13:30:22Z

Like it 👍

make the add/edit description button a secondary button?

Seems sensible yeah.

should I directly create an overflow button that takes add/edit description?

Could do, I do wonder how much benefit/use the 'Add description' button gets to warrant it existing - rather than just existing in the 'Configure' page.

also move the keep build forever to overflow?

Sounds good.

move the info about when the build started and how long it took to the left like e.g. the info about the cause.

Want to eventually move this section into its own extendable card (in a similar fashion to https://jenkins-redesign.vercel.app/project/build/375). I don't think the current summary components are the best use of space.

For now I only made the description button a secondary button.

- fix permission in job page - don't show the button for built-in node - improve jelly doc

Kevin-CB · 2024-05-28T12:38:59Z

LGTM security wise

timja

/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!

mawinter69 force-pushed the editable-description branch from 6f45d50 to f91788b Compare May 13, 2024 19:45

mawinter69 force-pushed the editable-description branch from f91788b to f519aed Compare May 14, 2024 12:59

NotMyFault added rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted needs-security-review Awaiting review by a security team member labels May 18, 2024

NotMyFault requested a review from a team May 18, 2024 14:34

timja requested a review from janfaracik May 18, 2024 19:58

mawinter69 added 2 commits May 20, 2024 00:45

Merge branch 'master' into editable-description

30d03dc

make secondary button

83d5c7e

yaroslavafenkin reviewed May 20, 2024

View reviewed changes

core/src/main/resources/hudson/model/Job/index.jelly Outdated Show resolved Hide resolved

war/src/main/webapp/scripts/hudson-behavior.js Show resolved Hide resolved

feedback

6a900a6

- fix permission in job page - don't show the button for built-in node - improve jelly doc

Kevin-CB added security-approved @jenkinsci/core-security-review reviewed this PR for security issues and removed needs-security-review Awaiting review by a security team member labels May 28, 2024

NotMyFault approved these changes May 28, 2024

View reviewed changes

timja approved these changes May 28, 2024

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 May 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

move the add/edit description button to the app-bar #9271

move the add/edit description button to the app-bar #9271

mawinter69 commented May 13, 2024 •

edited

Submitter checklist

Maintainer checklist

mawinter69 commented May 14, 2024 •

edited

mawinter69 commented May 18, 2024

janfaracik commented May 19, 2024

mawinter69 commented May 20, 2024

Kevin-CB commented May 28, 2024

timja left a comment

move the add/edit description button to the app-bar #9271

Are you sure you want to change the base?

move the add/edit description button to the app-bar #9271

Conversation

mawinter69 commented May 13, 2024 • edited

Before/after:

Job:

Run:

User:

Computer:

Label:

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

mawinter69 commented May 14, 2024 • edited

mawinter69 commented May 18, 2024

janfaracik commented May 19, 2024

mawinter69 commented May 20, 2024

Kevin-CB commented May 28, 2024

timja left a comment

Choose a reason for hiding this comment

mawinter69 commented May 13, 2024 •

edited

mawinter69 commented May 14, 2024 •

edited