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-73923] Add javadoc for SSH host key verification strategies #1237

Conversation

MarkEWaite
Copy link
Contributor

@MarkEWaite MarkEWaite commented Jan 4, 2025

[JENKINS-73923] Add javadoc for SSH host key verification strategies

JENKINS-73923 notes that the git client plugin extensions page has no documentation. It says "This extension point has no Javadoc documentation".

Provide the documentation for the extension point and the four implementations of the extension point so that extension point documentation will include documentation after the next release of the git client plugin.

Much of the text is copied from the README or derived from the text in the README.

Testing done

Checked that the Javadoc renders as expected in Chrome.

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

https://issues.jenkins.io/browse/JENKINS-73923 notes that
https://jenkins.io/doc/developer/extensions/git-client/ has
no documentation.  It says "This extension point has no Javadoc
documentation".

Provide the documentation for the extension point and the four
implementations of the extension point so that extension point
documentation will include documentation after the next release of the
git client plugin.

Much of the text is copied from the README or derived from the text in
the README.

Testing done

Checked that the Javadoc renders as expected in Chrome.
@MarkEWaite MarkEWaite added the documentation Improvements or additions to documentation label Jan 4, 2025
@MarkEWaite MarkEWaite requested a review from a team as a code owner January 4, 2025 15:11
@MarkEWaite MarkEWaite merged commit 4f72c44 into jenkinsci:master Jan 4, 2025
18 checks passed
@MarkEWaite MarkEWaite deleted the add-javadoc-for-SshHostKeyVerificationStrategy branch January 4, 2025 15:43
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