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

"Edit this page on github" links in the docs seem to be broken #705

Open
james-garner-canonical opened this issue Sep 11, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@james-garner-canonical
Copy link

Request type

Fix

What needs to get done

"Edit this page on github" links in the docs seem to be broken. I expected that clicking the link would take me through the equivalent of clicking the edit button on the appropriate document in this repo (i.e. create a fork and take me to the file for editing). These links should probably be updated to reflect the current project structure, or removed if this is no longer a supported way of contributing changes to the documentation.

Documentation location

https://documentation.ubuntu.com/rockcraft/en/latest

Additional information

Clicking the "Edit this page on github" links in the tutorial results in a github 404
image

To reproduce:

  1. Navigate to this page https://documentation.ubuntu.com/rockcraft/en/latest/tutorial/hello-world/
  2. Click the Edit this page on github link at the bottom
@medubelko
Copy link
Contributor

@james-garner-canonical Thanks for the report!

The root cause is bad path composition in the template's footer. We're tracking the fix here: canonical/canonical-sphinx#56

We'll close this issue once it's been patched and deployed.

@medubelko medubelko added the bug Something isn't working label Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants