Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Substantial rewrite of the Cookbook guide #435

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 13 commits into from
Jun 7, 2024

Conversation

brian-rose
Copy link
Member

This PR get the Cookbook guide up to date and adds substantial detail on working with the Pythia infrastructure.

Closes #433

Copy link
Contributor

github-actions bot commented Jun 5, 2024

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: 3f52581
✅ Deployment Preview URL: https://projectpythia.github.io/_preview/435

@brian-rose
Copy link
Member Author

Here's a direct link to the preview of the new guide, since it's a bit hard to get to from the regular preview link: https://projectpythia.org/_preview/435/cookbook-guide.html

@brian-rose brian-rose marked this pull request as ready for review June 5, 2024 15:33
@brian-rose brian-rose requested a review from a team as a code owner June 5, 2024 15:33
@brian-rose brian-rose requested review from mgrover1 and r-ford and removed request for a team June 5, 2024 15:33
Co-authored-by: clyne <[email protected]>
r-ford
r-ford previously approved these changes Jun 6, 2024
Copy link
Member

@r-ford r-ford left a comment

Choose a reason for hiding this comment

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

I think all the changes here make sense.

This document is pretty large now, and I think it could be confusing for someone seeing it for the first time. I guess this is really a theme issue, but I can barely differentiate the heading levels, and there is no sidebar on the right with the section outline.

@brian-rose
Copy link
Member Author

I think all the changes here make sense.

This document is pretty large now, and I think it could be confusing for someone seeing it for the first time. I guess this is really a theme issue, but I can barely differentiate the heading levels, and there is no sidebar on the right with the section outline.

I had the same thought, I wished the level 2 and level 3 headings were easier to distinguish. I can try adding lines to separate the major sections.

Is the lack of a right sidebar a known theme issue? I see a button "toggle secondary sidebar" but it is non-functional.

@brian-rose brian-rose closed this Jun 6, 2024
@brian-rose brian-rose reopened this Jun 6, 2024
github-actions bot pushed a commit that referenced this pull request Jun 6, 2024
@brian-rose
Copy link
Member Author

Unfortunately horizontal lines don't help much because they are nearly invisible.

Copy link
Contributor

@clyne clyne left a comment

Choose a reason for hiding this comment

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

Review blocked until repository transfer issue is resolved

Copy link
Contributor

@clyne clyne left a comment

Choose a reason for hiding this comment

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

Thanks for doing this, @brian-rose. It was badly needed

Following the instructions I was able to create a test cookbook. However, I did receive an error in one of the GitHub Actions as noted in my in-line comments.

Also, a gh-pages website was never published, either in my personal repo or in the ProjectPythia repo for the cookbook. Not sure how to fix that.

@brian-rose
Copy link
Member Author

Also, a gh-pages website was never published, either in my personal repo or in the ProjectPythia repo for the cookbook. Not sure how to fix that.

It's here: https://projectpythia.org/hello-pythia-cookbook/README.html

@brian-rose
Copy link
Member Author

Following the instructions I was able to create a test cookbook. However, I did receive an error in one of the GitHub Actions as noted in my in-line comments.

From what I can see here, all the actions are working as expected in the upstream fork.

@brian-rose
Copy link
Member Author

@clyne thanks for the detailed read-through! I think I have addressed all your comments, and I added a bit more detail on making Pull Requests.

In retrospect, I think it might be better to separate this guide into two pieces:

  • contributing to Cookbooks
  • making new Cookbooks

But that could be left as an open issue for the future if we're reasonably happy with what's here.

@brian-rose brian-rose requested a review from clyne June 6, 2024 21:59
@clyne
Copy link
Contributor

clyne commented Jun 6, 2024

Also, a gh-pages website was never published, either in my personal repo or in the ProjectPythia repo for the cookbook. Not sure how to fix that.

It's here: https://projectpythia.org/hello-pythia-cookbook/README.html

