Added recipe to have an interactive shell when using docker

[boss6825]

Fixes #1960
Supersedes and closes #1967

Issue number - 1960

---

📚 Documentation preview 📚: https://plone6--2004.org.readthedocs.build/

[boring-cyborg]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, read Plone's Code of Conduct and Contribute to documentation, as this will greatly help the review process.

Welcome to the Plone community! 🎉

[stevepiercy]

Above images are preview of documentation I added

📚 Documentation preview 📚: https://plone6--2004.org.readthedocs.build/

FYI, we have automatic pull request previews provided by Read the Docs, so in the future, after RTD completes its build, the link will work and you don't need to add a screenshot of your local build.

You can also add a link in your description to the affected pages with anchors to specific sections.

https://plone6--2004.org.readthedocs.build/install/containers/recipes/index.html#open-an-interactive-debugging-shell-when-docker-compose

[stevepiercy]

This is really good. Just a few minor grammar and style fixes, and a little MyST markup improvements. Then a final technical review, and it can be merged. Thank you!

[erral]

Thanks!

There is no need to have another service configured in the docker-compose.yml file.

It is enough to run the following command to get the interactive command:

docker compose run --rm backend console

And it will drop into a debug console where the app variable holds the application instance:

user@server.com:~/docker/deploy(main)$ docker compose run --rm backend console
[+] Creating 1/0
 ✔ Container zeo  Running                                                                                                                                               0.0s 
/app/lib/python3.12/site-packages/plone/app/theming/__init__.py:3: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
  __import__("pkg_resources").declare_namespace(__name__)
Starting debugger (the name "app" is bound to the top-level Zope object)
>>> app
<Application at >
>>> app.Plone
<PloneSite at /Plone>

[stevepiercy]

@boss6825 would you please take a look at @erral's suggestion, try it out to verify it works for you, and revise the PR accordingly? He knows a lot more about this topic than I do.

Also, future tip, you can use the "Add suggestion to batch" button when updating your PR on GitHub to reduce the number of notifications. See https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes.

If you don't see that button, you might need to switch to the "old" GitHub version. See https://github.com/orgs/community/discussions/175664.

[boss6825]

@stevepiercy i am modifying current version based on @erral 's feedback,
also for future PR's , I will use "Add to batch ".
Sorry for those annoying multiple notifications you got 🥲.

[stevepiercy]

This passes my editorial review, but it needs a technical review. @erral @davisagli this should be quick. Thank you!

[boring-cyborg]

Congratulations on your first merged pull request in this project! 🎉


Thank you for contributing, we are very proud of you! ❤️