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

Version picker for the docs (sphinx extension) #1885

Open
nicolan opened this issue Apr 5, 2017 · 2 comments
Open

Version picker for the docs (sphinx extension) #1885

nicolan opened this issue Apr 5, 2017 · 2 comments
Assignees
Labels
diceroll assigned by dice roll documentation requires documentation updates

Comments

@nicolan
Copy link

nicolan commented Apr 5, 2017

Cyrus has a number of different versions that we maintain concurrently (for varying values of 'maintain').

At the moment there is 2.5 (old stable, most users are still on, some bugfixes getting backported), 3.0 (stable, not yet widely adopted), master (development) and sort of 2.4 (old old sunset stable, only emergency security fixes).

We want to be able to provide easy access to the different versions of docs on the website. At the moment this is accomplished via urls www.cyrusimap.org/ (where version is 2.5, 3.0 (alias stable) and dev). Each version has its own directory on the web server.

Goal: have a version picker like on sphinx-doc.org that toggles the versions for you without having to scrabble around with the urls. This version picker needs to be present across all versions of Cyrus docs.

@nicolan nicolan added the documentation requires documentation updates label Apr 5, 2017
@elliefm
Copy link
Contributor

elliefm commented Apr 5, 2017

The place for most of this to live is probably going to be in the cyrusimap.org repository (https://github.com/cyrusimap/cyrusimap.org), rather than the cyrus-imapd repository. That way it can sit across all versions independently of them, and doesn't need to be precariously maintained across a bunch of different branches.

@brong brong assigned elliefm and unassigned chris-morgan Aug 7, 2017
@brong brong added the diceroll assigned by dice roll label Aug 7, 2017
@nicolan nicolan assigned nicolan and unassigned elliefm Aug 7, 2017
@nicolan
Copy link
Author

nicolan commented Aug 7, 2017

I think I can build this myself now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
diceroll assigned by dice roll documentation requires documentation updates
Projects
None yet
Development

No branches or pull requests

4 participants