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

Jump to bottom

Add updating Jenkins section in User's Handbook #5888

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

Add updating Jenkins section in User's Handbook #5888

wants to merge 75 commits into from
+377 −0

Conversation

Vandit1604
Copy link
Contributor

Windows and Linux sections are based on my knowledge and @krisstern helped in macOS section for upgrading jenkins other than that every thing is compiled by me after reading blogs and questions answered on community forum of jenkins
feel free to add upgrading instructions for other sections
this closes #5059

@Vandit1604 Vandit1604 requested a review from a team as a code owner January 7, 2023 11:58
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Jan 7, 2023
@krisstern
Copy link
Member

Hi @Vandit1604 Try adding a file with your GitHub username as the file name in here for the authors: https://github.com/jenkins-infra/jenkins.io/tree/master/content/_data/authors

@Vandit1604 Vandit1604 mentioned this pull request Jan 7, 2023
Closed
@Vandit1604
Copy link
Contributor Author

@krisstern Hi I created this PR #5890 doing what you instructed
thanks for your time

@krisstern
Copy link
Member

Maybe it would be better originally to have the changes you made in PR #5890 to this PR instead. Now you will have to wait until that PR is merged and pull the latest changes to this PR later before every check is passed.

@krisstern krisstern changed the title add updating jenkins section in userhandbook Add updating Jenkins section in User's Handbook Jan 7, 2023
@Vandit1604
Copy link
Contributor Author

I can close that PR #5890 and commit the changes to this PR so this can be merged/reviewed much faster

@krisstern
Copy link
Member

Sure

@krisstern
Copy link
Member

@Vandit1604 It appears there are some bugs to be patched before the checks are passed:

[2023-01-07T14:30:23.323Z] Failing build due to warnings in log output:

[2023-01-07T14:30:23.323Z] asciidoctor: WARNING: doc/book/updating/_update-wizard.adoc: line 16: section title out of sequence: expected level 2, got level 4

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/download/index.html.haml:156: warning: calling URI.open via Kernel#open is deprecated, call URI.open directly or use URI#open

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/download/index.html.haml:97: warning: calling URI.open via Kernel#open is deprecated, call URI.open directly or use URI#open

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_layouts/corebaseline.html.haml:9: warning: calling URI.open via Kernel#open is deprecated, call URI.open directly or use URI#open

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:11: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:13: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:15: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:16: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.323Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:17: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:20: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:22: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:24: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:26: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:27: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:28: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/_partials/changelog-changes.xml.haml:9: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/security/advisories/rss.xml.haml:40: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/security/advisories/rss.xml.haml:42: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/security/advisories/rss.xml.haml:46: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/security/advisories/rss.xml.haml:48: warning: Using the last argument as keyword parameters is deprecated

[2023-01-07T14:30:23.324Z] /home/jenkins/workspace/Websites_jenkins.io_PR-5888/content/security/advisories/rss.xml.haml:52: warning: Using the last argument as keyword parameters is deprecated

krisstern
krisstern requested changes Jan 7, 2023
View reviewed changes
content/doc/book/updating/_update-wizard.adoc Outdated Show resolved Hide resolved
content/doc/book/updating/_update-wizard.adoc Outdated Show resolved Hide resolved
content/doc/book/updating/_update-wizard.adoc Outdated Show resolved Hide resolved
@krisstern
Copy link
Member

Currently the images are not showing yet in the preview version at https://deploy-preview-5888--jenkins-io-site-pr.netlify.app/doc/book/updating and some pages like the one on Windows appear to need some polish up (like with additional description/explanation for each step added). I will let the @jenkins-infra/copy-editors team to review the PR in more depth.

@Vandit1604
Copy link
Contributor Author

I'll also correct the heading size as right now the page looks like a mess

@krisstern
Copy link
Member

For an example of a working link to images:

[.boxshadow]
image:tutorials/setup-jenkins-02-unlock-jenkins-page.png[alt="Unlock Jenkins page",width=80%]

This is taken from https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/book/installing/windows.adoc

@krisstern
Copy link
Member

I'll also correct the heading size as right now the page looks like a mess

Sure, sounds like a good idea

@Vandit1604
Copy link
Contributor Author

For an example of a working link to images:

[.boxshadow]
image:tutorials/setup-jenkins-02-unlock-jenkins-page.png[alt="Unlock Jenkins page",width=80%]

I have added the images just like that after seeing how images were added in other pages
I'll check it again if the path to the image is broken or some image has the same name

@Vandit1604
Copy link
Contributor Author

Sorry for the commits
I was resolving some conflicts and didn't realise i was committing old changes too

@krisstern
Copy link
Member

You have for the image link now for example: image::/content/images/updating/check-jenkins-version.png[alt="Checking Version of Updated Jenkins Instance",width=80%]

I think it should really be like the following with boxshadow to keep the styling consistent:

[.boxshadow]
image:updating/check-jenkins-version.png[alt="Unlock Jenkins page",width=80%]

@krisstern
Copy link
Member

And @Vandit1604 You may want to put your image in here instead: https://github.com/jenkins-infra/jenkins.io/tree/master/content/doc/book/resources

@Vandit1604
Copy link
Contributor Author

You have for the image link now for example: image::/content/images/updating/check-jenkins-version.png[alt="Checking Version of Updated Jenkins Instance",width=80%]

I think it should really be like the following with boxshadow to keep the styling consistent:

[.boxshadow]
image:updating/check-jenkins-version.png[alt="Unlock Jenkins page",width=80%]

this was how it was before i checked in asciidoctor docs there it is mentioned you can use either (:) or (::) colon but i'll change it to one colon (:)

@krisstern
Copy link
Member

You have for the image link now for example: image::/content/images/updating/check-jenkins-version.png[alt="Checking Version of Updated Jenkins Instance",width=80%]
I think it should really be like the following with boxshadow to keep the styling consistent:

[.boxshadow]
image:updating/check-jenkins-version.png[alt="Unlock Jenkins page",width=80%]

this was how it was before i checked in asciidoctor docs there it is mentioned you can use either (:) or (::) colon but i'll change it to one colon (:)

Look I gave you the exact path you are supposed to use, in a folder called updating within the path content/doc/book/resources. Please be careful with reading the instruction. I was not suggesting just a symbol change.

@krisstern
Copy link
Member

@Vandit1604 The paths you are using are currently all broken paths.

@Vandit1604
Copy link
Contributor Author

Look I gave you the exact path you are supposed to use, in a folder called updating within the path content/doc/book/resources. Please be careful with reading the instruction. I was not suggesting just a symbol change.

Sorry
I have committed the correct path now

@Vandit1604 Vandit1604 requested review from kmartens27 and krisstern and removed request for kmartens27 and krisstern February 18, 2023 19:35
@github-actions github-actions bot added the unresolved-merge-conflict There is a merge conflict with the target branch. label Sep 22, 2023
@github-actions
Copy link
Contributor

Please take a moment and address the merge conflicts of your pull request. Thanks!

@github-actions github-actions bot removed the unresolved-merge-conflict There is a merge conflict with the target branch. label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dduportal dduportal dduportal left review comments

@MarkEWaite MarkEWaite MarkEWaite requested changes

@krisstern krisstern krisstern approved these changes

@kmartens27 kmartens27 Awaiting requested review from kmartens27

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Installing Linux page has no upgrade instructions
5 participants
@Vandit1604 @krisstern @kmartens27 @MarkEWaite @dduportal