Improve link to GitHub example

[pyther-hub]

This is in respect to this issue #6887
I have added the content that was asked and added it.

[kmartens27]

Hi @pyther-hub, it appears that the form validation work has crossed over into this PR. I'm assuming that it should not have been included, similar to the other instance. Unless that should be there, then disregard my comment!

[MarkEWaite]

Mixes multiple changes (7 commits) into the pull request.

You will probably find it simpler in your local development workflow if you start each pull request with a new branch that is based on the current master branch of the upstream repository. The commands that I use are:

git clone https://github.com/jenkins-infra/jenkins.io
cd jenkins.io
gh repo set-default
gh repo fork --default-branch-only # Answer yes to create the fork and create a remote for the fork
git pull --all --prune
git checkout -b fix-issue-XXX upstream/master
gh pr create --title "Fix:XXX my description"

[pyther-hub]

okay sir got it I have removed that part, I do make branch for every issue that I work I do not know how the previous branch changes also appear, I will sure to put my attention to this in future
Thank you for your guidance @MarkEWaite and @kmartens27

[MarkEWaite]

I do not know how the previous branch changes also appear

When you create the new branch, you need to tell it the base branch that will be used and that needs to be 'master' or 'upstream/master'. If you don't tell it the base branch, then git uses the current branch.

For example, git checkout -b my-new-branch will create a new branch based on the current HEAD (branch). If the current branch is a pull request that you have already submitted, then that will be the new branch. If you instead use git checkout -b my-new-branch upstream/master then it will create the new branch with the same location as 'upstream/master'.

[kmartens27]

Thank you very much @pyther-hub, I have provided some suggestions and reworded the note you had originally added. Please let me know if that makes sense and if you have any other questions!

[kmartens27]

Suggested change

Note:- There is a major technical obstacle in the way of content migration from the wiki. This difficulty stems from the requirement that, when the material has been properly moved, the out-of-date wiki page be removed and a redirection mechanism to the migrated version be set up. After migration, the continued existence of out-of-date wiki pages causes a number of problems, such as duplication, confusion, and unclear migration progress. This persistence not only makes the process more difficult overall, but it also makes it more difficult to identify which material has already been migrated and which is still waiting, which makes the work at hand much more difficult.

NOTE: After migration, the continued existence of out-of-date wiki pages causes a number of problems, such as duplication, confusion, and unclear migration progress. This persistence not only makes the process more difficult overall, but it also makes it harder to identify which pages have already been migrated and which are still waiting. This is a major technical obstacle in the way of content migration from the wiki. When migrating documentation, after the material has been properly moved, the out-of-date wiki page must be removed and a redirect must be configured to the migrated version.

I have reworded some of the content, and moved it accordingly to try and make it read more clearly. I have also adjusted the NOTE: macro so that it is implemented as a note on the page, thus giving it a different visual/making it stand out more. There were also a few instances where a singular version of a word was used instead of the plural.

[pyther-hub]

Along with this I have made new line for each sentence also

[kmartens27]

Thanks very much @pyther-hub, approved pending suggestion application.

If you have any questions on what I've suggested, definitely let me know and I'm happy to discuss!

[pyther-hub]

@kmartens27 if you feel that the work is sufficient please merge this

[kmartens27]

Thanks @pyther-hub, if you could review the suggestion I have made, that should be a suitable replacement for the original text.

[kmartens27]

committed updated note

[kmartens27]

thank you very much for all your work on this @pyther-hub! The updates look good and correct so I'm approving.

[kmartens27]

@MarkEWaite when you have a moment, would you be able to review the updated content?

[kmartens27]

Hi @pyther-hub, I was reading over the documentation and the issue this is intended to resolve, and I think this should be a part of the actual instructions instead of a note at the end. It is a crucial step to finish the process properly, so it makes sense to update the instructions to include this. Alternatively, it could be a new section with its own header if the redirect instructions are included.

[pyther-hub]

Understood, @kmartens27 . I'll do the required adjustments. Apologies for the delay, but I'm currently preoccupied with my college unit exams and end-of-semester exams, will do it ASAP

[kmartens27]

@pyther-hub would you be okay with me making some changes to text to include it in the instructions? I would rather help take care of this and allow you to focus on your exams.

[pyther-hub]

Okay no problem sir, thank you for the help 😊

[github-actions]

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