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 broken links in the documentation #108

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Sahil1479
Copy link

There are links in the documentation (docs/) that are supposed to point/redirect to some other .md files, but currently, clicking those links gives the error 404.

Reason: Incorrect paths.

Example:
https://github.com/pgeu/pgeu-system/blob/master/docs/confreg/index.md

On this page, none of the links is accessible.

Also added support to have them viewable both in the help system and standalone on GitHub, as suggested in #64.

@Sahil1479
Copy link
Author

@mhagander Could you please review this PR?

@Sahil1479
Copy link
Author

Is there anything that I need to change?

Copy link
Member

@mhagander mhagander left a comment

Choose a reason for hiding this comment

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

At least some links are still broken when viewed on gitub AFAICT. For example, going to the "Configuring a conference page", the very first link is a 404. So it probably needs another go-through of links to clean them up. Same thing in the payments documentation, has at least one broken link that needs to be fixed.

I'd really like it if we can get rid of the .md suffixes in the URls when rendered on the website, mainly because it just looks ugly :) Surely we can find some way to do that? If we want it compat with github, we probably need to put the md into the link in the file, but then remove it again when rendering in-site. This is not the end of the world if we can't figure it out, but it would be good to spent at least abit of time to see if we can do that.

And finally, in the regexp in urls, it should explicitly allow "nothing or .md", I think. And the current regexp is just plain wrong - it also allows .mx. Since a dot matches any character, not just the dot, and there's also no length limit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants