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.

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

Link from download pages to install guides #7776

Merged
merged 5 commits into from
Dec 23, 2024

Conversation

MarkEWaite
Copy link
Contributor

@MarkEWaite MarkEWaite commented Dec 23, 2024

Link from download pages to install guides

The pkg.jenkins.io site is the download site, but it is not the best site for installation instructions for Linux packages. Users of the Linux packages do not use a download URL. They use a series of steps that are specific to their operating system and its package manager. The link to the download site is a link to installation steps listed on pkg.jenkins.io. The installation steps on www.jenkins.io are more thorough and include specific instructions for Fedora Linux that are not available on pkg.jenkins.io

Adds Fedora Linux as a separate link in the list of packages because it intentionally has separate instructions for its dnf package manager.

Red Hat Enterprise Linux 10 is planned to include the dnf package manager when it releases in mid-2025. When it releases, we'll need to revisit the instructions.

Use broader description of RHEL and its derivatives

Use the precise name of Red Hat Enterprise Linux and refer to the derivatives in the title rather than listing the derivatives. Include the names of key derivative operating systems in the body text so that search engines continue to find them.

The Red Hat usage guidelines are very clear that they operating system is named Red Hat Enterprise Linux and should not be referenced as "Red Hat".

Update the Debian OpenJDK sample data

Use most recent Debian 17 release.

Link to our systemd instructions instead of DigitalOcean

The systemd instructions are more specific to Jenkins and more relevant to our readers. The DigitalOcean instructions were intended to persuade people that systemd is the right choice. Better to link to details that are specific to Jenkins.

Remove JDK 11 note for Debian 12

JDK 11 is no longer supported, so there is no reason to mention it as a disclaimer or a warning.

Also adds an ID for debian-stable that can be used elsewhere.

Review pages

JDK 11 is no longer supported, so there is no reason to mention it as
a disclaimer or a warning.

Also adds an ID for debian-stable that can be used elsewhere.
The systemd instructions are more specific to Jenkins and more relevant
to our readers.  The DigitalOcean instructions were intended to persuade
people that systemd is the right choice.  Better to link to details that
are specific to Jenkins.
Use most recent Debian 17 release.
Use the precise name of Red Hat Enterprise Linux and refer to the
derivatives in the title rather than listing the derivatives.  Include the
names of key derivative operating systems in the body text so that search
engines continue to find them.

The Red Hat usage guidelines are very clear that they operating system is
named Red Hat Enterprise Linux and should not be referenced as "Red Hat".
The pkg.jenkins.io site is the download site, but it is not the best
site for installation instructiosn for Linux packages.  Users of the
Linux packages do not use a download URL.  They use a series of steps
that are specific to their operating system and its package manager.
The link to the download site is a link to installation steps listed
on pkg.jenkins.io.  The installation steps on www.jenkins.io are more
thorough and include specific instructions for Fedora Linux that are
not available on pkg.jenkins.io

Adds Fedora Linux as a seperate link in the list of packages because it
intentionally has separate instructions for its `dnf` package manager.

Red Hat Enterprise Linux 10 is planned to include the `dnf` package
manager when it releases in mid-2025.  When it releases, we'll need to
revisit the instructions.
@MarkEWaite MarkEWaite requested a review from a team as a code owner December 23, 2024 02:16
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Dec 23, 2024
@timja timja merged commit 7cd5b73 into jenkins-infra:master Dec 23, 2024
5 checks passed
@MarkEWaite MarkEWaite deleted the add-fedora-and-more branch December 23, 2024 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants