Skip to content

Commit 3ff6a91

Browse files
committed
Minor documentation cleanup
Remove the old changelog and link to a tagged version on GitHub. Replace outdated jenkins-ci.org with jenkins.io domain name. Link bug reporting to a page that offers bug, improvement, and security reporting so that users are encouraged to report issues more accurately and are encouraged to report security issues in the SECURITY project rather than the JENKINS project.
1 parent ca83775 commit 3ff6a91

File tree

2 files changed

+5
-61
lines changed

2 files changed

+5
-61
lines changed

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
Git Server Plugin for Jenkins
2-
=================
3-
4-
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/git-server.svg)](https://plugins.jenkins.io/git-server)
5-
[![GitHub release](https://img.shields.io/github/release/jenkinsci/git-server-plugin.svg?label=changelog)](https://github.com/jenkinsci/git-server-plugin/releases/latest)
6-
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/git-server.svg?color=blue)](https://plugins.jenkins.io/git-server)
1+
# Git Server Plugin for Jenkins
72

83
This plugin wraps the server-side functionality of JGit so that other plugins can easily expose
94
Git repositories from Jenkins via its SSH transport and HTTP in a collaborative fashion.
@@ -24,12 +19,12 @@ is a convenient default implementation that simplifies this further.
2419
[GitUserContentRepository](https://github.com/jenkinsci/git-userContent-plugin/blob/master/src/main/java/org/jenkinsci/plugins/gitUserContent/GitUserContentRepository.java)
2520
in `git-userContent-plugin` is an example of using this class. This use
2621
also implements
27-
[RootAction](https://wiki.jenkins-ci.org/display/JENKINS/Action+and+its+family+of+subtypes#Actionanditsfamilyofsubtypes-RootAction)
22+
[RootAction](https://wiki.jenkins.io/display/JENKINS/Action+and+its+family+of+subtypes#Actionanditsfamilyofsubtypes-RootAction)
2823
to bind this repository at `http://server/jenkins/userContent.git`, and
2924
This combination is fairly common.
3025

3126
The other class of interest is [`RepositoryResolver`](https://github.com/jenkinsci/git-server-plugin/blob/master/src/main/java/org/jenkinsci/plugins/gitserver/RepositoryResolver.java).
32-
Git server plugin adds necessary [Jenkins SSH](https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+SSH) CLI hook for exposing Git repositories over SSH.
27+
Git server plugin adds necessary [Jenkins SSH](https://wiki.jenkins.io/display/JENKINS/Jenkins+SSH) CLI hook for exposing Git repositories over SSH.
3328
The only missing link here is that when the client runs `git clone ssh://server/foo/bar/zot.git`,
3429
we need to figure out what repositories on the server corresponds to `/foo/bar/zot.git`, and that's what the `RepositoryResolver` extension point does.
3530
[The sample implementation](https://github.com/jenkinsci/git-userContent-plugin/blob/master/src/main/java/org/jenkinsci/plugins/gitUserContent/GitUserContentRepositorySSHAccess.java) in `git-userContent-plugin` will be hopefully self-explanatory.
@@ -38,9 +33,9 @@ In this case, `GitUserContentRepository` is a singleton (because it's `RootActio
3833
## Changelog
3934

4035
* See [GitHub Releases](https://github.com/jenkinsci/git-server-plugin/releases/latest) for recent releases
41-
* See the [Changelog Archive](./docs/OLD_CHANGELOG.md) for versions 1.7 and older
36+
* See the [Changelog Archive](https://github.com/jenkinsci/git-server-plugin/blob/git-server-1.9/docs/OLD_CHANGELOG.md) for versions 1.7 and older
4237

4338
## Reporting issues
4439

45-
Use [Jenkins Bugtracker](https://issues.jenkins-ci.org/) to report issues or feature requests
40+
Use [Jenkins issue tracker](https://www.jenkins.io/participate/report-issue/redirect/#17613) to report issues or feature requests
4641
(project = `JENKINS`, component = `git-server-plugin`).

docs/OLD_CHANGELOG.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

0 commit comments

Comments
 (0)