Skip to content

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

Merged
merged 24 commits into from
Dec 21, 2022

Conversation

oddgrd
Copy link
Contributor

@oddgrd oddgrd commented Dec 3, 2022

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

@seanmonstar
Copy link
Member

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.

@seanmonstar
Copy link
Member

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.

@oddgrd
Copy link
Contributor Author

oddgrd commented Dec 14, 2022

Hi, thanks for sorting out the CI! So are you thinking something like guides/0.14/... and guides/1.0/...? I'll update the links as well then, since they are linked to master and not 0.14.

@seanmonstar
Copy link
Member

guides/0.14/... and guides/1.0/...

Yes, I believe so. I might go with guides/0.14/... and guides/1/.... The existing guides should probably redirect to the 0.14 ones, for now. We'll change them to 1 eventually.

@oddgrd
Copy link
Contributor Author

oddgrd commented Dec 16, 2022

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 graceful_shutdown from the 1.0 guides for now and I'll add it back in a follow-up PR.

Following that, what remains for this PR is to make choosing 1.0 or 0.14 guides ergonomic. I'm thinking get started goes to 1.0 by default, and we can have tabs in the nav bar for switching versions.

The reason I went for legacy and stable is I had some difficulty getting 1.0 and 0.14 to work in the url, but if you have any tips I am happy to change it.

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.

@oddgrd oddgrd marked this pull request as ready for review December 17, 2022 17:37
@seanmonstar
Copy link
Member

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?

@oddgrd
Copy link
Contributor Author

oddgrd commented Dec 21, 2022

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.

Copy link
Member

@seanmonstar seanmonstar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Phenomenal work! 🥳

@seanmonstar seanmonstar merged commit 41592d3 into hyperium:master Dec 21, 2022
@oddgrd oddgrd deleted the feat/update-server-guides branch December 21, 2022 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants