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

Overhaul training "Mastering Plone 6 development" #852

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Overhaul training "Mastering Plone 6 development" #852

wants to merge 22 commits into from

Conversation

ksuess
Copy link
Member

@ksuess ksuess commented Oct 7, 2024

  • new chapter 'search results block variation'
  • new chapter 'Search for additional fields'
  • enhanced chapter testing (frontend acceptance tests with backend package installed)
  • add-ons with cookieplone
  • enhanced chapter intros and code hints
  • and many more

Copy link

netlify bot commented Oct 7, 2024

Deploy Preview for plone-training ready!

Name Link
🔨 Latest commit 30e8086
🔍 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 ksuess marked this pull request as ready for review October 8, 2024 08:34
@ksuess
Copy link
Member Author

ksuess commented Oct 8, 2024

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
Copy link
Contributor

@ksuess computer in shop. No idea.

@stevepiercy
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Member Author

ksuess commented Oct 9, 2024

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
Copy link
Contributor

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
Copy link
Contributor

See #853 for RTD PR previews.

@ksuess ksuess marked this pull request as draft October 10, 2024 08:11
@ksuess ksuess marked this pull request as ready for review October 10, 2024 09:02
@stevepiercy
Copy link
Contributor

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

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

I only had time to review one page. It looks good. Mostly capitalization of proper nouns, but also update a few references. I'm sure it's OK to merge.

````

It's a good practice to write tests for the main requirements of a project. The **requirements are getting clearer and a path for the development is pointed**.

This chapter is meant as a starting point for testing in Volto.

<!--

% TODO Configure backend acceptance server with backend add-on 'training.votable' from repo.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there something in Plone 6 Docs that needs to be done? We're working on several things at the moment.

docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
docs/mastering-plone-5/instructions_plone5/index.md Outdated Show resolved Hide resolved
@ksuess
Copy link
Member Author

ksuess commented Oct 11, 2024

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

grafik

@stevepiercy
Copy link
Contributor

@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
Copy link
Member Author

ksuess commented Oct 11, 2024

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.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

@ksuess merge now, separate PRs for each page as time allows sounds good to me. Thank you!

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.

2 participants