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

Add missing codehosting doc; fix broken link #106

Conversation

nielsenjared
Copy link
Contributor

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

It adds the missing "How To Use Codehosting Locally" page and fixes the corresponding link in code.rst. I put this file in the /how-to directory given the nature of its content, but let me know if it belongs elsewhere. Running make linkcheck throws a toctree error. Let me know if this needs to be added to an index.rst.

@jugmac00
Copy link
Member

jugmac00 commented Sep 6, 2024

Yes, indeed - we need to add all newly added files to an index. Thank you!

@nielsenjared
Copy link
Contributor Author

I added codehosting-locally under the "Launchpad development tips" in how-to/index.rst. Let me know if it belongs somewhere else. I'm no longer getting the toctree error, but I'm still getting this:

WARNING: unknown document: 'how-to/codehosting-locally' [ref.doc]

Let me know if I need to do anything to resolve it.

@jugmac00
Copy link
Member

Thanks! I won't be able to look into it this week, but I will hope to be able to follow up soon after that.

@jugmac00 jugmac00 added the Open Documentation Academy Community contribution via https://canonical.com/documentation/open-documentation-academy label Oct 9, 2024
@alvaro-crespo alvaro-crespo merged commit 5b319ab into canonical:main Oct 9, 2024
3 checks passed
@alvaro-crespo
Copy link
Contributor

alvaro-crespo commented Oct 9, 2024

Thanks a lot for the contribution @nielsenjared ! FYI the warning was coming from <../how-to/codehosting-locally>, that was missing the ../ when referencing the code hosting doc.

I'll also add this document inside the 'Launchpad Development Tips' section.

@nielsenjared nielsenjared deleted the ODA78-Launchpad_fix_broken_links-codehosting branch October 14, 2024 14:54
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.

3 participants