Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve log record icon #7217

Merged
merged 2 commits into from
Oct 10, 2022
Merged

Improve log record icon #7217

merged 2 commits into from
Oct 10, 2022

Conversation

basil
Copy link
Member

@basil basil commented Oct 4, 2022

A full file tray icon is used for build history, as seen here. An empty file tray is used for log records. Apart from raising confusing questions about why one tray is empty and the other is full, I do not think it makes sense to use the same icon for both things: one is a historical record of a build, which very much seems like the type of thing you would "file away" for future reference in the physical world, but the system log is a short-term record of events, more analogous to a journal in the physical world. Indeed, the logging framework in systemd is called systemd-journald, and journaling file systems have been around for decades.

Before

system-log-before

and

log-records-before

After

system-log-after

and

log-records-after

Proposed changelog entries

  • Use a more appropriate icon for log records.

Proposed upgrade guidelines

N/A

Submitter checklist

  • The Jira issue, if it exists, is well-described.
  • 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.
  • There is automated testing or an explanation as to why this change has no tests.
  • New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
  • New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
  • 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).
  • For dependency updates, there are links to external changelogs and, if possible, full differentials.
  • For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@mention

Maintainer checklist

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

  • There are at least two (2) approvals for the pull request and no outstanding requests for change.
  • Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
  • Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
  • Proper changelog labels are set so that the changelog can be generated automatically.
  • 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).
  • 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).

@basil basil added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Oct 4, 2022
Copy link
Member

@NotMyFault NotMyFault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the backside of a bank card is quite suitable to access Jenkins' logs 🤔

@basil
Copy link
Member Author

basil commented Oct 4, 2022

Good thing, then, that I am not proposing to introduce the back side of a bank card. I am proposing to introduce a journal: https://www.amazon.com/Moleskine-Classic-Cover-Notebook-Ruled/dp/8883701127

@NotMyFault NotMyFault added the web-ui The PR includes WebUI changes which may need special expertise label Oct 4, 2022
@NotMyFault NotMyFault requested a review from a team October 4, 2022 17:20
@basil
Copy link
Member Author

basil commented Oct 4, 2022

Note that ionicons has a separate card icon, which does indeed look like the back side of a bank card. I am explicitly not using that icon in this PR, so as far as I can tell the criticism in the preceding review is not valid.

@timja
Copy link
Member

timja commented Oct 4, 2022

While it may be called journal it looks a bit strange to me.

Would reader-outline be any better?

image

@basil
Copy link
Member Author

basil commented Oct 4, 2022

While it may be called journal it looks a bit strange to me.

Looks fine to me, and apparently to the ionicon developers as well, because otherwise they would not have created distinct card and journal icons.

Would reader-outline be any better?

I do not see any reason why it would.

@basil
Copy link
Member Author

basil commented Oct 5, 2022

As far as I can tell there is no objection to the journal concept, just a dislike of the appearance of the journal icon in Ionicons. That would be a valid reason to withhold approval of a pull request that proposes to adopt Ionicons as the official icon set of the Jenkins project, but it is not a valid reason to withhold approval of a pull request that applies an appropriate icon from the already officially chosen icon set of the Jenkins project, Ionicons.

Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure let's try it

@NotMyFault
Copy link
Member

NotMyFault commented Oct 5, 2022

Holding back a review is not my intention 👀

This PR is now ready for merge. We will merge it after ~24 hours if there is no negative feedback.
Please see the merge process documentation for more information about the merge process.
Thanks!

@NotMyFault NotMyFault added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Oct 5, 2022
@NotMyFault NotMyFault added the hacktoberfest-accepted Regardless of the change status, this is a valid Hacktoberfest PR label Oct 5, 2022
@basil basil merged commit 7e52653 into jenkinsci:master Oct 10, 2022
@basil basil deleted the log-record-icon branch October 10, 2022 15:49
anurag-harness pushed a commit to anurag-harness/jenkins that referenced this pull request Oct 17, 2022
anurag-harness added a commit to anurag-harness/jenkins that referenced this pull request Oct 17, 2022
Co-authored-by: Basil Crow <me@basilcrow.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Regardless of the change status, this is a valid Hacktoberfest PR ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback 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
Projects
None yet
3 participants