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

Broken GitHub contributor link in footer #56

Open
medubelko opened this issue Sep 26, 2024 · 3 comments
Open

Broken GitHub contributor link in footer #56

medubelko opened this issue Sep 26, 2024 · 3 comments
Labels
bug Something isn't working

Comments

@medubelko
Copy link

Due to improper string composition in the footer, the Edit this page on GitHub link has a malformed path.

<a class="muted-link" href="{{ github_url }}/edit/{{ github_version }}{{ github_folder }}{{ pagename }}{{ page_source_suffix }}">Edit this page on GitHub</a>

All the Starcraft repos have this problem. Example: https://documentation.ubuntu.com/rockcraft/en/stable/

Originally reported in canonical/rockcraft#705

@SecondSkoll
Copy link
Collaborator

I believe you need to add an entry to the HTML context, otherwise the github_version will be the commit and not the branch. It should be something like:

'github_version': 'main',

@medubelko
Copy link
Author

medubelko commented Sep 27, 2024

That results in https://github.com/canonical/rockcraft/edit/maindocsindex.rst. In either case there are missing slashes, hence my suggestion that it was a string composition issue.

It looks like this might only affect Starcraft repos; Anbox Cloud doesn't have this problem. At that, it might be because it's inheriting from an old version of the starter pack, not the extension. I'll report back once my team has rebased their docs.

@SecondSkoll
Copy link
Collaborator

Strange, from the history there's no change between the 0.1.0 version and now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants