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: remove missing js file. #17665
doc: remove missing js file. #17665
Conversation
could you prefix the title of your commit message with the subcomponent your are changing ? see https://github.com/ceph/ceph/blob/master/SubmittingPatches.rst#3-describe-your-changes, in this case, it would be "doc: ". |
Signed-off-by: linxuhua <linxuhua@unionpay.com>
@tchaikov ok |
f5598c0
to
85a51a7
Compare
@@ -1,5 +1,6 @@ | |||
{% extends "!layout.html" %} | |||
|
|||
{%- block extrahead %} | |||
<script type="text/javascript" src="http://ayni.ceph.com/public/js/ceph.js"></script> | |||
<!-- <script type="text/javascript" |
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.
could just remove file. in other words, to revert 35663fa. but let's wait for @alfredodeza 's call.
@djgalloway this is part of the "multi-version" doc support as referenced in http://tracker.ceph.com/issues/18075 Do you think we can address this? I do think we need something to navigate different versions. @joelin The problem with removing this today is that when we add it back, the gap in docs will mean some docs will not have the menu available. |
@alfredodeza TBH I think the overlay/bar that ayni provided was a little obtrusive and didn't mesh well with the overall look and feel of the docs.ceph.com layout. What about adding something to the sidebar that indicates which version of the docs are being displayed. Then users can click on the version number that takes them to another page with a list of available doc versions? |
@djgalloway I don't think any styling is set in stone. That can surely be improved (even though that is how every hosted Sphinx docs is on readthedocs.org). There are two problems right now:
|
@alfredodeza this is my confusion. i am working in two version now. but i can't got the old docs in website. so i build it in intranet. maybe i can working for this. I will submit a PR in the next few days. can anyone give me the structure of folder for docs as below? |
@joelin Our directory structure at that level is the release name that is a symlink back to the sha1 of the tip of the branch. e.g.,
The webserver, nginx, has a bunch of location definitions that serve up the proper directory based on release name (or branch) in the URL.
Does that answer your question? |
@alfredodeza is this change still relevant ? if we are expecting a better solution, probably we should close this PR at this moment. @noahdesu FWIW, since "Version navigation and alerting" is listed in https://pad.ceph.com/p/Ceph_Documentation. i am connecting the pad document to http://tracker.ceph.com/issues/18075 |
I think I would like to defer to @noahdesu and @neha-ojha I'm fine if they want to close this (or even merge) |
My instinct is to close this PR. But if it is solving any problem at all for anyone, merge it. Adding the version switching to the docs is on our roadmap, and will probably happen in the next phase. That will necessarily mean examining this existing javascript solution and making the keep/toss decision. |
the js file http://ayni.ceph.com/public/js/ceph.js is not avaliabled.
Signed-off-by: linxuhua linxuhua@unionpay.com