[JENKINS-43786] Blog post about JENKINS-43786 - #1327
Merged
Conversation
|
The context from the Jenkins Pipeline run is: |
|
The context from the Jenkins Pipeline run is: |
|
The context from the Jenkins Pipeline run is: |
oleg-nenashev
self-requested a review
January 14, 2018 20:22
Contributor
Author
|
Please, do not hesitate to correct my English, don't be afraid 😄 |
|
|
||
| Some of the goals that we have tried to achieve: | ||
|
|
||
| * Apply a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] |
|
|
||
| * Apply a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] | ||
| * Remove the `<table>` tag usage for implementing layouts and content structures. Read this https://www.hotdesign.com/seybold[article] if you want to know reasons and / or arguments. | ||
| * Small re-style focused on spacing, margins, composition, etc.. |
|
|
||
| == Overview | ||
|
|
||
| Recently we have introduced some UI improvements around to the Manage Jenkins page. The visual changes are very subtle but behind of them, there are interesting benefits. |
There was a problem hiding this comment.
A passive voice sounds better ==> "Some UI improvements around to the Manage Jenkins page have been introduced"
|
|
||
| Some of the goals that we have tried to achieve: | ||
|
|
||
| * Apply a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] |
|
|
||
| * Apply a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] | ||
| * Remove the `<table>` tag usage for implementing layouts and content structures. Read this https://www.hotdesign.com/seybold[article] if you want to know reasons and / or arguments. | ||
| * Small re-style focused on spacing, margins, composition, etc.. |
|
|
||
| image:/images/post-images/2018-01-15-JENKINS-43786/JENKINS-43786_1.png[role="center"] | ||
|
|
||
| In the following section you will find information about how this change can affect to the current implementations of the https://jenkins.io/doc/developer/extensions/jenkins-core/#administrativemonitor[Administrative Monitors]. |
There was a problem hiding this comment.
The passive voice sounds better IMHO ==> "Information about how this change can affect to the current implementations can be found in the following section"
|
|
||
| If you don't want to keep a _strict_ backward compatibility, the impact is minimum. In fact, you can see an https://github.com/jenkinsci/github-plugin/pull/177#issuecomment-337266953[example] on GitHub Plugin. | ||
|
|
||
| Some helpful links: |
|
|
||
| * Apply a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] | ||
| * Applying a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] | ||
| * Remove the `<table>` tag usage for implementing layouts and content structures. Read this https://www.hotdesign.com/seybold[article] if you want to know reasons and / or arguments. |
There was a problem hiding this comment.
"Remove" ==> "Removing". I missed this one
vilacides
reviewed
Jan 15, 2018
| * Small re-styling focused on spacing, margins, composition, etc.. | ||
| * Accesibility | ||
|
|
||
| In order to provide a quick view of the visual changes, let's take a look at these screenshots. |
|
|
||
| == For core developers | ||
|
|
||
| Let's use an real example for showing how this proposal works. |
Contributor
There was a problem hiding this comment.
Typo: 'a real example'
amuniz
reviewed
Jan 15, 2018
|
|
||
| == Overview | ||
|
|
||
| Recently some UI improvements around to the Manage Jenkins page have been introduced. The visual changes are very subtle but behind of them, there are interesting benefits. |
Contributor
There was a problem hiding this comment.
around to the Manage Jenkins --> around the Manage Jenkins
|
|
||
| == For core developers | ||
|
|
||
| Let's use an real example for showing how this proposal works. |
Contributor
There was a problem hiding this comment.
Let's use an real example --> Let's use a real example
|
|
||
| == For plugin developers | ||
|
|
||
| No change are _really_ needed, but we do recommend you to adapt your plugins to this proposal so Jenkins users have a better user experience. |
Contributor
There was a problem hiding this comment.
No change are --> No changes are
| } | ||
| ---- | ||
|
|
||
| In your view (a.k.a. Jelly file): |
vilacides
reviewed
Jan 15, 2018
| Some of the goals that we have tried to achieve: | ||
|
|
||
| * Applying a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] | ||
| * Removing the `<table>` tag usage for implementing layouts and content structures. Read this https://www.hotdesign.com/seybold[article] if you want to know reasons and / or arguments. |
vilacides
reviewed
Jan 15, 2018
| * Applying a https://en.wikipedia.org/wiki/Semantic_HTML[semantic HTML] | ||
| * Removing the `<table>` tag usage for implementing layouts and content structures. Read this https://www.hotdesign.com/seybold[article] if you want to know reasons and / or arguments. | ||
| * Small re-styling focused on spacing, margins, composition, etc.. | ||
| * Accesibility |
vilacides
reviewed
Jan 15, 2018
|
|
||
| image:/images/post-images/2018-01-15-JENKINS-43786/JENKINS-43786_1.png[role="center"] | ||
|
|
||
| Information about how this change can affect to the current implementations of https://jenkins.io/doc/developer/extensions/jenkins-core/#administrativemonitor[Administrative Monitors] can be found in the following section |
There was a problem hiding this comment.
can affect the current implementation (without the "to" and implementation in singular unless there is more than one)
vilacides
reviewed
Jan 15, 2018
| </j:jelly> | ||
| ---- | ||
|
|
||
| If you don't want to keep a _strict_ backward compatibility, the impact is minimum. In fact, you can see an https://github.com/jenkinsci/github-plugin/pull/177#issuecomment-337266953[example] on GitHub Plugin. |
vilacides
reviewed
Jan 15, 2018
| Some helpful references: | ||
|
|
||
| * https://issues.jenkins-ci.org/browse/JENKINS-43786[JIRA issue] where the proposal was tracked | ||
| * https://github.com/jenkinsci/jenkins/pull/2857[Pull Request] with change in Jenkins core. You can find several screenshots |
|
Looks pretty good, only some minor changes! |
Contributor
Author
|
@fcojfernandez, @carlosrodlop, @amuniz, @vilacides, thanks so much for your reviews! I really appreciate it. |
carlosrodlop
approved these changes
Jan 15, 2018
| ---- | ||
|
|
||
| If you don't want to keep a _strict_ backward compatibility, the impact is minimal. In fact, you can see an https://github.com/jenkinsci/github-plugin/pull/177#issuecomment-337266953[example] on GitHub Plugin. | ||
|
|
There was a problem hiding this comment.
I'd add here a separate reference section
|
|
||
| image:/images/post-images/2018-01-15-JENKINS-43786/JENKINS-43786_1.png[role="center"] | ||
|
|
||
| Information about how this change can affect the current implementations of https://jenkins.io/doc/developer/extensions/jenkins-core/#administrativemonitor[Administrative Monitors] can be found in the following section |
There was a problem hiding this comment.
can be found in the following sections depending on the scope:
andresrc
approved these changes
Jan 15, 2018
|
|
||
| == Overview | ||
|
|
||
| Recently some UI improvements around the Manage Jenkins page have been introduced. The visual changes are very subtle but behind of them, there are interesting benefits. |
|
🐝 |
omehegan
approved these changes
Jan 16, 2018
omehegan
left a comment
omehegan
left a comment
Contributor
There was a problem hiding this comment.
I've read this in its current form and it looks good!
Contributor
|
Wait for feature commit before merging this. jenkinsci/jenkins#2857 |
Contributor
Author
|
@bitwiseman Sure, this is the plan 😄 |
Contributor
|
@recena nice - I know this was a lot of work! kudos. |
oleg-nenashev
approved these changes
Jan 20, 2018
oleg-nenashev
left a comment
oleg-nenashev
left a comment
Contributor
There was a problem hiding this comment.
LGTM. @recena could you please change the blogpost date to Jan 21? I am ready to merge the change
| - jenkins | ||
| - ui | ||
| - restyling | ||
| author: recena |
Contributor
There was a problem hiding this comment.
FYI author page is missing in https://github.com/jenkins-infra/jenkins.io/tree/master/content/_data/authors . I would also suggest adding an avatar to https://github.com/jenkins-infra/jenkins.io/tree/master/content/images/avatars (new feature)
Contributor
Author
There was a problem hiding this comment.
I'll address this subject in a new PR.
| tags: | ||
| - jenkins | ||
| - ui | ||
| - restyling |
Contributor
There was a problem hiding this comment.
I would rather replace it with "upgrade" which we use in other similar cases
Contributor
Author
There was a problem hiding this comment.
I've just added upgrade as well because restyling (IMHO) is a right term to define what we have done here. And we could use in upcoming UI improvements.
Contributor
Author
|
I'll do in few minutes....walking with my 🐕 |
…ly release where those changes will be available
Contributor
Author
|
@oleg-nenashev Done. |
oleg-nenashev
approved these changes
Jan 21, 2018
oleg-nenashev
left a comment
oleg-nenashev
left a comment
Contributor
There was a problem hiding this comment.
Image names still refer the old date, but I am fine with that. 🚢 🇮🇹 , I'd guess
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
11 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
JENKINS-43786
This blog post was a commitment during the development of jenkinsci/jenkins#2857
Downstream of jenkinsci/jenkins#2857
@jenkins-infra/copy-editors, especially @oleg-nenashev and @daniel-beck