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

Add help text for Markup Formatter setting #9038

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -0,0 +1,37 @@
<div>
<p>
Jenkins shows user-provided descriptions on objects like jobs, views, or
builds. The markup formatter controls how those descriptions are rendered.
</p>
<p>
&ldquo;Plain text&rdquo; is the default formatter and renders the provided
description largely as entered.
</p>
<p>
Plugins may contribute additional markup formatters that support HTML or
other markup languages.
</p>
<p>
<strong>Note:</strong>
Some descriptions can be provided from possibly unexpected sources. Some
examples:
</p>
<ul>
<li>any user with an account in Jenkins can set their own description</li>
<li>
Pipelines, as well as build steps for other job types, may be configured
to set the current build's description
</li>
</ul>
<p>
Using a markup formatter that renders user input verbatim as HTML may allow
<a
href="https://en.wikipedia.org/wiki/Cross-site_scripting"
target="_blank"
rel="noopener noreferrer"
>
cross-site scripting
</a>
attacks.
</p>
</div>

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.