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.

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

Fix '../Trunk' #61

Merged

Conversation

nielsenjared
Copy link
Contributor

This PR refers to canonical/open-documentation-academy#78

On the legacy site, I found the missing link on https://dev.launchpad.net/PreMergeReviews routed to https://dev.launchpad.net/Trunk which is branches.rst in this repo.

I used the convention outlined in doc-cheat-sheet.rst:

- :doc:`Link text <index>`

Running make linkcheck throws this error, though:

$HOME/.../launchpad-manual/explanation/pre-merge-reviews.rst:46: WARNING: Mismatch: both interpreted text role prefix and reference suffix.

I'm not sure why, but it's also throwing this error, but not throwing it on main:

(explanation/engineering-overview-translations: line   75) broken    http://www.gnu.org/software/gettext/manual/ - HTTPConnectionPool(host='www.gnu.org', port=80): Max retries exceeded with url: /software/gettext/manual/ (Caused by ConnectTimeoutError(<urllib3.connection.HTTPConnection object at 0x7fc96455b940>, 'Connection to www.gnu.org timed out. (connect timeout=30)'))
make: *** [Makefile:110: linkcheck] Error 1

Copy link
Member

@jugmac00 jugmac00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @nielsenjared, thanks a lot for your contribution!

You accidentially added double underscore at the end of the :doc: instruction. Once you remove it, it works.

I double-checked the mentioned cheatsheet, and it is correctly documented there.

Is there anything we could do to improve the documentation?

And yes, I am aware, that rst is sometimes a bit hard to work with - though it is very powerful.

Copy link
Member

@jugmac00 jugmac00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@jugmac00 jugmac00 merged commit 2ca5b80 into canonical:main Jun 28, 2024
2 checks passed
@jugmac00 jugmac00 added the Open Documentation Academy Community contribution via https://canonical.com/documentation/open-documentation-academy label Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Open Documentation Academy Community contribution via https://canonical.com/documentation/open-documentation-academy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants