Skip to content

Commit

Permalink
Migrate plugin documentation from wiki to Github
Browse files Browse the repository at this point in the history
  • Loading branch information
Namrata Loharuka committed May 28, 2020
1 parent 487f6a4 commit 972b0a1
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 1 deletion.
46 changes: 46 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,46 @@
# Change Log

## Version 1.16 (Jan 22, 2018)

- [Fix security issue](https://jenkins.io/security/advisory/2018-01-22/)

### Version 1.15 (Jun 21, 2016)

- [JENKINS-34713](https://issues.jenkins-ci.org/browse/JENKINS-34713) Updated to the new parent POM. Some tests have been reviewed.

### Version 1.12 (Oct 30, 2014)

- German translation added.

### Version 1.11 (Jan 07, 2014)

- updated some translations or labels (French, Portuguese, Norwegian, Chinese Traditional, Telugu)
- do not allow Afrikaans to be the default language
- do not show footer to anonymous users without read permission
- fixed overlapping popup window
- attempted to fix an unreproducible NPE

### Version 1.10 (Nov 06, 2012)

- Added support for Tamil (ta) (pull \#1)
- Updated Spanish translation of help text

### Version 1.9 (Mar 20, 2012)

- Added support for Faroese (fo)
- Added support for British English (en\_GB)
- Ensure icon is cached properly, as it is loaded on every page

### Version 1.8 (Oct 10, 2011)

- Fixed typo in plugin display name ([JENKINS-11235](https://issues.jenkins-ci.org/browse/JENKINS-11235))

### Version 1.7 (Aug 29, 2011)

- Made to work with Jenkins

### Version 1.4 (Mar 22, 2010)

- Localization updates for this plugin

### Version 1.3 (Jan 19, 2010)
45 changes: 45 additions & 0 deletions README.md
@@ -0,0 +1,45 @@
Translation Plugin for Jenkins
=============================

[![Build Status](https://ci.jenkins.io/job/Plugins/job/translation-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/translation-plugin/job/master/)
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/translation.svg)](https://plugins.jenkins.io/translation/)
[![GitHub release](https://img.shields.io/github/release/jenkinsci/translation.svg?label=changelog)](https://github.com/jenkinsci/translation-plugin/releases/latest/)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/translation.svg?color=blue)](https://plugins.jenkins.io/translation/)

**The server handling submitted translations has been shut down.** While this plugin is still useful for local translations, it's not possible to submit translations to the Jenkins project anymore.

This plugin adds an additional dialog box in every page, which enables people to contribute localizations for the messages they are seeing in the current page. This reduces the barrier of entry to localization, and by showing messages in the context of a page, it should also improve the quality of the translation.

## How does it work?

Browse any page of Jenkins, and you'll see a link in the footer section that opens the translation dialog.
![](docs/images/l10n-link.png)

Click this link, and you'll see an inline dialog box.

![](docs/images/l10n-dialog.png)

Choose the locale that you'd like to contribute, then type the translation text. The message follows the format of [`MessageFormat`](https://docs.oracle.com/javase/6/docs/api/java/text/MessageFormat.html), and in particular,

1. Markers like "{0}" and "{1}" represent the arguments
2. Single quote (') needs to be escaped as two single-quote ('')

Your name allows us to recognize your contributions and bypass manual review, especially when you've been contributing in the past. So do supply some unique string, even if it's not your real name.

If you have an administrative access to the Jenkins instance, your contributions will be reflected right away — just reload the page to see the effect. (If you do not have the access, your changes won't be reflected to the running instance for security reasons, but nonetheless they are sent to the Jenkins server.)

Your contributions are also sent to the Jenkins project for inclusion in future versions of Jenkins.

## Participating more to the localization effort

If you'd like to involve more deeply with the localization effort please drop us a note at <http://groups.google.com/group/jenkinsci-dev>.

Also see [Internationalization](https://wiki.jenkins.io/display/JENKINS/Internationalization).

## Version History

See the [changelog](CHANGELOG.md).

## Release Notes

See [Github Release](https://github.com/jenkinsci/translation-plugin/releases).
Binary file added docs/images/l10n-dialog.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/l10n-link.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pom.xml
Expand Up @@ -10,7 +10,7 @@
<version>1.17-SNAPSHOT</version>
<packaging>hpi</packaging>
<name>Jenkins Translation Assistance plugin</name>
<url>https://wiki.jenkins-ci.org/display/JENKINS/Translation+Assistance+Plugin</url>
<url>https://github.com/jenkinsci/translation-plugin</url>

<scm>
<connection>scm:git:git://github.com/jenkinsci/${project.artifactId}-plugin.git</connection>
Expand Down

0 comments on commit 972b0a1

Please sign in to comment.