[JENKINS-65420] Added missing online helps by ciradu2204 · Pull Request #139 · jenkinsci/workflow-basic-steps-plugin

ciradu2204 · 2021-04-21T16:05:59Z

More details about the issue -> JENKINS-65420

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your master branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

aHenryJard · 2021-04-23T07:01:30Z

@@ -0,0 +1,3 @@
+<div>
+    The relative path of the directory to the workspace directory.


I am not sure on this one, I looked at the Java class here

workflow-basic-steps-plugin/src/main/java/org/jenkinsci/plugins/workflow/steps/PushdStep.java

Line 38 in 474cea2

* Temporarily changes the working directory.

the comment there is Temporarily changes the working directory..

I think it's more to change the folder to work in.

I do a suggestion but I am not sure on my English :), feel free to change it.

Suggested change

The relative path of the directory to the workspace directory.

The relative path in workspace to the folder to use as a new working directory.

Thank you @aHenryJard. What about this: The relative path of the folder to the workspace to use as a new working directory?

Cynthia, I like your rewrite, but how about going back to "directory" rather than "folder"? I know that the terms are generally used to be synonymous but Jenkins does have a folders feature so it could be ambiguous. Also, how about "directory in the workspace"?

Okay, thank you @StackScribe. I have made the changes.

bitwiseman · 2021-04-23T18:09:59Z

@@ -0,0 +1,3 @@
+<div>
+    A message to write to the console output.
+</div>


I think we want all the files to end with a newline.

Thanks @bitwiseman. I have accepted your changes

…ep/help-type.html Co-authored-by: Liam Newman <bitwiseman@gmail.com>

…ileStep/help-file.html Co-authored-by: Liam Newman <bitwiseman@gmail.com>

…ep/help-name.html Co-authored-by: Liam Newman <bitwiseman@gmail.com>

kwhetstone · 2021-04-26T17:56:47Z

@@ -0,0 +1,3 @@
+<div>
+    Relative path of a file within the workspace.


Similar to the Pushd documentation, do you want to want to make this match terminology by using directory here? I think it makes sense to match but want to confirm /cc @StackScribe

@kwhetstone, I thought directory in only used to specify a folder not a file.

I'm not sure of the context here -- does this parameter specify the directory where the file will be written or the path (including he file name) of the file. That would determine the proper wording here.

@StackScribe, the path of the file.

oleg-nenashev · 2021-04-26T19:47:30Z

@@ -0,0 +1,3 @@
+<div>
+ The name of the tool. The tool name must be pre-configured in Jenkins under Manage Jenkins → Global Tool Configuration.


Add hyperlink to the management page? Or highlight the Web UI elements via italic or whatsover?

Thanks @oleg-nenashev, I have made it italic

…s/stash/StashStep/help-allowEmpty.html Co-authored-by: Kristin Whetstone <kwhetstone@cloudbees.com>

…low-basic-steps-plugin into add-online-help

aHenryJard

Looks good to me.

StackScribe

Nicely done!

oleg-nenashev

Approved once suggestions by @StackScribe are integrated

…ep/help-message.html Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com>

…s/stash/StashStep/help-allowEmpty.html Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com>

…tep/help-message.html Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com>

alecharp

I'd prefer to see the two suggestions incorporated into the PR but I'm not blocking it either.

…ep/help-name.html Co-authored-by: Adrien Lecharpentier <adrien.lecharpentier@gmail.com>

…tep/help-path.html Co-authored-by: Adrien Lecharpentier <adrien.lecharpentier@gmail.com>

…s/stash/StashStep/help-allowEmpty.html Co-authored-by: Ramon Leon <manuelramonleonjimenez@gmail.com>

…ep/help-type.html Co-authored-by: Ramon Leon <manuelramonleonjimenez@gmail.com>

ciradu2204 · 2021-04-30T14:57:10Z

Hi @alecharp @bitwiseman @kwhetstone @StackScribe, I have worked on your reviews. If there are no other improvements you want me to make, it would be amazing if you accept this PR and merge it. Thank you!

ciradu2204 added 17 commits April 20, 2021 17:25

added an online help of the allow Empty argument

f8a22f9

added an online help to the path argument

ca3b643

added an online help for the message argument

93a5952

message argument online help modified

3bea35c

modified the path online help

4868bb8

added an online help for the ErrorStep message

080ce41

added a period at the end of each sentence

b0f74e3

modified the online help

8d052ae

modified the Error step message

5f22c3d

added an online on the type argument of the toolStep

f577a2d

added an online help to the name argument of the toolStep

819017f

added an online help to the file argument of the writeFileStep

44faa06

added an online help to the text argument of the writeFileStep

fff00d3

modified the path argument of the PushdStep

fcef1c2

add an online help to the allowEmpty argument in the StashStep

5a8a791

added a target attribute to open the link in a new tab

af06279

modified the name argument of the toolstep

229be47

aHenryJard reviewed Apr 23, 2021

View reviewed changes

rephrased the online help of the path argument

a8d0aca

bitwiseman reviewed Apr 23, 2021

View reviewed changes

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help-name.html Outdated

bitwiseman reviewed Apr 23, 2021

View reviewed changes

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/WriteFileStep/help-file.html Outdated

