From cbf88d82aa755a7efa4250a29bf233628d0efdde Mon Sep 17 00:00:00 2001 From: Mark Waite Date: Mon, 8 Jan 2024 13:46:32 -0700 Subject: [PATCH] Improve remoting documentation (#6994) * Improve remoting redirects * Redirect to current remoting changelog * Minor phrasing improvements Remove duplicate words, trailing spaces, and Java Web Start reference --- content/projects/remoting/index.adoc | 14 +++++++------- content/redirect/project/remoting/changelog.adoc | 2 +- .../project/remoting/protocols/jnlp2-errata.adoc | 2 +- .../project/remoting/protocols/jnlp3-errata.adoc | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/content/projects/remoting/index.adoc b/content/projects/remoting/index.adoc index 464920c76530..c49b6c320550 100644 --- a/content/projects/remoting/index.adoc +++ b/content/projects/remoting/index.adoc @@ -11,8 +11,8 @@ links: googlegroup: 'jenkinsci-dev' --- -Jenkins Remoting is a library, and executable Java archive, which implements the communication layer in Jenkins. -This includes the TCP-based communication protocols, remote procedure calls, class loading, data streaming, etc. +Jenkins Remoting is a library, and executable Java archive, which implements the communication layer in Jenkins. +This includes the TCP-based communication protocols, remote procedure calls, class loading, data streaming, etc. Currently Remoting is primarily used in communications between the Jenkins controller and Jenkins agents. The Remoting sub-project includes the Remoting library itself, package for agents, and a number of Remoting-specific plugins and core modules. @@ -22,8 +22,8 @@ The Remoting sub-project includes the Remoting library itself, package for agent == Remoting Usage in Jenkins -* Agent executables (`remoting.jar` is a named `agent.jar` or `slave.jar` in Jenkins) -* Controller to Agent communication protocols being used in various Agent types, including Java Web Start (aka JNLP) and plugin:ssh-slaves[SSH] agents +* Agent executables (`remoting.jar` is named `agent.jar` or `slave.jar` in Jenkins) +* Controller to Agent communication protocols being used in various Agent types, including inbound (JNLP) and plugin:ssh-slaves[SSH] agents * link:/doc/book/managing/cli/[Jenkins CLI], Remoting mode is **deprecated since 2.54** (link:/blog/2017/04/11/new-cli/[announcement]) * Communication with Maven instance in the plugin:maven-plugin[Maven Integration plugin]. @@ -31,7 +31,7 @@ The Remoting sub-project includes the Remoting library itself, package for agent === Remoting Library -Remoting Library is the main component of the the sub-project. +Remoting Library is the main component of the sub-project. The code base is located in a link:https://github.com/jenkinsci/remoting[separate repository], which also contains Remoting developer and user documentation. This library also has an independent release cycle and LTS release lines. @@ -45,10 +45,10 @@ Links: === Jenkins Core and Modules -Although Remoting library is a standalone component, +Although Remoting library is a standalone component, Jenkins core includes some extensions and modules for working with Remoting. Core extensions also allow implementing custom protocols on-demand (e.g. for Jenkins CLI). -There is ongoing activity on detaching these core components to Jenkins plugins +There is ongoing activity on detaching these core components to Jenkins plugins (see jira:JENKINS-44099[]), but in the meantime upgrading of Jenkins core may be required to fix Remoting issues. diff --git a/content/redirect/project/remoting/changelog.adoc b/content/redirect/project/remoting/changelog.adoc index 107dee1db2be..a75885753448 100644 --- a/content/redirect/project/remoting/changelog.adoc +++ b/content/redirect/project/remoting/changelog.adoc @@ -1,4 +1,4 @@ --- layout: redirect -redirect_url: https://github.com/jenkinsci/remoting/blob/master/CHANGELOG.md +redirect_url: https://github.com/jenkinsci/remoting/releases --- diff --git a/content/redirect/project/remoting/protocols/jnlp2-errata.adoc b/content/redirect/project/remoting/protocols/jnlp2-errata.adoc index 28d7f18d432c..58faca3bfeba 100644 --- a/content/redirect/project/remoting/protocols/jnlp2-errata.adoc +++ b/content/redirect/project/remoting/protocols/jnlp2-errata.adoc @@ -1,4 +1,4 @@ --- layout: redirect -redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md#jnlp2-connect-errata +redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md --- diff --git a/content/redirect/project/remoting/protocols/jnlp3-errata.adoc b/content/redirect/project/remoting/protocols/jnlp3-errata.adoc index 28d7f18d432c..58faca3bfeba 100644 --- a/content/redirect/project/remoting/protocols/jnlp3-errata.adoc +++ b/content/redirect/project/remoting/protocols/jnlp3-errata.adoc @@ -1,4 +1,4 @@ --- layout: redirect -redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md#jnlp2-connect-errata +redirect_url: https://github.com/jenkinsci/remoting/blob/master/docs/protocols.md ---