-
Notifications
You must be signed in to change notification settings - Fork 67
docs(server): update server guides to 1.0 #74
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
docs(server): update server guides to 1.0 #74
Conversation
Oh, seeing no CI results, I'm reminded this repo still uses the now-defunct travis-ci. We'll need to convert it over to GH Actions. |
Alright, got CI working. I think what we'll notice now is that since some of the guides use hyper 0.14, and the new ones will be using 1.0, CI isn't setup to handle that. Soooo, I'm thinking next step is having a 0.14 and 1.0 section, for now. |
Hi, thanks for sorting out the CI! So are you thinking something like |
Yes, I believe so. I might go with |
I managed to split up the guides now, but the solution may be a bit hacky as I'm not familiar with jekyll. Now this PR has expanded a bit much in scope. So to get this over the line I will cut out Following that, what remains for this PR is to make choosing 1.0 or 0.14 guides ergonomic. I'm thinking The reason I went for legacy and stable is I had some difficulty getting PS. I also edited the CI script so it will test both versions. The script isn't very kind on the eyes, but I may be able to clean it up a bit tomorrow. |
0.14 guides were linking to `master` for examples and `1.0` for docs
Awesome! I think one last thing, and I think we're set: do we need to use redirects so that links to the existing guides will still work after? |
Sure! I'll add that later today. I have also "defaulted" to the 1.0 guides (Get Started leads to 1.0, front page is 1.0), but with links to 0.14 guides. The 1.0 guides are quite sparse still, so if you'd rather we default to 0.14 for now I can quickly do that as well. Either way I do plan to add more updated guides this week. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Phenomenal work! 🥳
This PR updates the server guides to 1.0, partially addressing hyperium/hyper#3068. I realized when starting this that the examples currently link to the master branch of hyper, so I'll create a PR for hyperium/hyper#3069 as well soon if it isn't picked up. I'm also wondering if we should merge these PRs to master, or keep them in a separate dev branch until 1.0 is released?
While updating these guides, I'll also try to make a note of API docs that feel lacking.
And of course, any feedback is very welcome. 🙂
Closes hyperium/hyper#3083
Closes hyperium/hyper#3069