Launchpad: fix broken links

[jugmac00]

Documentation: https://documentation.ubuntu.com/launchpad/en/latest/how-to/
GitHub repo: https://github.com/canonical/launchpad-manual
Contribution guide: https://documentation.ubuntu.com/launchpad/en/latest/contribute-to-our-docs/

For the migration of the documentation, a lot of existing documentation was transferred from other platforms, where no checks were performed before. Some of the added pages were excluded from the new link checks.

Task: remove the exceptions one by one from https://github.com/canonical/launchpad-manual/blob/f410f03e21bb70720c2763225b4313744a09cd4b/custom_conf.py#L112 (e.g.'Trunk/Glue', # needs update), run the link checks (make linkcheck), fix the broken links, and create a pull request, preferably one for each page to make reviews easier. Only the links marked with needs update need to be considered.

[nielsenjared]

I'm interested in this issue!

[jugmac00]

@nielsenjared Sounds great! Please let us know if you need any support.

[nielsenjared]

Hey @jugmac00! Where do I find the correct links?

Here's some context:

• I removed 'Trunk/Glue', ran linkcheck and received an error as outlined above and expected.
• I found reference to 'Trunk/Glue' in ./explanation/branches.rst (AKA "Where's trunk?")
• I can't find the 'Trunk/Glue' page in the repository.
• I can't find the 'Trunk/Glue' page on the new docs https://documentation.ubuntu.com/launchpad/en/latest/
• I did find the 'Trunk/Glue' page via Google (as well as a a lot of auto repair tutorials) on what I assume is the old doc site https://dev.launchpad.net/Trunk/Glue

Is this the link I need to use? Am I missing something in the repo or the new site?

[nielsenjared]

Hey @jugmac00!
I think I addressed what I can here. I'm unable to locate the files that correspond to the links below. I tracked down their legacy versions and used that content to cross-reference the new repo. In some instances I was able to find updated/renamed versions of the pages, but not for the following:

• '/Concepts'
  • referenced in explanation/code.rst
  • legacy: https://dev.launchpad.net/Code/Concepts
• '/HowToUseCodehostingLocally'
  • referenced in /explanation/code.rst
  • legacy: https://dev.launchpad.net/Code/HowToUseCodehostingLocally
• ‘Database/TableRenamePatch
  • referenced in explanation/live-patching.rst
  • legacy: https://dev.launchpad.net/Database/TableRenamePatch
• 'Debugging#Profiling%20page%20requests'
  • referenced in explanation/error-explanations.rst
  • legacy: https://dev.launchpad.net/Debugging
• 'Debugging#Special%20URLs'
  • referenced in explanation/database-performance
  • legacy: https://dev.launchpad.net/Debugging
• JavascriptUnitTesting/MockIo
  • explanation/javascript-unittesting.rst
  • legacy: https://dev.launchpad.net/JavascriptUnitTesting/MockIo#Profiling-page-requests
• 'PolicyAndProcess/Accessibility'
  • referenced in how-to/triage-bugs.rst
  • legacy: https://dev.launchpad.net/PolicyAndProcess/Accessibility#Profiling-page-requests
• ‘Soyuz’
  • referenced in explanation/code.rst
  • legacy: https://dev.launchpad.net/Soyuz/HowToUseSoyuzLocally
• ‘Translations/Specs/UpstreamImportIntoUbuntu/FixingIsImported/setCurrentTranslation’
  • referenced in explanation/engineering-overview-translations.rst
  • legacy: https://dev.launchpad.net/Translations/Specs/UpstreamImportIntoUbuntu/FixingIsImported/setCurrentTranslation
• 'attachment:codehosting.png'
  • referenced in explanation/code.rst
  • legacy: https://dev.launchpad.net/Code?action=AttachFile&do=view&target=codehosting.png
• ‘attachment:TranslationsSchema.dia’
  • referenced in explanation/engineering-overview-translations
  • legacy: N/A (https://dev.launchpad.net/Translations/EngineeringOverview?action=AttachFile&do=upload_form&ticket=006685735a.b4edb2d7e9306e880587ede0fb5e6a94ff007f74&target=TranslationsSchema.dia)

Let me know if I missed something or if I can help with anything else.

Cheers!

[jugmac00]

@nielsenjared Thanks so much for your contributed link fixes, and especially thanks for your investigation about the remaining items.

I went through the list and added some comments what I think needs to be done.

https://dev.launchpad.net/Code/Concepts
https://pastebin.ubuntu.com/p/StbrX2vn2v/

• needs to be imported

https://dev.launchpad.net/Code/HowToUseCodehostingLocally
https://pastebin.ubuntu.com/p/8QkDgWKS4P/

• needs to be imported

https://dev.launchpad.net/Database/TableRenamePatch
https://pastebin.ubuntu.com/p/svwKxcKdVY/

• needs to be imported

https://dev.launchpad.net/Debugging
https://pastebin.ubuntu.com/p/NpJwWpwHHH/

• needs to be imported

https://dev.launchpad.net/JavascriptUnitTesting/MockIo
https://pastebin.ubuntu.com/p/Nqc6S55WXw/

• needs to be imported

https://dev.launchpad.net/PolicyAndProcess/Accessibility

• can be deleted, as a revamp of the UI is planned

https://dev.launchpad.net/Soyuz/HowToUseSoyuzLocally

• can be found under /how-to/use-soyuz-locally/

https://dev.launchpad.net/Translations/Specs/UpstreamImportIntoUbuntu/FixingIsImported/setCurrentTranslation

• can be removed

https://dev.launchpad.net/Code?action=AttachFile&do=view&target=codehosting.png

• copy / paste the image over from the old host

‘attachment:TranslationsSchema.dia’; referenced in explanation/engineering-overview-translations

• seems to be broken already on the old host; please remove

For the items marked with "needs to be imported", I will provide a pastebin link each with the raw rst (from the auto-migration script). These pages need to be integrated into our documentation, and for the time being a warning header should be set which indicates that these pages need to be manually revised, which can be done via...

.. include:: ../includes/important_not_revised.rst

I will provide the pastebin links with the raw migration content as soon as possible.

[nielsenjared]

Hey @jugmac00! I addressed everything but the files that remain to be imported. Let me know when they're available.

[jugmac00]

@nielsenjared I added the raw rst which was generated by the migration tool. Thanks a lot for all your support.