Skip to content

Conversation

@RichardHoch
Copy link
Collaborator

@RichardHoch RichardHoch commented Feb 24, 2021

@RichardHoch RichardHoch marked this pull request as ready for review March 1, 2021 12:35
@RichardHoch RichardHoch changed the title WIP Fixing broken links in MTA docs Fixing broken links in MTA docs Mar 1, 2021
@RichardHoch
Copy link
Collaborator Author

@apinnick: please review.

@RichardHoch
Copy link
Collaborator Author

@apinnick -- something is odd with the link in line 148 of cli-args.adoc. I changed the link when resolving https://issues.redhat.com/browse/WINDUP-3033, a Jira that come in yesterday as I was working on this PR. I saw that in terms of the document referenced, Jira 3033 relates to the same broken document link as the Getting Started /Introduction to the Migration_Toolkit_for_Applications issue in this PR -- the broken link led to a 404 message, which i fixed.

I noticed that once I resolved the 404 issue, the link did not point to the exact section desired of the document: https://access.redhat.com/documentation/en-us/migration_toolkit_for_applications/5.1/html-single/introduction_to_the_migration_toolkit_for_applications/supported_configurations#migration_paths_getting-started-guide. Instead, the link only led to the document, not the correct section, meaning it needed additional work.

So I changed the link in line 148 of cli-args.adoc accordingly. When I previewed the rendered document using master.adoc, the link (in the warning message) worked perfectly, but in the bccutil and preview versions of the CLI guide (see the link in the warning message in http://file.emea.redhat.com/rhoch/01032021/clig/html-single/#target_argument_cli-guide), the document opens but not the correct section. (https://access.redhat.com/documentation/en-us/migration_toolkit_for_applications/5.1/html-single/introduction_to_the_migration_toolkit_for_applications/index#migration_paths). [Ctrl+Shift+A in any master.adoc lets you see a fully rendered version of the whole document, unlike when use the command with other .adoc files].

I have spent at least 2 hours on making small changes to the link in cli-args.adoc, but I still cannot get it to point correctly to the right section (https://access.redhat.com/documentation/en-us/migration_toolkit_for_applications/5.1/html-single/introduction_to_the_migration_toolkit_for_applications/index#migration_paths_getting-started-guide). Could you please take a look when you have time?

@apinnick
Copy link
Collaborator

apinnick commented Mar 2, 2021

@apinnick -- something is odd with the link in line 148 of cli-args.adoc. I changed the link when resolving https://issues.redhat.com/browse/WINDUP-3033, a Jira that come in yesterday as I was working on this PR. I saw that in terms of the document referenced, Jira 3033 relates to the same broken document link as the Getting Started /Introduction to the Migration_Toolkit_for_Applications issue in this PR -- the broken link led to a 404 message, which i fixed.

I noticed that once I resolved the 404 issue, the link did not point to the exact section desired of the document: https://access.redhat.com/documentation/en-us/migration_toolkit_for_applications/5.1/html-single/introduction_to_the_migration_toolkit_for_applications/supported_configurations#migration_paths_getting-started-guide. Instead, the link only led to the document, not the correct section, meaning it needed additional work.

So I changed the link in line 148 of cli-args.adoc accordingly. When I previewed the rendered document using master.adoc, the link (in the warning message) worked perfectly, but in the bccutil and preview versions of the CLI guide (see the link in the warning message in http://file.emea.redhat.com/rhoch/01032021/clig/html-single/#target_argument_cli-guide), the document opens but not the correct section. (https://access.redhat.com/documentation/en-us/migration_toolkit_for_applications/5.1/html-single/introduction_to_the_migration_toolkit_for_applications/index#migration_paths). [Ctrl+Shift+A in any master.adoc lets you see a fully rendered version of the whole document, unlike when use the command with other .adoc files].

I have spent at least 2 hours on making small changes to the link in cli-args.adoc, but I still cannot get it to point correctly to the right section (https://access.redhat.com/documentation/en-us/migration_toolkit_for_applications/5.1/html-single/introduction_to_the_migration_toolkit_for_applications/index#migration_paths_getting-started-guide). Could you please take a look when you have time?

Resolved

@RichardHoch
Copy link
Collaborator Author

@apinnick: please review. I ran the link checker again to be sure all links are OK.

@RichardHoch
Copy link
Collaborator Author

@apinnick: please review.

@RichardHoch
Copy link
Collaborator Author

@apinnick : changes made. Please review.

@apinnick apinnick merged commit 84ce53e into windup:main Mar 8, 2021
@RichardHoch RichardHoch deleted the fixlinks branch April 20, 2021 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants