Redirect pkg.jenkins.io to install doc page instead of brief summary #431

hainenber · 2023-09-07T16:05:43Z

Testing

Here's the generated index.html once run make publish.

<title>Debian Jenkins Packages</title>


<link href='https://www.jenkins.io/sites/default/files/jenkins_favicon.ico' rel='shortcut icon' type='image/x-icon'/>

<link rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css"
  integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65"
  crossorigin="anonymous">

<script
  src="https://cdn.jsdelivr.net/npm/jquery@3.6.3/dist/jquery.min.js"
  integrity="sha256-pvPw+upLPUjgMXY0G+8O0xUf+/Im1MZjXxxgOcBQBXU="
  crossorigin="anonymous"></script>

<script
  src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js"
  integrity="sha384-cuYeSxntonz0PPNlHhBs68uyIAVpIIOZZ5JqeqvYYIcEL727kskC66kF92t6Xl2V"
  crossorigin="anonymous"></script>

<style type="text/css">
  dl {
    padding: 0;
  }

  dl dt {
    padding: 0;
    margin-top: 1em;
    font-size: 1em;
    font-style: italic;
    font-weight: bold;
  }

  dl dd {
    padding: 0 1em;
    margin-bottom: 1em;
  }
</style>

Jenkins Debian Packages

This is the Debian package repository of Jenkins to automate installation and upgrade.

To use this repository, first add the key to your system:

    
  curl -fsSL https://pkg.jenkins.io/debian/jenkins.io-2023.key | sudo tee \
    /usr/share/keyrings/jenkins-keyring.asc > /dev/null

Then add a Jenkins apt repository entry:

    
  echo deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc] \
    https://pkg.jenkins.io/debian binary/ | sudo tee \
    /etc/apt/sources.list.d/jenkins.list > /dev/null

Update your local package index, then finally install Jenkins:

   
  sudo apt-get update
  sudo apt-get install fontconfig openjdk-17-jre
  sudo apt-get install jenkins

The apt packages were signed using this key:

pub   rsa4096 2022-03-03 [SC]
      D91D3E00200107E4219524DD42715B56E211B042
uid                      Bogus Test (This is test only key) 
sub   rsa4096 2022-03-03 [E]

        <p>
          You will need to explicitly install a supported Java runtime environment (JRE), either from your distribution
          (as described above) or another Java vendor (e.g., <a href="https://adoptium.net/">Adoptium</a>).
        </p>

        <h2>
          Weekly Release Line
        </h2>

        <p>
          Supported Java versions for the weekly release line are:
        </p>

        <dl>
          <dt>2.419 (August 2023) and newer</dt>
          <dd>Java 11, Java 17, or Java 21</dd>

          <dt>2.357 (June 2022) and newer</dt>
          <dd>Java 11 or Java 17</dd>

          <dt>2.164 (February 2019) and newer</dt>
          <dd>Java 8 or Java 11</dd>

          <dt>2.54 (April 2017) and newer</dt>
          <dd>Java 8</dd>

          <dt>1.612 (May 2015) and newer</dt>
          <dd>Java 7</dd>
        </dl>

        <h2>
          <a href="https://www.jenkins.io/download/lts/">Long Term Support (LTS)</a> Release Line
        </h2>

        <p>
          Supported Java versions for the LTS release line are:
        </p>

        <dl>
          <dt>2.361.1 (September 2022) and newer</dt>
          <dd>Java 11 or Java 17</dd>

          <dt>2.346.1 (June 2022) and newer</dt>
          <dd>Java 8, Java 11, or Java 17</dd>

          <dt>2.164.1 (March 2019) and newer</dt>
          <dd>Java 8 or Java 11</dd>

          <dt>2.60.1 (June 2017) and newer</dt>
          <dd>Java 8</dd>

          <dt>1.625.1 (October 2015) and newer</dt>
          <dd>Java 7</dd>
        </dl>
      

      <p>
        See <a href="https://www.jenkins.io/doc/book/installing/">the installation guide</a> for more information, including how Jenkins is run and where the configuration is stored, etc.
      </p>
    </div>
  </div>