Sorry, should have been more clear. The gh-pages site is not linked from underneath the "About" heading on the repo website. Shouldn't this happen automatically?

Copy link
Contributor

@clyne clyne left a comment

Choose a reason for hiding this comment

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

Just a couple more minor in-line comments.

@brian-rose
Copy link
Member Author

Also, a gh-pages website was never published, either in my personal repo or in the ProjectPythia repo for the cookbook. Not sure how to fix that.

It's here: https://projectpythia.org/hello-pythia-cookbook/README.html

Sorry, should have been more clear. The gh-pages site is not linked from underneath the "About" heading on the repo website. Shouldn't this happen automatically?

No, it does not happen automatically. Maybe you missed my suggestion for this in this section under "Here's a handy trick..."

@clyne
Copy link
Contributor

clyne commented Jun 7, 2024

Also, a gh-pages website was never published, either in my personal repo or in the ProjectPythia repo for the cookbook. Not sure how to fix that.

It's here: https://projectpythia.org/hello-pythia-cookbook/README.html

Sorry, should have been more clear. The gh-pages site is not linked from underneath the "About" heading on the repo website. Shouldn't this happen automatically?

No, it does not happen automatically. Maybe you missed my suggestion for this in this section under "Here's a handy trick..."

No, I didn't miss it, but it explains the rabbit hole that I went down. The "About" settings are different for my personal repo, and do not include the option to "Use your GitHub Pages website". I probably got confused about which repo I was looking at. Here's a screenshot for what I see on my personal repo:

About

@clyne clyne self-requested a review June 7, 2024 00:29
clyne
clyne previously approved these changes Jun 7, 2024
@brian-rose
Copy link
Member Author

Also, a gh-pages website was never published, either in my personal repo or in the ProjectPythia repo for the cookbook. Not sure how to fix that.

It's here: https://projectpythia.org/hello-pythia-cookbook/README.html

Sorry, should have been more clear. The gh-pages site is not linked from underneath the "About" heading on the repo website. Shouldn't this happen automatically?

No, it does not happen automatically. Maybe you missed my suggestion for this in this section under "Here's a handy trick..."

No, I didn't miss it, but it explains the rabbit hole that I went down. The "About" settings are different for my personal repo, and do not include the option to "Use your GitHub Pages website". I probably got confused about which repo I was looking at. Here's a screenshot for what I see on my personal repo:

About

Oh, that makes sense! I will add a clarifying note. It's easy to get confused about which version of the repo one is looking at.

@clyne
Copy link
Contributor

clyne commented Jun 7, 2024

Also, a gh-pages website was never published, either in my personal repo or in the ProjectPythia repo for the cookbook. Not sure how to fix that.

It's here: https://projectpythia.org/hello-pythia-cookbook/README.html

Sorry, should have been more clear. The gh-pages site is not linked from underneath the "About" heading on the repo website. Shouldn't this happen automatically?

No, it does not happen automatically. Maybe you missed my suggestion for this in this section under "Here's a handy trick..."

No, I didn't miss it, but it explains the rabbit hole that I went down. The "About" settings are different for my personal repo, and do not include the option to "Use your GitHub Pages website". I probably got confused about which repo I was looking at. Here's a screenshot for what I see on my personal repo:
About

Oh, that makes sense! I will add a clarifying note. It's easy to get confused about which version of the repo one is looking at.

Cool. I'll be going offline soon and have approved the PR. Nice work!

@brian-rose brian-rose requested a review from clyne June 7, 2024 00:40
@brian-rose
Copy link
Member Author

Thanks so much @clyne for the careful review! Much appreciated.

@brian-rose brian-rose merged commit e1c7b54 into ProjectPythia:main Jun 7, 2024
3 checks passed
@brian-rose brian-rose deleted the update-guide branch June 7, 2024 00:57
github-actions bot pushed a commit that referenced this pull request Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cookbook guide is inconsistent with latest template
3 participants