bitwiseman reviewed Apr 23, 2021

View reviewed changes

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help-type.html Outdated

bitwiseman reviewed Apr 23, 2021

View reviewed changes

ciradu2204 and others added 6 commits April 23, 2021 21:28

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolSt…

25cb306

…ep/help-type.html Co-authored-by: Liam Newman <bitwiseman@gmail.com>

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/WriteF…

963d883

…ileStep/help-file.html Co-authored-by: Liam Newman <bitwiseman@gmail.com>

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolSt…

dff0998

…ep/help-name.html Co-authored-by: Liam Newman <bitwiseman@gmail.com>

add a new line

48a7deb

add a new line

2b980f9

removed space

02fcabc

ciradu2204 changed the title ~~[JENKINS-65420] Added missing online help~~ [JENKINS-65420] Added missing online helps Apr 26, 2021

kwhetstone reviewed Apr 26, 2021

View reviewed changes

oleg-nenashev reviewed Apr 26, 2021

View reviewed changes

kwhetstone reviewed Apr 27, 2021

View reviewed changes

Comment thread .../resources/org/jenkinsci/plugins/workflow/support/steps/stash/StashStep/help-allowEmpty.html Outdated

ciradu2204 and others added 3 commits April 27, 2021 10:03

Update src/main/resources/org/jenkinsci/plugins/workflow/support/step…

eaf1490

…s/stash/StashStep/help-allowEmpty.html Co-authored-by: Kristin Whetstone <kwhetstone@cloudbees.com>

modified the toolStep help

8e36252

Merge branch 'add-online-help' of https://github.com/ciradu2204/workf…

8a1de9d

…low-basic-steps-plugin into add-online-help

aHenryJard approved these changes Apr 27, 2021

View reviewed changes

StackScribe reviewed Apr 28, 2021

View reviewed changes

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/EchoStep/help-message.html Outdated

StackScribe reviewed Apr 28, 2021

View reviewed changes

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/ErrorStep/help-message.html Outdated

StackScribe reviewed Apr 28, 2021

View reviewed changes

Comment thread .../resources/org/jenkinsci/plugins/workflow/support/steps/stash/StashStep/help-allowEmpty.html Outdated

StackScribe reviewed Apr 28, 2021

View reviewed changes

oleg-nenashev approved these changes Apr 28, 2021

View reviewed changes

ciradu2204 and others added 3 commits April 28, 2021 09:55

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/EchoSt…

c71c882

…ep/help-message.html Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com>

Update src/main/resources/org/jenkinsci/plugins/workflow/support/step…

c4835d8

…s/stash/StashStep/help-allowEmpty.html Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com>

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/ErrorS…

c465222

…tep/help-message.html Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com>

alecharp reviewed Apr 28, 2021

View reviewed changes

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/PushdStep/help-path.html Outdated

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help-name.html Outdated

ciradu2204 and others added 2 commits April 28, 2021 15:40

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolSt…

91e5514

…ep/help-name.html Co-authored-by: Adrien Lecharpentier <adrien.lecharpentier@gmail.com>

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/PushdS…

56e4e0e

…tep/help-path.html Co-authored-by: Adrien Lecharpentier <adrien.lecharpentier@gmail.com>

MRamonLeon reviewed Apr 28, 2021

View reviewed changes

Comment thread src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help-type.html Outdated

Comment thread .../resources/org/jenkinsci/plugins/workflow/support/steps/stash/StashStep/help-allowEmpty.html Outdated

ciradu2204 and others added 2 commits April 28, 2021 16:19

Update src/main/resources/org/jenkinsci/plugins/workflow/support/step…

d654d6a

…s/stash/StashStep/help-allowEmpty.html Co-authored-by: Ramon Leon <manuelramonleonjimenez@gmail.com>

Update src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolSt…

75a9dbd

…ep/help-type.html Co-authored-by: Ramon Leon <manuelramonleonjimenez@gmail.com>

MRamonLeon approved these changes Apr 28, 2021

View reviewed changes

car-roll merged commit f0e6639 into jenkinsci:master May 5, 2022

car-roll added the documentation label May 5, 2022

		@@ -0,0 +1,3 @@
		<div>
		The relative path of the directory to the workspace directory.

	The relative path of the directory to the workspace directory.
	The relative path in workspace to the folder to use as a new working directory.

@@ @@ -0,0 +1,3 @@ @@
+              <div>
+                  A message to write to the console output.
+              </div>

                
                    No newline at end of file

		@@ -0,0 +1,3 @@
		<div>
		Relative path of a file within the workspace.

		@@ -0,0 +1,3 @@
		<div>
		The name of the tool. The tool name must be pre-configured in Jenkins under Manage Jenkins → Global Tool Configuration.

Uh oh!

Conversation

ciradu2204 commented Apr 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bitwiseman Apr 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aHenryJard left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StackScribe left a comment

Choose a reason for hiding this comment

Uh oh!

oleg-nenashev left a comment

Choose a reason for hiding this comment

Uh oh!

alecharp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ciradu2204 commented Apr 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

ciradu2204 commented Apr 21, 2021 •

edited

Loading

bitwiseman Apr 23, 2021 •

edited

Loading

ciradu2204 commented Apr 30, 2021 •

edited

Loading