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 link to GitHub example #7204

Merged
merged 24 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
a880462
Added a section of Update parent POM page
pyther-hub Mar 26, 2024
7532210
Merge branch 'master' into add-Update-parent-POM-page
gounthar Mar 28, 2024
bf3688d
minor wording changed
pyther-hub Mar 28, 2024
ac6a9c9
basic changes
pyther-hub Mar 28, 2024
1ff69e7
added on how to use checkUrl in Form validation
pyther-hub Mar 28, 2024
008b299
removed extra part
pyther-hub Mar 28, 2024
b03fcfd
changes have been made to clarify that once a page has undergone migr…
pyther-hub Mar 28, 2024
03b812a
removed unwanted part
pyther-hub Mar 28, 2024
f92296a
minor changes
pyther-hub Mar 30, 2024
03d4b32
Update content/doc/developer/publishing/wiki-page.adoc
kmartens27 Apr 8, 2024
b731ef7
Merge branch 'master' into issue-6887
kmartens27 Apr 8, 2024
fadd33f
Merge branch 'master' into issue-6887
kmartens27 Apr 8, 2024
f839cd2
rephrased
pyther-hub Apr 9, 2024
498ed6f
Merge branch 'jenkins-infra:master' into issue-6887
pyther-hub Apr 9, 2024
03d485d
tp
pyther-hub Apr 9, 2024
3d60bd7
Merge branch 'master' into issue-6887
pyther-hub Apr 10, 2024
85a0dcf
Merge branch 'master' into issue-6887
kmartens27 Apr 12, 2024
c02ba73
Update content/doc/developer/publishing/wiki-page.adoc
kmartens27 Apr 12, 2024
5cc4c39
Merge branch 'master' into issue-6887
kmartens27 Apr 12, 2024
de21c93
Merge branch 'master' into issue-6887
kmartens27 Apr 15, 2024
95264e9
add redirect configuration to steps
kmartens27 Apr 16, 2024
29e6d8d
Merge branch 'master' into issue-6887
kmartens27 Apr 16, 2024
12b2534
Merge branch 'master' into issue-6887
MarkEWaite Apr 18, 2024
b132821
Improve link to table of contents example
MarkEWaite Apr 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions content/doc/developer/forms/form-validation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ public FormValidation doCheckThreads(@QueryParameter("value") final String meani

This naming convention is how Jenkins wires up your form validation method. The return type also must be FormValidation, which offers various static factory methods to create an instance. Form validation can be of 3 different kinds: `ok`, `warning` or `error`. Validation message can either be represented in plaintext or use HTML markup. Several validations of different kinds can be reported wrapping then into one using aggregate factory method.

=== To set up form validation within a Jelly template

To configure form validation within a Jelly template to call doCheckXxx methods defined in a particular class in Jenkins, you'll indeed utilize the checkUrl and checkDependsOn attributes. Here's a breakdown of how these attributes are used:

The checkUrl Attribute specifies the URL that Jenkins will request to perform form validation. Typically, this URL points to the Jenkins server, where it handles the validation request. The value entered in the input field will be checked via AJAX against this URL, and any errors encountered will be rendered under the text field. This URL is associated with the method responsible for performing the validation (doCheckXxx method) within your Descriptor class.

The checkDependsOn Attribute defines the dependency between the field being validated and the field(s) whose values are required for validation. It specifies the ID(s) of the field(s) that the validation depends on. When the dependent field(s) change, Jenkins triggers the validation of the current field. Additionally, the fields specified in checkDependsOn are sent along with the form validation request.

== Getting values of other fields
Sometimes your validation method needs values of other input fields to perform a check. You do this by defining them as additional parameters:

Expand Down
2 changes: 2 additions & 0 deletions content/doc/developer/publishing/wiki-page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ There are the following migration steps:
. Modify the URL documentation page reference in the project file so that it points to GitHub (link:/doc/developer/publishing/documentation/#referencing-the-documentation-page-from-the-project-file[documentation]).
. Commit changes, push them to your fork and create a pull request against the repository.

Note:- There is a major technical obstacle in the way of content migration from the wiki. This difficulty stems from the requirement that, when the material has been properly moved, the out-of-date wiki page be removed and a redirection mechanism to the migrated version be set up. After migration, the continued existence of out-of-date wiki pages causes a number of problems, such as duplication, confusion, and unclear migration progress. This persistence not only makes the process more difficult overall, but it also makes it more difficult to identify which material has already been migrated and which is still waiting, which makes the work at hand much more difficult.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Note:- There is a major technical obstacle in the way of content migration from the wiki. This difficulty stems from the requirement that, when the material has been properly moved, the out-of-date wiki page be removed and a redirection mechanism to the migrated version be set up. After migration, the continued existence of out-of-date wiki pages causes a number of problems, such as duplication, confusion, and unclear migration progress. This persistence not only makes the process more difficult overall, but it also makes it more difficult to identify which material has already been migrated and which is still waiting, which makes the work at hand much more difficult.
NOTE: After migration, the continued existence of out-of-date wiki pages causes a number of problems, such as duplication, confusion, and unclear migration progress. This persistence not only makes the process more difficult overall, but it also makes it harder to identify which pages have already been migrated and which are still waiting. This is a major technical obstacle in the way of content migration from the wiki. When migrating documentation, after the material has been properly moved, the out-of-date wiki page must be removed and a redirect must be configured to the migrated version.

I have reworded some of the content, and moved it accordingly to try and make it read more clearly. I have also adjusted the NOTE: macro so that it is implemented as a note on the page, thus giving it a different visual/making it stand out more. There were also a few instances where a singular version of a word was used instead of the plural.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Along with this I have made new line for each sentence also


=== Reviewing the documentation

. Review/edit the migrated file formatting
Expand Down