</div>

  </div>
</div>

The page immediately redirects to https://www.jenkins.io/doc/book/installing/linux/, can be locally reproduced as well

Implements #415

Submitter checklist

Give feedback

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
Options

NotMyFault

LGTM

basil

Why is the other content on the page being retained if it will not be readable after the redirect?

hainenber · 2023-09-08T16:37:31Z

I decided to leave the remaining content as is to ensure the HTML templating scripts/functions wouldn't break. At the moment, I'm not well versed to the codebase so I'd like to add incremental change before understanding it further to remove the HTML templating apparatus and subsequently, the page's contents.

basil · 2023-09-08T16:44:05Z

The content should be removed at the same time that the redirect is being introduced. As-is, this PR is not ready for merge.

hainenber · 2023-09-08T17:15:43Z

I've pushed new commits to clean up unused content as redirection is added.

This is the index.html generated by make war.publish

<!DOCTYPE html>

<html lang="en">

<head>
    <meta charset="UTF-8" />
    <meta http-equiv="refresh" content="1; url='https://www.jenkins.io/doc/book/installing/war-file/'" />
</head>

<h1>You are getting redirected to https://www.jenkins.io/doc/book/installing/war-file/</h1>

It'll redirect to aforementioned link afterwards. For other installation platform, here are their respective redirection URL:

deb/suse/rpm: https://www.jenkins.io/doc/book/installing/linux
msi: https://www.jenkins.io/doc/book/installing/windows
war: https://www.jenkins.io/doc/book/installing/war-file

basil

Is this migration losing information? I don't see any references to tzdata-java on https://www.jenkins.io/doc/book/installing/linux/, but I see them (deleted) in this PR.

MarkEWaite · 2023-09-29T19:22:52Z

Is this migration losing information? I don't see any references to tzdata-java on https://www.jenkins.io/doc/book/installing/linux/, but I see them (deleted) in this PR.

I checked with Rocky Linux 8 using the installation instructions from https://www.jenkins.io/doc/book/installing/linux/#red-hat-centos and when I enter the command sudo yum install java-17-openjdk, one of the dependencies that is listed to be installed is tzdata-java. I believe the removal of the tzdata-java reference is safe.

I haven't checked Rocky Linux 9, but I assume that if tzdata-java is an openjdk-17 dependency on RHEL 8 it will also be one on RHEL 9.

basil · 2023-09-29T19:32:52Z

It had to be updated to get the automated tests to pass in #418 and #420. I wouldn't consider its removal safe until it is removed from the automated tests.

MarkEWaite · 2023-09-29T19:38:03Z

It had to be updated to get the automated tests to pass in #418 and #420. I wouldn't consider its removal safe until it is removed from the automated tests.

Super. I'll submit an update to the installation document in the user guide so that the user guide includes that information.

…rief-summary

basil · 2023-09-29T21:10:15Z

templates/header.debian.html

-  <pre class="text-white bg-dark">
-   <code>
-  sudo apt-get update
-  sudo apt-get install fontconfig openjdk-17-jre


Where is the reference to fontconfig on https://www.jenkins.io/doc/book/installing/linux?

Thanks for catching that. Added to the Debian documentation in jenkins-infra/jenkins.io#6721

basil · 2023-09-29T21:10:27Z

templates/header.opensuse.html


-<pre class="text-white bg-dark">
-
-  sudo zypper addrepo -f {{web_url}}/ {{artifactName}}


Where is the reference to zypper on https://www.jenkins.io/doc/book/installing/linux?

That will need a larger addition to the installation section of the documentation. There isn't a section for openSUSE installation yet. I'll need to check with @kmartens27 to see if he's available to work on an openSUSE section for the documentation.

basil · 2023-09-29T21:10:48Z

templates/header.redhat.html

