jenkins.io
jenkins.io copied to clipboard
jenkins-infra
Add updating Jenkins section in User's Handbook
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
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
@krisstern Hi I created this PR #5890 doing what you instructed thanks for your time
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.
I can close that PR #5890 and commit the changes to this PR so this can be merged/reviewed much faster
@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
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.
I'll also correct the heading size as right now the page looks like a mess
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
I'll also correct the heading size as right now the page looks like a mess
Sure, sounds like a good idea
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
Sorry for the commits I was resolving some conflicts and didn't realise i was committing old changes too
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%]
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
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 (:)
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.
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
You may want to clean up this PR with the extra commits not intended for this PR.
@krisstern Looks good now ? i have squashed the commits and cleaned the history
The only concern I have regarding CSS is the overlapping layout here for the Linux upgrading instructions, but it is not fatal, at least for now:
Thanks @MarkEWaite and @krisstern I'll do the suggested revisions @krisstern Related to the CSS problem can you give me the source css file I'll correct that too
@Vandit1604 There is actually a quicker way to commit suggested changes on GitHub in batch. Next time, directly do to the Files Changed tab and add the changes one-by-one to the same batch, before clicking on a button on the same page to commit everything in bulk. That way would be more efficient (and create less noise for those who are watching this repo too).
Thanks @MarkEWaite and @krisstern I'll do the suggested revisions @krisstern Related to the CSS problem can you give me the source css file I'll correct that too
For the current website build setup we do not have one CSS file for each layout, but I suggest finding out where is best to place the CSS code on your own first, before I make more suggestions. We are currently using Awestruck as the build tool, which is no longer maintained and does not provide ready documentation versioning. One of the GSoC 2023 projects is actully to migrate the jenkins.io website to using a more modern build tool like Antora building on AsciiDoc.
There is actually a quicker way to commit suggested changes on GitHub in batch. Next time, directly do to the
Files Changedtab and add the changes one-by-one to the same batch, before clicking on a button on the same page to commit everything in bulk. That way would be more efficient (and create less noise for those who are watching this repo too).
Sorry for the noise i didn't know that we can commit the suggested changes in bulk I'll keep that in mind next time
Thanks @MarkEWaite and @krisstern I'll do the suggested revisions @krisstern Related to the CSS problem can you give me the source css file I'll correct that too
For the current website build setup we do not have one CSS file for each layout, but I suggest finding out where is best to place the CSS code on your own first, before I make more suggestions. We are currently using Awestruck as the build tool, which is no longer maintained and does not provide ready documentation versioning. One of the GSoC 2022 projects is actully to migrate the jenkins.io website to using a more modern build tool like Antora built on AsciiDoc.
Yeah I know about that Discussion is still going between Hugo and Antora But Antora would be the better candidate as Hugo goes more into the security aspects while Antora provides the Documentation based on versions Then I'll see what can be done for that CSS problem Thanks for the info
Sorry for the noise i didn't know that we can commit the suggested changes in bulk I'll keep that in mind next time
No worries, we all learn by trial-and-error sometimes.
For now i have added some more chapters for upgrading and i'm still working on the table of content problem as due to its css its floating over the content. I have added some more details in some sections if some thing is still not correct feel free to suggest changes thank you for your time
Maybe on the page such as content/doc/book/updating/index.adoc try to add the line :toc: left to replace :toc: such that you will have something like:
ifdef::backend-html5[]
...
:toc: left
...
endif::[]