Stream: t-cargo/PubGrub

Topic: Moving into an organization


view this post on Zulip Alex Tokarev (Oct 16 2020 at 18:55):

Moving the repo out of my namespace, into an organization where you guys have more control, and me less responsibility.

This raises the next point: where are we going to move? I see 2 options:

  1. rust-lang
  2. new organization

With 1, I don't know the process for that to tell if we qualify. I would guess the project is too far from being usable in cargo for that. If we do migrate there, this point:

Explore extensions to fit the cargo use case. I'd prefer exploration to be first totally independent, to clearly identify the limits of current pubgrub to bend it for this use case.

makes exploring features for cargo out of rust-lang repo weird.

Does this leave us with option 2? If we reach the point of being good enough for cargo, it could be forked/moved the second time into rust-lang I guess.

view this post on Zulip Matthieu Pizenberg (Oct 16 2020 at 19:18):

@Alex Tokarev we may have more flexibility outside of rust-lang. If there are such org already set up for experimental stuff, we can join, otherwise we just set up a new one. It's not like it's very important for the time being. Maybe @Eh2406 can setup the org since he has more roots in the cargo projects. Once that's done, I'll transfer the repo to there

view this post on Zulip Alex Tokarev (Oct 16 2020 at 21:40):

Probably shouldn't matter who sets it up: it's probably possible to give us all the same admin role with equal permissions.

view this post on Zulip DPC (Oct 17 2020 at 00:38):

if you wish i can set that up

view this post on Zulip Eh2406 (Oct 17 2020 at 01:36):

If you want to set that up, go for it! Then the next question is name. pubgrub-rs?

view this post on Zulip Alex Tokarev (Oct 17 2020 at 08:30):

I'd vote for just pubgrub.

view this post on Zulip Alex Tokarev (Oct 17 2020 at 08:34):

if you wish i can set that up

Thanks for the offer. May I try that out myself? I'd like to familiarize myself more with the Github organizational tools.

Need to decide the name first of course :smile:

view this post on Zulip Matthieu Pizenberg (Oct 17 2020 at 10:10):

cargo-pubgrub for the org and pubgrub for the repo seems like the straitforward names. And as suggested in pubgrub#39 we could create a cargo-pubgrub repo in the cargo-pubgrub org starting with the things I mention in that issue

view this post on Zulip Alex Tokarev (Oct 17 2020 at 10:32):

pubgrub is unavailable. I'm okay with pubgrub-rs or cargo-pubgrub.

view this post on Zulip DPC (Oct 17 2020 at 14:07):

pubgrub-rs would make it consistent with the repo

view this post on Zulip DPC (Oct 17 2020 at 14:07):

also cargo-* notation is generally for a tool that you would install with cargo

view this post on Zulip Alex Tokarev (Oct 17 2020 at 14:22):

Makes sense. I'll create pubgrub-rs organization.

view this post on Zulip Alex Tokarev (Oct 17 2020 at 17:27):

https://github.com/pubgrub-rs

view this post on Zulip Alex Tokarev (Oct 17 2020 at 17:34):

Check out your emails for the invitation.

view this post on Zulip Alex Tokarev (Oct 17 2020 at 19:44):

Everyone's there! Just waiting for a repo to appear :eyes:

view this post on Zulip Alex Tokarev (Oct 17 2020 at 19:45):

@Matthieu Pizenberg Could you import it under pubgrub rather than pubgrub-rs? We have a suffix in the organization, so I think it would be cleaner without it.

view this post on Zulip Alex Tokarev (Oct 17 2020 at 19:46):

pubgrub for the repo seems like the straitforward names

Ah, that's already what you wanted to do!

view this post on Zulip Matthieu Pizenberg (Oct 17 2020 at 20:28):

yup, can I do it now? or are you guys in the middle of doing an issue / PR / anything that i'd not want to mess up with?

view this post on Zulip Eh2406 (Oct 17 2020 at 20:47):

I'm good to go!

view this post on Zulip Alex Tokarev (Oct 17 2020 at 20:50):

Yep let's do it!

view this post on Zulip Matthieu Pizenberg (Oct 17 2020 at 20:59):

transfer beeing processed by github. will have to change name after the transfer is completed

view this post on Zulip Alex Tokarev (Oct 17 2020 at 21:02):

Aaaand done! :tada:

view this post on Zulip Alex Tokarev (Oct 17 2020 at 21:12):

Documentation link broke: https://mpizenberg.github.io/pubgrub-rs/pubgrub/

Do we still need to host it on github.io when it's still available at https://docs.rs/pubgrub/?
The difference was the latest published version was on docs.rs, while docs from dev branch were hosted on github.io.
If we want to do that (I personally see no need when there is cargo doc --open), we should document this difference somewhere.

view this post on Zulip Alex Tokarev (Oct 17 2020 at 21:15):

New repository is hosted at: https://github.com/pubgrub-rs/pubgrub

view this post on Zulip Eh2406 (Oct 17 2020 at 21:18):

zulip links work thanks to github redirects
pubgrub#1

view this post on Zulip Matthieu Pizenberg (Oct 17 2020 at 22:00):

Might still be worth asking Alex to update the zulip links

For the docs hosted on github, it was mostly for people who might want to have a quick look at the current state of the API without having to download the repo. If you think that's not worth it we can remove it. Otherwise, we just have to adapt the action doing the publishing I think

view this post on Zulip Alex Tokarev (Oct 17 2020 at 23:32):

I set up 1 required review for PRs to dev.

view this post on Zulip Alex Tokarev (Oct 18 2020 at 00:03):

For the docs hosted on github, it was mostly for people who might want to have a quick look at the current state of the API without having to download the repo. If you think that's not worth it we can remove it. Otherwise, we just have to adapt the action doing the publishing I think

Tried to fix this to no avail. Will continue tomorrow.
It seems that the relevant options are here under Github Pages section: https://github.com/pubgrub-rs/pubgrub/settings
But it's not possible to select /pubgrub/ content root (that's where our index.html is placed by cargo doc), only / and /docs.
@Matthieu Pizenberg how was it setup before?

view this post on Zulip Matthieu Pizenberg (Oct 18 2020 at 00:11):

I'll have a look at it tomorrow. I remember struggling a bit before finding the right setup

view this post on Zulip Matthieu Pizenberg (Oct 18 2020 at 13:20):

@Alex Tokarev the whole doc directory is required, it's just that the home page is at https://pubgrub-rs.github.io/pubgrub/pubgrub/ since cargo doc add the name of the crate to the path (there could be multiple crates). It's fine, that's how it was also setup before. As I said in the PR, I've just updated the link in the repo description and removed the one in the readme.


Last updated: Oct 21 2021 at 21:02 UTC