Skip to content

Add Version Compare information to the RTD Footer Response #1463

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.

Sign up for GitHub

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

Jump to bottom
Closed
gregmuellegger opened this issue Jul 21, 2015 · 4 comments
Closed

Add Version Compare information to the RTD Footer Response #1463

gregmuellegger opened this issue Jul 21, 2015 · 4 comments
Labels
Improvement Minor improvement to code

Comments

@gregmuellegger
Copy link
Contributor

We want to unify the API calls for /api/v1/<project>/highest/<version> and /api/v2/footer_html in order to reduce the number of API calls.
@gregmuellegger
Copy link
Contributor Author

@ericholscher I have a few questions regarding this task.

  1. The version comparison call is part of API v1. Shall this be moved into API v2? Do we need to stay backwards compatible?
  2. The API calls are made from the readthedocs/core/static-src/core/js/readthedocs-doc-embed.js file. I noticed that the API is also called from the media/javascript/rtd.js file. Is this file still relevant?

@gregmuellegger gregmuellegger added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Jul 21, 2015
@ericholscher
Copy link
Member

We should just move the logic into the footer response. I don't believe we
need to maintain backwards compat, I don't think. It might make sense to
keep the logic seperate, and have an API endpoint for it, but to embed it
in the footer response on doc page load to decrease server requests, but
keep it available.

I believe rtd.js is old -- likely around for docs that haven't been rebuilt
in a long time.

On Tue, Jul 21, 2015 at 6:41 AM, Gregor Müllegger [email protected]
wrote:

@ericholscher https://github.com/ericholscher I have a few questions
regarding this task.

  1. The version comparison call is part of API v1. Shall this be moved
    into API v2? Do we need to stay backwards compatible?
  2. The API calls are made from the
    readthedocs/core/static-src/core/js/readthedocs-doc-embed.js file. I
    noticed that the API is also called from the media/javascript/rtd.js
    file. Is this file still relevant?

—
Reply to this email directly or view it on GitHub
#1463 (comment)
.

Eric Holscher
Maker of the internet residing in Portland, Oregon
http://ericholscher.com

@gregmuellegger
Copy link
Contributor Author

The API calls are made from the readthedocs/core/static-src/core/js/readthedocs-doc-embed.js file. I noticed that the API is also called from the media/javascript/rtd.js file. Is this file still relevant?

@ericholscher What's your take on this?

@gregmuellegger
Copy link
Contributor Author

Sorry ignore my comment. Your take on the rtd.js was hidden in the github UI because it thought it was part of the quoted email text...

@gregmuellegger gregmuellegger mentioned this issue Jul 30, 2015
Merged
@gregmuellegger gregmuellegger removed the Needed: design decision A core team decision is required label Jul 30, 2015
@ericholscher ericholscher mentioned this issue Jul 30, 2015
Merged
@gregmuellegger gregmuellegger mentioned this issue Aug 6, 2015
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Improvement Minor improvement to code
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ericholscher @gregmuellegger