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

adds a navigational menu for docs #2399

Merged
merged 2 commits into from
Sep 4, 2014
Merged

adds a navigational menu for docs #2399

merged 2 commits into from
Sep 4, 2014

Conversation

alfredodeza
Copy link
Contributor

Which is basically pulling JS+CSS from the HTTP service shown in the src to the <head> tag.

Links to browsershots showing compatibility in almost every browser (lol Konkeror)

http://browsershots.org/http://ceph.com/docs/wip-8366/radosgw/

09-04-2014-13-09-33

@ghost
Copy link

ghost commented Sep 4, 2014

What about adding ceph.js to the repository so the documentation is self contained instead of requiring access to a file somewhere on the net ?

@alfredodeza
Copy link
Contributor Author

@dachary not really, because the HTTP service that is serving the JS and CSS is a generic service for Sphinx docs and it allows us to fix issues (or add new ones) without requiring to change the source of Ceph.

@ghost
Copy link

ghost commented Sep 4, 2014

@alfredodeza then it would be useful to add a blurb somewhere on how to maintain/update the ceph.js because I have no clue how it's done ;-)

@jcsp
Copy link
Contributor

jcsp commented Sep 4, 2014

  • I haven't checked, but presumably the rest of the document still works cleanly if the ayni URL is unavailable (or if docs are being viewed on a domain other than ceph.com)?
  • commit messages should start with component name like "doc: " in this case.

Alfredo Deza added 2 commits September 4, 2014 13:44
Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com>
Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com>
@alfredodeza
Copy link
Contributor Author

@jcsp reworded commits. And yes, this is purely asynchronous code so if it fails it just doesn't display.

johnwilkins added a commit that referenced this pull request Sep 4, 2014
doc: adds a navigational menu for docs

Reviewed-by: John Wilkins <john.wilkins@inktank.com>
@johnwilkins johnwilkins merged commit bbb7700 into master Sep 4, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants