jenkinsci / jenkinsci/packaging

Link to install documentation instead of providing an incomplete copy

Open
#415 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Shell
Stars
43
Forks
82
PR merge metrics
No merged PRs in 30d

Description

What feature do you want to see added?

The installation instructions on the pkg and mirror sites like:

are brief summaries of the more detailed instructions provided in the Linux section of the Installing chapter of the Jenkins User Handbook.

Those brief summaries lack the detailed information provided in the Linux section about Java requirements, hardware requirements, and operating system requirements. The brief summary of the Red Hat Enterprise Linux instructions recommends the rpm tool even though dnf is the default package manager on Fedora Linux. The brief summary of the Red Hat Enterprise Linux instructions uses an incorrect spelling ("Redhat") to refer to Red Hat Enterprise Linux and its derivatives. The brief summary of the Red Hat Enterprise Linux instructions does not mention the service control commands that are needed to start the service and enable the service.

Rather than having a brief and incomplete summary of the installation instructions on those the pkg and mirrors pages, I think that we should make the pkg and mirrors pages redirect to the jenkins.io site. A link already exists at the end of each of the pages, but making them redirect to the installation pages will take readers to the most complete instructions that we offer.

Upstream changes

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the source or generation entry points for the pkg and mirror pages, then compare them with the Jenkins User Handbook Linux installation page linked in the issue. The work is done when those package pages redirect readers to the complete installation documentation instead of presenting incomplete summaries.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.