-
-  <pre class="text-white bg-dark">
-
-  yum install fontconfig java-17-openjdk


Where is the reference to fontconfig on https://www.jenkins.io/doc/book/installing/linux?

basil · 2023-09-29T21:11:12Z

templates/header.war.html

-    <dt>2.419 (August 2023) and newer</dt>
-    <dd>Java 11, Java 17, or Java 21</dd>
-
-    <dt>2.357 (June 2022) and newer</dt>
-    <dd>Java 11 or Java 17</dd>
-
-    <dt>2.164 (February 2019) and newer</dt>
-    <dd>Java 8 or Java 11</dd>
-
-    <dt>2.54 (April 2017) and newer</dt>
-    <dd>Java 8</dd>
-
-    <dt>1.612 (May 2015) and newer</dt>
-    <dd>Java 7</dd>


Where is this information on https://www.jenkins.io/doc/book/installing/war-file/?

feat(doc): redirect to install doc page instead of brief summary

c15824a

hainenber requested a review from a team as a code owner September 7, 2023 16:05

NotMyFault approved these changes Sep 8, 2023

View reviewed changes

NotMyFault requested a review from MarkEWaite September 8, 2023 10:29

basil reviewed Sep 8, 2023

View reviewed changes

hainenber added 3 commits September 9, 2023 00:08

feat(template): keep only URL redirecting instruction

f653b33

feat(bin/indexGen): not generate unused HTMLs

9591d57

feat(template/index): not include footer for redirection URL

36909d0

basil reviewed Sep 29, 2023

View reviewed changes

Merge branch 'master' into link-to-install-documentation-instead-of-b…

010874f

…rief-summary

basil reviewed Sep 29, 2023

View reviewed changes

MarkEWaite mentioned this pull request Sep 29, 2023

Include fontconfig in Debian Linux install jenkins-infra/jenkins.io#6721

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redirect pkg.jenkins.io to install doc page instead of brief summary #431

Redirect pkg.jenkins.io to install doc page instead of brief summary #431

hainenber commented Sep 7, 2023

Jenkins Debian Packages

Submitter checklist

NotMyFault left a comment

basil left a comment

hainenber commented Sep 8, 2023

basil commented Sep 8, 2023

hainenber commented Sep 8, 2023

basil left a comment

MarkEWaite commented Sep 29, 2023

basil commented Sep 29, 2023

MarkEWaite commented Sep 29, 2023

basil Sep 29, 2023

MarkEWaite Sep 29, 2023

basil Sep 29, 2023

MarkEWaite Sep 29, 2023

basil Sep 29, 2023

basil Sep 29, 2023


		<pre class="text-white bg-dark">

		sudo zypper addrepo -f {{web_url}}/ {{artifactName}}


		<pre class="text-white bg-dark">

		yum install fontconfig java-17-openjdk

Redirect pkg.jenkins.io to install doc page instead of brief summary #431

Are you sure you want to change the base?

Redirect pkg.jenkins.io to install doc page instead of brief summary #431

Conversation

hainenber commented Sep 7, 2023

Testing

Jenkins Debian Packages

Submitter checklist

NotMyFault left a comment

Choose a reason for hiding this comment

basil left a comment

Choose a reason for hiding this comment

hainenber commented Sep 8, 2023

basil commented Sep 8, 2023

hainenber commented Sep 8, 2023

basil left a comment

Choose a reason for hiding this comment

MarkEWaite commented Sep 29, 2023

basil commented Sep 29, 2023

MarkEWaite commented Sep 29, 2023

basil Sep 29, 2023

Choose a reason for hiding this comment

MarkEWaite Sep 29, 2023

Choose a reason for hiding this comment

basil Sep 29, 2023

Choose a reason for hiding this comment

MarkEWaite Sep 29, 2023

Choose a reason for hiding this comment

basil Sep 29, 2023

Choose a reason for hiding this comment

basil Sep 29, 2023

Choose a reason for hiding this comment