Skip to content

Improve git step documentation - #1744

Merged
MarkEWaite merged 3 commits into
jenkinsci:masterfrom
MarkEWaite:link-to-checkout-step-docs
Apr 13, 2025
Merged

Improve git step documentation#1744
MarkEWaite merged 3 commits into
jenkinsci:masterfrom
MarkEWaite:link-to-checkout-step-docs

Conversation

@MarkEWaite

@MarkEWaite MarkEWaite commented Apr 13, 2025

Copy link
Copy Markdown
Contributor

Improve git step documentation

  • Link to the documentation of the checkout step so that users of the git step can click the link for more information
  • Better introduction sentence
  • Use more modern branch name in example

Testing done

Confirmed that added hyperlinks are valid. Confirmed that the links work as expected and the page renders as expected.

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main 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

@MarkEWaite
MarkEWaite requested a review from a team as a code owner April 13, 2025 11:49
@MarkEWaite MarkEWaite added the documentation Improvements or additions to documentation label Apr 13, 2025
@MarkEWaite
MarkEWaite merged commit 2a070fd into jenkinsci:master Apr 13, 2025
@MarkEWaite
MarkEWaite deleted the link-to-checkout-step-docs branch April 13, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant