-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
[DOC/WEB]: Resolving 'Getting started' URL ambiguity in pandas.io(Issue #32307) #39303
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
[DOC/WEB]: Resolving 'Getting started' URL ambiguity in pandas.io(Issue #32307) #39303
Conversation
…uravPal1995_Issue32307
…uravPal1995_Issue32307
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.
Good start! To follow through on removing the duplicate page:
- Have the navigation bar point to
/docs/getting_started/index.html
- Delete the old page
- Add a redirect
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.
Need someone who knows more than me to advise on how to handle the redirect. Otherwise, looks good to me!
@@ -5,6 +5,9 @@ | |||
whatsnew,whatsnew/index | |||
release,whatsnew/index | |||
|
|||
# web | |||
getting_started,docs/getting_started/index |
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.
Ah, hmm, now realizing this probably won't work for pages outside of /docs/
. Any maintainers have thoughts about how to handle?
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.
Thank you @afeld !!
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.
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.
Thank you @jreback
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.
Indeed, this file is specifically for sphinx page (so under /docs
in the url), and not for the website. So we will have to do something custom there if we want a redirect (I don't think there is a similar mechanism already).
In the end, for those redirects listed in this file, we create a small html page with the actual redirection. See
Lines 211 to 220 in 097ff0c
<html> | |
<head> | |
<meta http-equiv="refresh" content="0;URL={row[1]}.html"/> | |
</head> | |
<body> | |
<p> | |
The page has been moved to <a href="{row[1]}.html">{title}</a> | |
</p> | |
</body> | |
<html>""" |
So one option would be to include a single hardcoded html file for this specific redirect, or otherwise add something similar to https://github.com/pandas-dev/pandas/blob/master/web/pandas_web.py which generates the static web pages
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.
Should this aspect be dealt with in a separate PR? I am not sure what to do. Should I revert this specific change in the docs/redirects.csv
? Or should I add the aforementioned pandas/doc/make.py
?
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.
Yes, the change here in redirects.csv
should be reverted
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.
Okay... Thank you @jorisvandenbossche .. 😄 :
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.
After removing the change in this file, let's add getting_started.html
with a <meta>
redirect to /docs/getting_started/index.html
.
@afeld I just noticed that the |
what do we need to do there @jorisvandenbossche @afeld |
I'm probably biased, but I'm -10 here. I don't see the duplication on those pages. For a user without knowledge of Python, Jupyter, Conda... The page you are removing is a great starting point, and they should be able to get a pandas hello world with further research. The Getting started in the docs does not accomplish that, and assumes you've got a Python working environment, and provides lots of information that is intimidating for someone just starting. I think we're doing a very poor favor to many our users by removing this page. |
Thanks for the PR, but appears that this change needs more discussion on the original issue first before coming to a conclusion. Since discussion here has generally stalled, closing for now |
The Following goals are being accomplished in this PR:
/docs/getting_started/index.html
from/getting_started.html
pandas/web/pandas/getting_started.md
.#32307