Skip to content
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

MAINT: Simplify pages and migrate to gh-pages based deployments #6

Merged
merged 18 commits into from
Feb 12, 2024
Merged

Conversation

mmcky
Copy link
Contributor

@mmcky mmcky commented Feb 7, 2024

This PR:

  • simplifies the companion site to basic information and code access
  • does not migrate the code-book
  • reconfigure gh-pages from jekyll to gh actions based deployments to gh-pages

The following were included in the commit history but are now removed.

  • integrates book-dp1-public-companion into this repo (which was responsible for building the code-book
  • setup netlify
  • test new repo structure with netlify
  • set a link back from code-book to the root level
  • check with @DrDrij that there are no jekyll powered components and website is fully static html
  • review and test the new structure with code-book as a built asset of the website/code-book
  • sync then archive book-dp1-public-companion

@mmcky mmcky added the in-work label Feb 7, 2024
Copy link

netlify bot commented Feb 8, 2024

Deploy Preview for resonant-pie-f0089d ready!

Name Link
🔨 Latest commit 593b0ce
🔍 Latest deploy log https://app.netlify.com/sites/resonant-pie-f0089d/deploys/65c98bb8e0545d00087ba12d
😎 Deploy Preview https://deploy-preview-6--resonant-pie-f0089d.netlify.app/website/code
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot temporarily deployed to commit February 8, 2024 03:57 Inactive
@github-actions github-actions bot temporarily deployed to commit February 8, 2024 05:51 Inactive
@DrDrij
Copy link
Member

DrDrij commented Feb 8, 2024

@mmcky The codebase now looks like a static site - no Jekyll or Liquid components.

Have you got a link I can do a super quick review with? Check the site ticks all the boxes and gets the proper google ranking/social score?

@github-actions github-actions bot temporarily deployed to commit February 8, 2024 23:27 Inactive
@mmcky
Copy link
Contributor Author

mmcky commented Feb 9, 2024

@HumphreyYang if you had time -- would you be able to click on the netlify deployment of this PR and click around to see if you can find any issues. It is looking pretty good to me.

The only thing that won't work is the "Download -> BOOK" link as that file is not yet on the main branch.

Screenshot 2024-02-09 at 11 50 42 am

@mmcky
Copy link
Contributor Author

mmcky commented Feb 9, 2024

Not sure why -- but the runtimes are significantly less in this repo.

Screenshot 2024-02-09 at 11 53 58 am

@mmcky
Copy link
Contributor Author

mmcky commented Feb 9, 2024

@jstac after a few more quality checks I think Step #1 is good to go for the dp book. This PR will bring everything into a single repo re: dp.quantecon.org.

I would like to merge this on Monday

@mmcky mmcky added review and removed in-work labels Feb 9, 2024
@HumphreyYang
Copy link

Many thanks @mmcky,

The page looks great to me.

You might have noticed this, but the view source button is not working currently:

Screenshot from 2024-02-10 14-15-18

On the live site (i.e. https://quantecon.github.io/book-dp1-public-companion/intro.html), the button is linked to a branch in the fork by orectique, but not the main repo:
https://github.com/orectique/book-dp1/tree/master/code-book/intro.md

I found two minor issues related to the codebook, and I have created an issue on them in the companion repo.

@github-actions github-actions bot temporarily deployed to commit February 12, 2024 02:10 Inactive
@github-actions github-actions bot temporarily deployed to commit February 12, 2024 02:13 Inactive
@github-actions github-actions bot temporarily deployed to commit February 12, 2024 02:13 Inactive
@github-actions github-actions bot temporarily deployed to commit February 12, 2024 02:21 Inactive
@github-actions github-actions bot temporarily deployed to commit February 12, 2024 02:26 Inactive
@github-actions github-actions bot temporarily deployed to commit February 12, 2024 02:44 Inactive
@mmcky mmcky changed the title MAINT: integrate book-dp1-public-companion into repo MAINT: Simplify pages and migrate to gh-pages based deployments Feb 12, 2024
@mmcky
Copy link
Contributor Author

mmcky commented Feb 12, 2024

thanks @HumphreyYang and @DrDrij for your reviews.

@mmcky
Copy link
Contributor Author

mmcky commented Feb 12, 2024

@jstac I have updated the site based on our discussion today so we can skip the code-book migration all together.

https://65c985ef37cc5587fd320af8--resonant-pie-f0089d.netlify.app/

This is the demo site of what I have put together. I will liaise with @DrDrij about a better icon for the code icon (that replaces the code-book). Also the links on the Code page won't work yet until this PR is merged as they will link directly to the GitHub directories where the code files will be.

@mmcky
Copy link
Contributor Author

mmcky commented Feb 12, 2024

@DrDrij we are moving away from a jupyter-book powered code-book and towards just linking readers to a directory of files to simplify these companion pages and reduce maintenance.

Can you recommend a more suitable icon to describes "code"?

Screenshot 2024-02-12 at 2 03 22 pm

@jstac
Copy link
Contributor

jstac commented Feb 12, 2024

Thanks @mmcky . It will be great to see this done.

I'm getting a 404 on the GH links. Also, this page says "Slides" https://65c985ef37cc5587fd320af8--resonant-pie-f0089d.netlify.app/code

@mmcky
Copy link
Contributor Author

mmcky commented Feb 12, 2024

Thanks @mmcky . It will be great to see this done.

I'm getting a 404 on the GH links. Also, this page says "Slides" https://65c985ef37cc5587fd320af8--resonant-pie-f0089d.netlify.app/code

Thanks @jstac you will get 404 on all GitHub based links until this is merged as the files are currently in the branch. 👍

Thanks for the "slides" catch -- I'll update that now.

@github-actions github-actions bot temporarily deployed to commit February 12, 2024 03:08 Inactive
@mmcky
Copy link
Contributor Author

mmcky commented Feb 12, 2024

@jstac I will merge this now --- and do a quality check of the preview with all links that will resolve.

Then we can trigger a live update once we are happy.

@mmcky mmcky merged commit 4f4562c into main Feb 12, 2024
6 checks passed
@mmcky mmcky deleted the reorg branch February 12, 2024 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants