-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
Issue #13494: Redirects checks 404 error page from index.html to https://checkstyle.org/checks.html #14667
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this works
You need to test it on your local and confirm it works. We shouldn't be merging something which is untested.
src/xdocs/checks/index.html
Outdated
<head> | ||
<meta charset="UTF-8" /> | ||
<title>Redirecting...</title> | ||
<meta http-equiv="refresh" content="0; URL=https://checkstyle.org/checks.html" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
=> <meta http-equiv="refresh" content="0; URL=../checks.html" />
This has to work from our versioned documentation.
See https://checkstyle.org/#Previous_Version_Documentation
@rnveach , thanks a lot for the reply. |
Share a video of redirection in Chrome, Firefox. |
GitHub, generate website |
We should have website from GitHub bot |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
@rnveach , @romani ,
Could this error be from the other end and not from my side ? |
generate website on local and share sources of it your github.io to let us see that index.html is generated in required path. |
This comment was marked as outdated.
This comment was marked as outdated.
Your github.io has only 1 file in it. It needs to have all the files generated by the site command. |
Got it ! Thanks for your help @rnveach , I have pushed generated files. Please check https://manish-k-07.github.io/ However, https://manish-k-07.github.io/checks/ is giving 404 instead of "Access denied" like in branch ? |
https://github.com/MANISH-K-07/MANISH-K-07.github.io/tree/main/checks |
The redirection plate I added works. @rnveach , I will try to figure out why we are missing index while generating site. But as a completely different thought, could we simply insert this file at https://github.com/checkstyle/checkstyle.github.io/tree/master/checks or will it get overridden during every release by gh bot ? I'm not sure yet why index isn't getting generated. Any possible ideas ? |
Which is shouldn't as my review indicated above just to be clear.
My current thought right now is it is missing because it is not a doxia file. All other files are VM or XML files in the directory. I think you might need to research doxia and figure out how to play nice and integrate with it.
As for manually injecting into the github.io , I believe you are correct it will go missing. I am sure we erase and copy over new files each release. All our release scripts are in GH too. I currently do not feel we should make an override for just this one purpose yet, not while doxia is not investigated. I am going to mark this PR until it is investigated more. |
@rnveach , Sure I will try to dive into doxia.
I don't understand this part. The primary goal of this issue as you have mentioned in #13494 (comment) was to redirect https://checkstyle.org/checks/ to https://checkstyle.org/checks.html. Isn't a similar thing happening with my github.io repo? From #14667 (comment), for previous version docs, we are using sourceforge pages and not gh pages. So, isn't this a different issue as mentioned by @romani in #13494 (comment) ? Please correct me if I'm missing something here. I'm unable to properly understand your goal here |
#14667 (comment)
This doesn't matter, unless it concerns implementation. This PR is an HTML page, so I expect HTML to work wherever it is since its the browser that executes HTML. As of right now, we have not seen it working, so this is why this PR is blocked.
This is implementation. There is no htaccess in this PR, so I can't comment more on this and this would be a discussion in the issue, especially if you are asking how to proceed. However, I am fine with older versioned documentation pages not working and have this just be resolved for future versions after this issue is resolved. If it is serious enough, we could probably just copy the file needed to make this work to the specific versions. |
Got it now !!
Yes, this I figured out :)
seems html here works for redirection. Problem here is that we are missing this file on site generation which I will look into
Doxia is new to me.. might need some time to come up with a fix. I will get back on this PR soon |
GitHub, generate website |
Html file is still not generating properly. |
Part of #13494
I have added an
index.html
file that is theoretically supposed to redirect to a custom set url.The redirecting url has been set to https://checkstyle.org/checks.html from root.
The file added is very basic boiler plate with just a title and redirection link. If this works, we can add viewport, canonical link (for SEO), and anything else if required.