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-65337] Suggest Pipeline Syntax snippet generator in the plugin doc #49

Merged
merged 2 commits into from
Apr 14, 2021

Conversation

ciradu2204
Copy link

  • 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
    To reduce users frustration while creating the pipeline, I referred them to the Pipeline Syntax snippet generator in the plugin documentation page to help in generating the pipeline Script.
  • Link to relevant issues in GitHub or Jira
    https://issues.jenkins.io/browse/JENKINS-65337
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

@MarkEWaite @StackScribe @kwhetstone

@ciradu2204 ciradu2204 changed the title suggested a pipeline Syntax snippet generator in the plugin doc suggest a pipeline Syntax snippet generator in the plugin doc Apr 9, 2021
@ciradu2204 ciradu2204 changed the title suggest a pipeline Syntax snippet generator in the plugin doc Suggest a pipeline Syntax snippet generator in the plugin doc Apr 9, 2021
@ciradu2204 ciradu2204 changed the title Suggest a pipeline Syntax snippet generator in the plugin doc [JENKINS-65337] Suggest Pipeline Syntax snippet generator in the plugin doc Apr 9, 2021
README.md Outdated
@@ -7,7 +7,7 @@
## Introduction

This plugin allows pipelines to use standard Jenkins SCM plugins to check out source code.
The goals are the maximum possible compatibility with existing plugins, and great flexibility for script authors.
The goals are the maximum possible compatibility with existing plugins, and great flexibility for script authors. The ["Pipeline Syntax" snippet generator](https://www.jenkins.io/redirect/pipeline-snippet-generator) guides the user to define the checkout step.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks! We prefer sentence per line formatting so that changes inside a sentence are easier to review.

Suggested change
The goals are the maximum possible compatibility with existing plugins, and great flexibility for script authors. The ["Pipeline Syntax" snippet generator](https://www.jenkins.io/redirect/pipeline-snippet-generator) guides the user to define the checkout step.
The goals are the maximum possible compatibility with existing plugins, and great flexibility for script authors.
The ["Pipeline Syntax" snippet generator](https://www.jenkins.io/redirect/pipeline-snippet-generator) guides the user to define the checkout step.

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for feedback @MarkEWaite. I made another commit to put the sentence on a newline.

@rsandell rsandell merged commit 2336bd3 into jenkinsci:master Apr 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants