Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c15824a
feat(doc): redirect to install doc page instead of brief summary
hainenber Sep 7, 2023
f653b33
feat(template): keep only URL redirecting instruction
hainenber Sep 8, 2023
9591d57
feat(bin/indexGen): not generate unused HTMLs
hainenber Sep 8, 2023
36909d0
feat(template/index): not include footer for redirection URL
hainenber Sep 8, 2023
010874f
Merge branch 'master' into link-to-install-documentation-instead-of-b…
MarkEWaite Sep 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions bin/indexGenerator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,4 @@ def generate_repository_index(self):
headerGenerator = IndexGenerator(sys.argv[1:])
headerGenerator.show_information()
headerGenerator.generate_repository_header()
headerGenerator.generate_footer()
headerGenerator.generate_repository_index()
headerGenerator.generate_root_header()
headerGenerator.generate_root_footer()
1 change: 1 addition & 0 deletions templates/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

<head>
<meta charset="UTF-8" />

{% block head %}
<title>{{ os_family | capitalize}} {{product_name | capitalize }} Packages</title>
{% endblock %}
Expand Down
55 changes: 8 additions & 47 deletions templates/header.debian.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,12 @@
{% extends "base.html" %}
<!DOCTYPE html>

{% block distribution_instruction %}
<!-- Do not manually edit this file, it is generated from https://github.com/jenkinsci/packaging/blob/master/templates/base.html -->

<p>
This is the Debian package repository of {{product_name}} to automate installation and upgrade.
<html lang="en">

To use this repository, first add the key to your system:
<head>
<meta charset="UTF-8" />
<meta http-equiv="refresh" content="1; url='https://www.jenkins.io/doc/book/installing/linux/'" />
</head>

<pre class="text-white bg-dark">
<code>
curl -fsSL <a href="{{web_url}}/{{organization}}-2023.key" style="color:white">{{web_url}}/{{organization}}-2023.key</a> | sudo tee \
/usr/share/keyrings/jenkins-keyring.asc > /dev/null</code>
</pre>

Then add a Jenkins apt repository entry:

<pre class="text-white bg-dark">
<code>
echo deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc] \
{{ web_url }} binary/ | sudo tee \
/etc/apt/sources.list.d/jenkins.list > /dev/null</code>
</pre>
</p>

<p>
Update your local package index, then finally install {{product_name}}:

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

sudo apt-get install {{artifactName}}
</code>
</pre>
</p>

<p>
The apt packages were signed using this key:
</p>

<pre class="text-white bg-dark" style="box-sizing:border-box; padding:1.5rem 1rem;">{{ pub_key_info|trim }}</pre>
{% endblock %}

{% block individual_package_instruction %}

<p>
If you need *.deb for a specific version, use these.
</p>

{% endblock %}
<h1>You are getting redirected to https://www.jenkins.io/doc/book/installing/linux/</h1>
15 changes: 7 additions & 8 deletions templates/header.msi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{% extends "base.html" %}
<!DOCTYPE html>

{% block distribution_instruction %}
<html lang="en">

<p>
This is the MSI package repository of {{product_name}} for installation.
<p>
{% endblock %}
<head>
<meta charset="UTF-8" />
<meta http-equiv="refresh" content="1; url='https://www.jenkins.io/doc/book/installing/windows/'" />
</head>

{% block individual_package_instruction %}{% endblock %}
{% block java_instructions %}{% endblock %}
<h1>You are getting redirected to https://www.jenkins.io/doc/book/installing/windows/</h1>
31 changes: 7 additions & 24 deletions templates/header.opensuse.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,10 @@
{% extends "base.html" %}
<!DOCTYPE html>

{% block distribution_instruction %}
<html lang="en">

To use this repository, run the following command:
<head>
<meta charset="UTF-8" />
<meta http-equiv="refresh" content="1; url='https://www.jenkins.io/doc/book/installing/linux/'" />
</head>

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

sudo zypper addrepo -f {{web_url}}/ {{artifactName}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


</pre>

<p>
With that set up, the {{ product_name }} package can be installed with:

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

zypper install dejavu-fonts fontconfig java-17-openjdk
zypper install {{ artifactName }}

</pre>
</p>
{% endblock %}

{% block individual_package_instruction %}
If you need *.rpm for a specific version, use these.
{% endblock %}
<h1>You are getting redirected to https://www.jenkins.io/doc/book/installing/linux/</h1>
39 changes: 7 additions & 32 deletions templates/header.redhat.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,10 @@
{% extends "base.html" %}
<!DOCTYPE html>

{% block distribution_instruction %}
<html lang="en">

<p>
To use this repository, run the following command:
<head>
<meta charset="UTF-8" />
<meta http-equiv="refresh" content="1; url='https://www.jenkins.io/doc/book/installing/linux/'" />
</head>

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

sudo wget -O /etc/yum.repos.d/{{artifactName}}.repo {{ web_url }}/{{artifactName}}.repo
sudo rpm --import {{ web_url }}/{{organization}}-2023.key
</pre>

<p>
If you've previously imported the key from Jenkins, the <code>rpm --import</code> will fail because
you already have a key. Please ignore that and move on.

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

yum install fontconfig tzdata-java java-17-openjdk
yum install {{artifactName}}
</pre>

<p>
The rpm packages were signed using this key:
</p>

<pre class="text-white bg-dark" style="box-sizing:border-box; padding:1.5rem 1rem;">{{ pub_key_info|trim }}</pre>


{% endblock %}

{% block individual_package_instruction %}
If you need *.rpm for a specific version, use these.
{% endblock %}
<h1>You are getting redirected to https://www.jenkins.io/doc/book/installing/linux/</h1>
77 changes: 7 additions & 70 deletions templates/header.war.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,73 +1,10 @@
{% extends "base.html" %}
<!DOCTYPE html>

{% block distribution_instruction %}
<html lang="en">

<p>
This is the WAR package repository of {{ product_name }} for installation.
<p>
{% endblock %}
<head>
<meta charset="UTF-8" />
<meta http-equiv="refresh" content="1; url='https://www.jenkins.io/doc/book/installing/war-file/'" />
</head>

{% block java_instructions %}
<p>
You will need to explicitly install a supported Java runtime environment (JRE),
e.g. <a href="https://adoptium.net/">Eclipse Temurin</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>
Comment on lines -25 to -38
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

</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>
{% endblock %}

{% block individual_package_instruction %}

<p>
If you need *.war for a specific version, use these.
</p>

{% endblock %}
<h1>You are getting redirected to https://www.jenkins.io/doc/book/installing/war-file/</h1>
1 change: 0 additions & 1 deletion templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
{% include header %}
{% include "footer.html" %}