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

Support for multiple doc versions on DRC #194

Open
zacharysarah opened this issue Nov 9, 2015 · 0 comments
Open

Support for multiple doc versions on DRC #194

zacharysarah opened this issue Nov 9, 2015 · 0 comments

Comments

@zacharysarah
Copy link

What is needed?

The ability to serve multiple versions of docs to users from a single doc source.

Users select which doc version to view from the same URL. For example, on the front end, https://developer.rackspace.com/docs/ links to different versions of the same docs. On the back end, different versions are generated from the same source.

Why are multiple versions needed?

  1. Users need clear, unambiguous support for their product version.

The Repose dev team states that their largest source of 1-to-1 support contacts is user confusion over versioned instructions presented side-by-side in dev docs.

  1. Versioned docs can reduce 1-to-1 support contacts.

The Repose team is small; consequently, the team fills its support roster by rotating developers out of production and development.

  1. The need for versioned docs will grow.

The Repose use case is not unique. As more Rackspace product teams migrate content to Nexus, the number of use cases for versioned docs will likely increase.

How might we support versioned docs?

Maybe by configuring automated build tools to support GitHub tags?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant