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

Improve our documentation hosting #268

Closed
sgrif opened this issue Apr 14, 2016 · 5 comments
Closed

Improve our documentation hosting #268

sgrif opened this issue Apr 14, 2016 · 5 comments

Comments

@sgrif
Copy link
Member

sgrif commented Apr 14, 2016

Right now we just have docs.diesel.rs, which points to the gh-pages branch of this repo, which is automatically updated when the build is green on master. What I'd like to do is host docs for each version as well. I'd like docs.diesel.rs/0.5.0 to point at the latest version, docs.diesel.rs/current to point at the latest release, and docs.diesel.rs/nightly to point at master. If it makes things easier, we can probably have the master branch live on a separate subdomain.

If anybody is interested in tackling this as a PR, just let me know what I need to do in terms of branches/dns records if anything. I'd like the process to remain semi-automated

@mcasper
Copy link
Contributor

mcasper commented Apr 15, 2016

Do we want docs.diesel.rs/<VERSION> to support every historical version of diesel, or just the most recent (major?) release? Just the past couple releases?

@sgrif
Copy link
Member Author

sgrif commented Apr 15, 2016

Probably every historical major/minor version, but not patch versions

On Thu, Apr 14, 2016, 10:16 PM Matt Casper notifications@github.com wrote:

Do we want docs.diesel.rs/ to support every historical version
of diesel, or just the most recent (major?) release? Just the past couple
releases?


You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub
#268 (comment)

@anp
Copy link
Contributor

anp commented Apr 19, 2016

Are the current docs building with all features enabled? As an example, I see uuid as an optional crate in Cargo.toml, but searching the current docs doesn't return any results about UUID columns.

@sgrif
Copy link
Member Author

sgrif commented Apr 22, 2016

We're meant to doc with all features enabled, but I believe I forgot to add uuid. Might be worth adding an all feature so there's a more local place to update this as new features are added.

@weiznich
Copy link
Member

That's fixed since #2269

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

No branches or pull requests

4 participants