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 to install documentation instead of providing an incomplete copy #415

Open
MarkEWaite opened this issue Jul 9, 2023 · 3 comments
Open

Comments

@MarkEWaite
Copy link
Contributor

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

@hainenber
Copy link

Hi @MarkEWaite, I was very much new to the project so my conjecture could be wrong here, but if we need to redirect the pages at pkg.jenkins.io to www.jenkins.io/doc/book/installing/linux/, shouldn't it be configured in a repository handling the server behind pkg.jenkins.io?

I'm very glad to take this issue over, btw

@MarkEWaite
Copy link
Contributor Author

Hi @MarkEWaite, I was very much new to the project so my conjecture could be wrong here, but if we need to redirect the pages at pkg.jenkins.io to www.jenkins.io/doc/book/installing/linux/, shouldn't it be configured in a repository handling the server behind pkg.jenkins.io?

I was hoping that we could use a redirect inside the top level web page rather than making that redirect at the web server level. However, I'm not an expert in the compromises that implies. I am open to either technique.

@hainenber
Copy link

That's an excellent suggestion! I'll soon make a PR to realize it. Thanks Mark!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants