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

[JENKINS-65324] added a missing online help #50

Merged
merged 3 commits into from
May 8, 2021

Conversation

ciradu2204
Copy link

@ciradu2204 ciradu2204 commented Apr 9, 2021

  • 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
    I added a missing online help for the wait argument
  • Link to relevant issues in GitHub or Jira
    https://issues.jenkins.io/browse/JENKINS-65324
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

@ciradu2204
Copy link
Author

Hi @MarkEWaite and @StackScribe,

Here is my pull request for the missing pipeline help task. I am looking forward to your feedback. Thanks

@ciradu2204 ciradu2204 changed the title [JENKINS-65324] added a missing online help to the pipeline-build-step [JENKINS-65324] added a missing online help Apr 9, 2021
@MarkEWaite
Copy link
Contributor

@basil do you have permission to merge this pull request and #49 ? The SheCodeAfrica Contributhon is working during April to improve the Pipeline step descriptions, Pipeline argument descriptions, and Pipeline examples. We'd love to have fast review of their work

@basil
Copy link
Member

basil commented Apr 12, 2021

@basil do you have permission to merge this pull request and #49 ?

I do not; as far as I can tell, @dwnusbaum is the primary maintainer of the Pipeline plugins who merges PRs. Let me know if there's any way I can help.

Copy link

@kwhetstone kwhetstone left a comment

Choose a reason for hiding this comment

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

I think the pattern of help documentation is to explain what the setting does, and then to state the default. Otherwise, this looks fine to me.

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

+1 to what @kwhetstone said. Also please add line break at the end of the file

@ciradu2204
Copy link
Author

@kwhetstone and @oleg-nenashev, thank you for the feedback. I have made changes.

Copy link

@aHenryJard aHenryJard left a comment

Choose a reason for hiding this comment

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

Looks good to me

@ciradu2204
Copy link
Author

Hi @MarkEWaite @kwhetstone, 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!

@bitwiseman bitwiseman merged commit 82e0e20 into jenkinsci:master May 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
9 participants