Allow formatted markup for node descriptions

[mPokornyETM]

See JENKINS-XXXXX.

Proposed changelog entries

• Allow HTML syntax for node descriptions.
  Before
  

After

Proposed upgrade guidelines

No

Submitter checklist

• (If applicable) Jira issue is well described
• Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change) and are in the imperative mood. Examples
  • Fill-in the Proposed changelog entries section only if there are breaking changes or other changes which may require extra steps from users during the upgrade
• Appropriate autotests or explanation to why this change has no tests
  There are no changes in java code.
• New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadoc, as appropriate.
  There are no changes in java code.
• For dependency updates: links to external changelogs and, if possible, full diffs
  There are no changes in java code.

Desired reviewers

@mention

Maintainer checklist

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

• There are at least 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 does not block the change
• Changelog entries in the PR 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, upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the PR title. (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).

[NotMyFault]

This is a nice approach, but I'd recommend to stick to what's already in place.
For description input we're using a codemirror box, like seen on job or user descriptions, with optional syntax support, if enabled in the security realm.

Elevating a jenkins-input to be able to render HTML breaks with the existing handling for these kinds of text input.

[mPokornyETM]

I try to find some example. There is editableDescrption page but it does not work on this page. Because this page has an extra config page. Has you some idea?

[NotMyFault]

I try to find some example. There is editableDescrption page but it does not work on this page. Because this page has an extra config page. Has you some idea?

Changing the input from a textbox to a textarea in hudson.slaves.DumbSlave.configure-entries.jelly pointing the markup formatter to codemirror does generate named box.
Existing spots are for example hudson.model.Job.configure.jelly utilizing this feature.

[mPokornyETM]

So editable config description works too.

-->

The button to 'swicht temporally offline' is moved too. So it has the same look like in configure job page.
@NotMyFault thanks for hits.

[daniel-beck]

How does this look in matrix-project? I think that renders node descriptions and should be adapted.

Did you check whether project history explains why nodes have plain text nodeDescription but everything else has formatted description?

[mPokornyETM]

How does this look in matrix-project? I think that renders node descriptions and should be adapted.
No I have no idea, newer use it, but I will try it and get feedback here

Did you check whether project history explains why nodes have plain text nodeDescription but everything else has formatted description?

Nope, I was just angry, because we can not use longer description. We want to fill the description dynamically to get some node specific info when is started / used. Ex:

• installed tools and their versions like git, java ...
• real platform name (the platform labeler plugin does not work as expected for us)
• IpConfig
• Reboot history, we need to reboot the nodes many times during our 'build' process
  ....

So we need bigger description field.

But I will try to find the reason. It was also terrible for me to fix it, because you true anywhere else it is description

[mPokornyETM]

matrix-project

So the matrix-project renders node labels. Node name and description are not changed.


I think my changes has no effect on this.

[mPokornyETM]

Did you check whether project history explains why nodes have plain text nodeDescription but everything else has formatted description?

So I have try to find the reason, It looks that it was just "for ever". When you agree, I would create new Jira issue for that. So we can "fix" it little later. I prefer to set the 'nodeDescription' to obsolete, but this can not be decided by me.

[mPokornyETM]

I found one more usage of nodeDescription

I has also check whole jenkins core ws for nodeDescription and I think this was the last one.

[daniel-beck]

@mPokornyETM Thanks! To clarify, I'm not opposed to this change per se, just wondering whether there's a good reason for the discrepancy in both field name and behavior. I expect we'll merge this or a variant in the end, solving your problem.

Re matrix-project, I was surprised by your answer and checked, and while

looks like there would be an agent description rendered there, there's no support for that -- everything is treated as a label, not as an agent name, internally: https://github.com/jenkinsci/matrix-project-plugin/blob/7aea491852f39b51379a2f6f2dd490f7d191441e/src/main/java/hudson/matrix/LabelAxis.java#L90-L99
Additionally, the label descriptions do not get the renderer applied, so it looks terrible with any non-default markup formatter. That's an issue with the plugin alone though.

[mPokornyETM]

@daniel-beck Ah sorry that was misunderstanding from my side. I think it renders some hove the /computer/<agentName> page, but it is used here in the config page from the matrix-project self.
The solution is strange. From my side I prefer to remove the description from this page, because it is not necessary and it looks like the lol () is a function and not the node name (description)

Please allow me one question. What shall be done to finish this PR?

[daniel-beck]

Please allow me one question. What shall be done to finish this PR?

At the moment, needs more reviews from others, and consequently some patience from you. If anything is missing from this PR, that'll be brought up in reviews.

[daniel-beck]

Nit:

The description of the built-in node is defined by Hudson.NodeDescription in hudson/model/Messages.properties as

the Jenkins controller's built-in node

That looks weird with this change in presentation:

It should be upgraded to a full sentence since it's no longer a short phrase in parentheses (no HTML though, or any characters likely to lead to problem in any common(ish) markup language).

[mPokornyETM]

Please allow me one question. What shall be done to finish this PR?

At the moment, needs more reviews from others, and consequently some patience from you. If anything is missing from this PR, that'll be brought up in reviews.

thanks, I am patient enough, but I am excited, Like a small child

[mPokornyETM]

Nit:

The description of the built-in node is defined by Hudson.NodeDescription in hudson/model/Messages.properties as

the Jenkins controller's built-in node

That looks weird with this change in presentation:

It should be upgraded to a full sentence since it's no longer a short phrase in parentheses (no HTML though, or any characters likely to lead to problem in any common(ish) markup language).

Hm I see. The same issue was in System Information page. My quick and dirty solution was
<div style="margin-bottom: var(--section-padding);">

Do you now about some better class or html element, which will render the space correctly?

[mPokornyETM]

dirty fix for padding

[daniel-beck]

It should be upgraded to a full sentence since it's no longer a short phrase in parentheses (no HTML though, or any characters likely to lead to problem in any common(ish) markup language).

Hm I see. The same issue was in System Information page. My quick and dirty solution was <div style="margin-bottom: var(--section-padding);">

To clarify, the comment you quoted was about the phrasing, not the presentation.

Thanks for taking care of the margin!

[github-actions]

Please take a moment and address the merge conflicts of your pull request. Thanks!

[basil]

I merged the physical conflicts but now there is a logical conflict:

core/src/main/resources/lib/hudson/editable-description.js
   9:16  error  'replaceDescription' is not defined  no-undef
  11:16  error  'replaceDescription' is not defined  no-undef

[mPokornyETM]

@daniel-beck thx for caring.

[daniel-beck]

@mPokornyETM Sorry for the delay here!

TBH I'm trying to figure out what is blocking this. I got assigned after providing early feedback. I provided a suggestion addressing early problems, which you integrated. That had open TODOs that needed resolving, but those have been resolved and the TODOs removed.

Is it just that I didn't unassign myself, so nobody else went near this? I'll try to see whether changing that gets others to take a look 😃 (as a substantial co-author I'm unsure whether I should be approving this.)

[github-actions]

Please take a moment and address the merge conflicts of your pull request. Thanks!

[timja]

LGTM

---

There's one UI issue but likely pre-existing issue with the component / other buttons on the page.

The Save and mark this node temporarily offline buttons don't look that great as save is wider than the form and they are touching

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