Separate handbook install chapter into sections #3874
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move the disclaimer after the LTS install instructions
Jenkins is default secure since 2.0
vsilverman
approved these changes
Oct 16, 2020
vsilverman
approved these changes
Oct 16, 2020
We prefer to use the page level redirect mechanism described in the contributing guide. However, this page needs to remain as a page yet have internal anchors within the page redirected to other locations. The anchor redirects are targeting several different pages. This Javascript technique allows entrance into a single page to redirect to a different page based on the anchor text. The Javascript that is embedded in this page is taken from https://stackoverflow.com/questions/1305211/javascript-to-redirect-from-anchor-to-a-separate-page/21198129#21198129 with deepest gratitude for that answer. I've checked each of the redirects using a local web page that opened http://localhost:4242/doc/book/installing/#windows (and others like it). They are well-behaved running my local development copy of jenkins.io. When this is merged, I will perform additional checks to confirm that the technique also works for https://www.jenkins.io/doc/book/installing/
Thanks @vsilverman . I apologize in advance for this disruption this will be to your pull request, but I'm happy to assist with resolving the conflicts this pull request will create in yours. @kwhetstone and @zaycodes this is ready for review. |
kwhetstone
approved these changes
Oct 19, 2020
markjacksonfishing
suggested changes
Oct 19, 2020
Thanks to @markyjackson-taulia for detecting the mistakes.
markjacksonfishing
approved these changes
Oct 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use sections to improve install readability
The addition of the Kubernetes installation instructions highlighted a long-standing challenge with the installation chapter. It was too long and contained too many topics for most users.
This pull request splits the install chapter into sections with the install chapter. Thankfully, much of the "do not repeat yourself" work was already done in earlier pull requests.
The pull request redirects bookmarks that linked to the previous locations like https://www.jenkins.io/doc/book/installing/#debianubuntu . It uses a Javascript technique that was described on a stackoverflow article.
The prerequisites have been extracted from the index.adoc page and inserted at the top of each of the relevant pages so that the reader installing for a specific platform can read linearly through the instructions for their platform.
CC: @zaycodes
CC: @vsilverman this will affect your work on replacing the blueocean image with the official docker image. I'll help with resolving conflicts and collisions as this progresses through the review process.
Before
After