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

Internal links in documentation site are broken #1268

Open
elmimmo opened this issue Jul 5, 2021 · 2 comments
Open

Internal links in documentation site are broken #1268

elmimmo opened this issue Jul 5, 2021 · 2 comments
Assignees
Labels
status: accepted Ready to be further processed type: docs The issue is related to documentation

Comments

@elmimmo
Copy link

elmimmo commented Jul 5, 2021

Most internal links at https://w3c.github.io/epubcheck/ point to somewhere below /publishing/epubcheck/…, where there seems to be nothing.

Instead of fixing the /publishing/ part, though, having those simply be relative to the document they are in instead of the site’s root (specially when they point to a lower level in the tree hierarchy) should make it more future-proof and easier to maintain.

@rdeltour
Copy link
Member

rdeltour commented Jul 5, 2021

the canonical URL of the site is https://www.w3.org/publishing/epubcheck/. That's why the links use /publishing/epubcheck/ as a prefix.

But due to technical limitations, redirection from the github.io to w3.org domain cannot be configured. We'll look into how to improve the situation. If needed, we can always use absolute URLs everywhere 🤔

@rdeltour rdeltour self-assigned this Jul 5, 2021
@rdeltour rdeltour added status: accepted Ready to be further processed type: docs The issue is related to documentation labels Jul 5, 2021
@elmimmo
Copy link
Author

elmimmo commented Jul 5, 2021

If needed, we can always use absolute URLs everywhere

My suggestion was actually relative URLs everywhere, but to the document instead of the root. For instance, “Introduction” at https://w3c.github.io/epubcheck/docs/ should link to getting-started/ instead of /epubcheck/docs/getting-started/ (or the current /publishing/epubcheck/docs/getting-started/).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepted Ready to be further processed type: docs The issue is related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants