Update Gallery with xbatcher ML Cookbook
Closed this issue · 14 comments
Root Repository Name
xbatcher-ML-1-cookbook
Did you check if your contribution would be better suited as an addition to an existing Cookbook, before generating a new one?
yes
Additional comments
Confused on what I'm supposed to pull here, so this might take a few attempts.
Thank you for your contribution 🎉, @cmdupuis3!
We're currently running validation checks to make sure the contents of your submission are okay. An update will be posted here shortly once the validation checks are passing.
Hey @cmdupuis3! Thanks for starting here. Confusion is normal, we're still ironing out the contributor's guide updates to make this smoother. If you're ready for your cookbook to be published, then our next steps are to transfer your repository over to the ProjectPythia organization, where you'll still be the primary maintainer of the content. If you're ready to start this process, I can point you in the right direction.
@dcamron Great, so the problem I have is that the contributor's guide says to create a branch, and later says to start a pull request, but I'm not sure how the two go together. See this issue for details.
Would it be correct to merge my branch into my fork's main?
Section 3 of that guide is more about ways you can integrate the infrastructure provided in our template into your development workflow, where you open PRs against your own cookbook and get some automated checks and previews to run on your code changes. For publishing your cookbook, we have to move on to section 4 of the contributor's guide, where we transfer your repository to live inside of this ProjectPythia organization. I can help you start that process.
Actually, I would need to be added to the ProjectPythia contributors. Can you do that?
Looks like you accepted the invite and transferred your repo successfully to ProjectPythia/xbatcher-ML-1-cookbook. Take a minute to update your JupyterBook's _config.yml with appropriate title, authorship, description, domain/package tags, and optionally a thumbnail. These will be used in generating the gallery card for your cookbook. Then, all you need to do is edit your original post at the top here to reference only xbatcher-ML-1-cookbook under Root Repository Name. Once you make that edit, the bot should go open a PR for you to publish your cookbook!
Sounds good!
So if I want to rerun the bot, I just edit the OP? Or is there some command for that or something?
@cmdupuis3, your submission looks great! We've created a pull request on your behalf using the information you provided.
The pull request can be accessed from this url: #123.
Looks like you got it! You can check the preview for your gallery entry over in that PR now.
Cool! Clicking on the preview though, I mostly see stuff from the template repo. Is that normal?
Cool! Clicking on the preview though, I mostly see stuff from the template repo. Is that normal?
No! We should be able to see the actual cookbook in the preview. @dcamron any idea what went wrong there?
BTW I can't access the Settings tab to change permissions (as per sction 4.3). Can someone fix that?
We should move that step earlier in the guide, and it's set appropriately already for your repo. That appears to be a limitation of being designated an "outside collaborator" instead of an organization member. I'll take a look at that, but it should be good for now.
Separately, I don't see anything wrong with the preview in the PR myself?
I think it updated or something... before, you'd see my thumbnail on the gallery page, but on clicking it you'd see the template readme.