plone / training

Plone Trainings
https://training.plone.org
Creative Commons Attribution 4.0 International
58 stars 89 forks source link

Overhaul training "Mastering Plone 6 development" #852

Closed ksuess closed 1 week ago

ksuess commented 1 month ago
netlify[bot] commented 1 month ago

Deploy Preview for plone-training ready!

Name Link
Latest commit 30e8086d96414f21fc46d80ec6f43d2e0a7845d7
Latest deploy log https://app.netlify.com/sites/plone-training/deploys/67078c588492b30008b10e24
Deploy Preview https://deploy-preview-852--plone-training.netlify.app
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.

ksuess commented 1 month ago

Hi @stevepiercy, do you have a hint for me why the search field on the top left does not show up? I am clueless, cause i just modified files in /docs, no configuration or sphinx templates at all.

stevepiercy commented 1 month ago

@ksuess computer in shop. No idea.

stevepiercy commented 1 month ago

Hi @stevepiercy, do you have a hint for me why the search field on the top left does not show up? I am clueless, cause i just modified files in /docs, no configuration or sphinx templates at all.

I see it. Try a wider screen? CMD-K should also activate the search field.

Screenshot 2024-10-08 at 3 06 48 PM

stevepiercy commented 1 month ago

I confirm that when I narrow the browser window, the search input box in the left nav gets replaced by a magnifying glass icon in the top nav.

ksuess commented 1 month ago

The netlify preview does not show the search field on top left. The field has been brought back in sphinx-book-theme v1.1.0: https://sphinx-book-theme.readthedocs.io/en/stable/changelog.html#v1-1-0-2023-12-19 but the netlify preview builds with v1.0.1: https://app.netlify.com/sites/plone-training/deploys/67063c2d8934d30b2bb0a4ba#L24

I'll leave it at that, cause you are preparing Plone Sphinx theme for documentation and training and the search feature is still available via the button on top right, OK?

stevepiercy commented 1 month ago

Netlify can't be used for pull request previews because they don't support modern Python versions (3.8 is the latest, if I recall correctly). We need to migrate Training to RTD PR previews, as I did for Documentation, plone.restapi, plone.api, and volto. Until then, use local preview builds. I haven't hit this repo yet, as there usually is no activity until the week before PloneConf.

stevepiercy commented 1 month ago

See https://github.com/plone/training/pull/853 for RTD PR previews.

stevepiercy commented 1 month ago

RTD PR previews will work for all new PRs. Example https://plone-training--858.org.readthedocs.build/en/858/contributing/setup-build.html#id1.

ksuess commented 1 month ago

preview on readthedocs.org works really well. Thanks for the quick implementation, @stevepiercy !

grafik

stevepiercy commented 1 month ago

@ksuess you're welcome! Also all new pull requests with changes to the docs will get a link inserted into the pull request description to preview the docs on RTD, and the email notification of a new PR will include that link.

How would you like to do reviews of this PR? It's huge. If there's time, I could do a more thorough review of this PR. But instead of going through GitHub, I would check out your branch, edit, commit, and push. It would be much faster and easier for me to do replacements, update the Vale "allow" and "reject" lists, and other things. Or you could just merge it to get it done, then ask folks to run through it and submit feedback. Please let me know. Thank you!

ksuess commented 1 month ago

How would you like to do reviews of this PR? It's huge. If there's time, I could do a more thorough review of this PR. But instead of going through GitHub, I would check out your branch, edit, commit, and push. It would be much faster and easier for me to do replacements, update the Vale "allow" and "reject" lists, and other things. Or you could just merge it to get it done, then ask folks to run through it and submit feedback. Please let me know. Thank you!

I think the complete text would benefit of a review, not just the changes here in this pull request. So I would prefer to merge it. And when you find time to review, maybe chapter by chapter, you open separate PR. For now I am happy having the content up to date with current practice. Up to date code snippets. The plot has become also more coherent. Associated packages are reviewed and correctly tagged per chapter.