Merge pull request #23 from MarkEWaite/convert-docs-to-github

Revise documentation

Author: MarkEWaite

CHANGELOG.md

@@ -2,193 +2,176 @@
 
 ## Release 1.2
 
-\* Fix SECURITY-294 - Rips out the ability to execute a Groovy script
+* Fix SECURITY-294 - Rips out the ability to execute a Groovy script
 with this plugin
 
 ## Release 0.33
 
-\* Fix deployed item ID when there is multiple ArtifactDeployer step
+* Fix deployed item ID when there is multiple ArtifactDeployer step
 
 ## Release 0.32
 
-\* Fix
-[JENKINS-24140](https://issues.jenkins-ci.org/browse/JENKINS-24140) -
+* Fix [JENKINS-24140](https://issues.jenkins.io/browse/JENKINS-24140) -
 ArtifactDeployer migration breaks lazy-load on Jenkins initialization
 
 ## Release 0.31
 
-\* Fix
-[JENKINS-16130](https://issues.jenkins-ci.org/browse/JENKINS-16130) -
-Provide folder links on build results page to condense long file paths  
-\* Fix
-[JENKINS-14681](https://issues.jenkins-ci.org/browse/JENKINS-14681) -
+* Fix [JENKINS-16130](https://issues.jenkins.io/browse/JENKINS-16130) -
+Provide folder links on build results page to condense long file paths
+* Fix [JENKINS-14681](https://issues.jenkins.io/browse/JENKINS-14681) -
 Constrain the list of artifacts deployed
 
 ## Release 0.30
 
-\* Fix typo in help file.
+* Fix typo in help file.
 
 ## Release 0.29
 
-\* Additional help text
+* Additional help text
 
 ## Release 0.28
 
-\* Fix
-[JENKINS-18135](https://issues.jenkins-ci.org/browse/JENKINS-18135) -
+* Fix [JENKINS-18135](https://issues.jenkins.io/browse/JENKINS-18135) -
 Conditional Build Step plugin crashes when using Artifact Deployer
 plugin as build step
 
 ## Release 0.27
 
-\* Fix NullPointerException
+* Fix null pointer exception
 
 ## Release 0.26
 
-\* Fix
-[JENKINS-16031](https://issues.jenkins-ci.org/browse/JENKINS-16031) -
+* Fix [JENKINS-16031](https://issues.jenkins.io/browse/JENKINS-16031) -
 Lost deployed artifacts after restart
 
 ## Release 0.25
 
-\* Fix
-[JENKINS-15709](https://issues.jenkins-ci.org/browse/JENKINS-15709) -
+* Fix [JENKINS-15709](https://issues.jenkins.io/browse/JENKINS-15709) -
 ArtifactDeployer does not appear in Flexible Publish
 
 ## Release 0.24
 
-\* Fix
-[JENKINS-15354](https://issues.jenkins-ci.org/browse/JENKINS-15354) -
+* Fix [JENKINS-15354](https://issues.jenkins.io/browse/JENKINS-15354) -
 Add option to fail the build if specified "Files to deploy" do not exist
 
 ## Release 0.23
 
-\* Fix
-[JENKINS-15059](https://issues.jenkins-ci.org/browse/JENKINS-15059) -
-recursive deletion of deployment patches not working correctly
+* Fix [JENKINS-15059](https://issues.jenkins.io/browse/JENKINS-15059) -
+recursive deletion of deployment paths not working correctly
 
 ## Release 0.22
 
-\* Fix
-[JENKINS-15058](https://issues.jenkins-ci.org/browse/JENKINS-15058) -
+* Fix [JENKINS-15058](https://issues.jenkins.io/browse/JENKINS-15058) -
 Setting for GroovyScript is not permanent
 
 ## Release 0.21
 
-\* Fix
-[JENKINS-14547](https://issues.jenkins-ci.org/browse/JENKINS-14547) -
+* Fix [JENKINS-14547](https://issues.jenkins.io/browse/JENKINS-14547) -
 Null pointer exception when using groovy script
 
 ## Release 0.20
 
-\* Fix
-[JENKINS-14548](https://issues.jenkins-ci.org/browse/JENKINS-14548) -
+* Fix [JENKINS-14548](https://issues.jenkins.io/browse/JENKINS-14548) -
 help for groovy script usage is never displayed
 
 ## Release 0.19
 
-\* Fix
-[JENKINS-13841](https://issues.jenkins-ci.org/browse/JENKINS-13841) -
-"Base folder" for deploying the artifact from source folder to remote
+* Fix [JENKINS-13841](https://issues.jenkins.io/browse/JENKINS-13841) -
+"Base folder" for deploying the artifacts from source folder to remote
 directory
 
 ## Release 0.18
 
-\* Fix
-[JENKINS-13937](https://issues.jenkins-ci.org/browse/JENKINS-13937) -
-ArtifactDeployer 0.16 messes the filenames for Windows filesystems
+* Fix [JENKINS-13937](https://issues.jenkins.io/browse/JENKINS-13937) -
+ArtifactDeployer 0.16 messes the filenames for Windows file systems
 
 ## Release 0.17
 
-\* Fix NullPointerException on artifact deletion
+* Fix null pointer exception on artifact deletion
 
 ## Release 0.16
 
-\* Fix
-[JENKINS-12311](https://issues.jenkins-ci.org/browse/JENKINS-12311) -
+* Fix [JENKINS-12311](https://issues.jenkins.io/browse/JENKINS-12311) -
 Display the Deployed Artifacts in a tree structure similar to how they
 are displayed under the Build Artifacts section
 
 ## Release 0.15
 
-\* Fix
-[JENKINS-11867](https://issues.jenkins-ci.org/browse/JENKINS-11867) -
+* Fix [JENKINS-11867](https://issues.jenkins.io/browse/JENKINS-11867) -
 Deployed files have a different time with original files.
 
 ## Release 0.14
 
-\* Fix
-[JENKINS-12522](https://issues.jenkins-ci.org/browse/JENKINS-12522) -
+* Fix [JENKINS-12522](https://issues.jenkins.io/browse/JENKINS-12522) -
 Deploy artifacts for failed builds, too
 
 ## Release 0.13
 
-\* Fix
-[JENKINS-11640](https://issues.jenkins-ci.org/browse/JENKINS-11640) -
-Can't copy on remote windows slave
+* Fix [JENKINS-11640](https://issues.jenkins.io/browse/JENKINS-11640) -
+Can't copy on remote windows agent
 
 ## Release 0.12
 
-\* Fix partially
-[JENKINS-9996](https://issues.jenkins-ci.org/browse/JENKINS-9996) - Have
-the possibility to change the user and group ACLs on artifacts
+* Fix partially
+[JENKINS-9996](https://issues.jenkins.io/browse/JENKINS-9996) - Have
+the possibility to change the user and group ACL's on artifacts
 (Conserve file permissions to copy).
 
 ## Release 0.11
 
-\* Fixed NullPointerException when the remote directory value is not set
+* Fix null pointer exception when the remote directory value is not set
 (for the ArtifactDeployer publisher and for the ArtifactDeployer
 builder).
 
 ## Release 0.10
 
-\* Make it compatible to LTS series (1.409.x)  
-\* Complete fix
-[JENKINS-10360](https://issues.jenkins-ci.org/browse/JENKINS-10360) -
+* Make it compatible to LTS series (1.409.x)
+* Complete fix
+[JENKINS-10360](https://issues.jenkins.io/browse/JENKINS-10360) -
 Added support of Matrix project
 
 ## Release 0.9
 
-\* Fix partially
-[JENKINS-10360](https://issues.jenkins-ci.org/browse/JENKINS-10360) -
+* Fix partially
+[JENKINS-10360](https://issues.jenkins.io/browse/JENKINS-10360) -
 Added support of Maven project
 
 ## Release 0.8
 
-\* Fix slave execution
+* Fix agent execution
 
 ## Release 0.7
 
-\* Fix bug on deletion  
-\* The deployed artifacts in the Jenkins dashboard are now sorted.
+* Fix bug on deletion
+* The deployed artifacts in the Jenkins dashboard are now sorted.
 
 ## Release 0.6
 
-\* Fix a ClassCastException (for more than one entry) on save
+* Fix a class cast exception (for more than one entry) on save
 configuration
 
 ## Release 0.5
 
-\* Integrated a pull request - Fixed a NullPointerException
+* Integrated a pull request - Fixed a null pointer exception
 
 ## Release 0.4
 
-\* Add 'deployment artifacts' as a build step (builder item) in
-addition to publishers.  
+* Add 'deployment artifacts' as a build step (builder item) in
+addition to publishers.
 Use Case: In the same job as build steps: Build your artifacts, deploy
 them in remote locations (as servers) and launch the integration tests.
 
 ## Release 0.3
 
-\* Add a checkbox for deleting remote artifacts when the build is
+* Add a checkbox for deleting remote artifacts when the build is
 deleted.
 
 ## Release 0.2
 
-\* The plugins enables users to call a Groovy script when the builds are
+* The plugins enables users to call a Groovy script when the builds are
 deleted (for manual and automatic deletion).
 
 ## Release 0.1
 
-\* Initial release  
-Only the filesystem protocol is available
+* Initial release
+Only the file system protocol is available

README.md

@@ -1,49 +1,46 @@
-This plugin makes it possible to copy artifacts to remote locations.
+# Artifact Deployer Plugin
 
-# History and Objectives
+This plugin makes it possible to copy artifacts to remote locations.
 
-By default, Jenkins archives artifacts generated by the build. These
-artifacts are stored in the JENKINS\_HOME directory with all other
-elements such as job configuration files.  
-There is no separation between infrastructure elements, project elements
-and outputs.  
-It is often considered to be a bad practice, and it doesn't help to
-manage JENKINS\_HOME directory from an administrator point of view
-(backup issues, etc).  
+By default, Jenkins archives artifacts generated by the build.
+These artifacts are stored in the `JENKINS_HOME` directory with all other elements such as job configuration files.
+There is no separation between infrastructure elements, project elements and outputs.
+It is often considered to be a bad practice and it doesn't help to manage the `JENKINS_HOME` directory from an administrator point of view (backup issues, etc).
 And for now, we can't change the 'Archived artifacts' location.
 
 ArtifactDeployer plugin enables you to archive build artifacts to any
 remote locations such as to a separate file server (outside of
-JENKINS\_HOME directory).
+the `JENKINS_HOME` directory).
 
 There are many other Jenkins plugins close to ArtifactDeployer such as
-[CopyArtifact
-plugin](https://plugins.jenkins.io/copyartifact/)  for
+[CopyArtifact plugin](https://plugins.jenkins.io/copyartifact/) for
 publishing artifacts from Jenkins resources (from the current workspace,
 from the old builds of the same job or other jobs, ...) to remote
-locations with the protocol file://  
+locations with the protocol file://
 There are also others plugins for managing other protocols such as
-ftp://, ssh:///.
+ftp://, ssh://.
 
-But none of these plugins provides a common way to manage the
-deployment.
+But none of these plugins provides a common way to manage the deployment.
 
 ArtifactDeployer is a complete alternative to the built-in Jenkins
-feature 'Archiving artefacts' and it is aimed at providing uniform
-deployment mechanisms.
+feature "Archiving artifacts' and it is aimed at providing an uniform
+deployment mechanism.
 
 # Features
 
 -   Copies build artifacts from the workspace to a remote location
     shared on the build processor node
--   Provides links to archived artefacts from the job status page
+-   Provides links to archived artifacts from the job status page
 -   Deletes on demand archived artifacts when the build is removed
 
 # Limitations
 
 -   Only file deployment is supported
 -   For downloading deployed artifacts, remote location must be
-    accessible from the Jenkins master
+    accessible from the Jenkins controller
 -   Jenkins process must have the right permissions to write in the
     specified location
 
+# Changelog
+
+See the separate [change log](CHANGELOG.md) for past releases.

src/main/resources/org/jenkinsci/plugins/artifactdeployer/ArtifactDeployerBuilder/help-remote.html

@@ -1,10 +1,10 @@
 <div>
     <p>
         Artifacts will be deployed in the specified output directory.<br/>
-        The remote location must be accessible through the build machine (master/slave node).<br/>
+        The remote location must be accessible through the build machine (controller and agent node).<br/>
         If you want to have the ability to download deployed artifacts through the Jenkins dashboard,
-        the location must be accessible from the Jenkins master.<br/>
+        the location must be accessible from the Jenkins controller.<br/>
         Make sure the Jenkins process have the right permissions to write to the remote location.<br/>
-        For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine.
+        For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine.
     </p>
 </div>

src/main/resources/org/jenkinsci/plugins/artifactdeployer/ArtifactDeployerPublisher/help-remote.html

@@ -1,10 +1,10 @@
 <div>
     <p>
         Artifacts will be deployed in the specified output directory.<br/>
-        The remote location must be accessible through the build machine (master/slave node).<br/>
+        The remote location must be accessible through the build machines (the controller and the agents).<br/>
         If you want to have the ability to download deployed artifacts through the Jenkins dashboard,
-        the location must be accessible from the Jenkins master. <br/>
+        the location must be accessible from the Jenkins controller. <br/>
         Make sure the Jenkins process have the right permissions to write to the remote location.<br/>
-        For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine.
+        For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine.
     </p>
 </div>