Skip to content

Added recipe to have an interactive shell when using docker #1967

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

Open
wants to merge 3 commits into
base: 6.0
Choose a base branch
from

Conversation

Thanush-03
Copy link

@Thanush-03 Thanush-03 commented Aug 16, 2025

Issue number
Fixes #1960
Description:
Added documentation for interactive shell debugging when using Docker containers. This provides the Docker equivalent of the bin/instance debug command used in traditional Plone installations.
The new "Interactive shell for debugging" section in the Docker recipes documentation includes:
Multiple approaches for getting an interactive shell:
Using docker exec for running containers
Using docker run for new container instances
Using docker compose exec for Docker Compose setups
Practical examples showing how to access the Plone site and set up fake requests
Safety warnings about using this in production environments.

LINK:
https://6.docs.plone.org/install/containers/recipes/index.html

MESSAGE:
The issue being fixed #1960
Interactive shell debugging documentation was added in Docker recipes page.


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

Copy link

boring-cyborg bot commented Aug 16, 2025

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! 🎉

- Remove duplicate documentation directory that was causing submodule errors
- Add submodules: true to CI workflows to properly handle submodules
- Add comprehensive interactive shell debugging documentation for Docker containers

Fixes plone#1960
@stevepiercy
Copy link
Contributor

@Thanush-03 please see Granting permission to publish. We can't accept your contribution without your explicit written permission. Thank you!

@Thanush-03
Copy link
Author

Thanush-03 commented Aug 16, 2025 via email

@stevepiercy
Copy link
Contributor

@Thanush-03 is "Thanush K" your actual full name? I've never seen a surname consisting of a single letter, except for Malcom X.

Also did you test your instructions to make sure that they actually work? If you haven't actually tested the instructions, then please close this PR. Thank you!

@Thanush-03
Copy link
Author

Thanush-03 commented Aug 16, 2025 via email

- Remove references to deprecated plone.volto:default-homepage profile
- Update documentation to recommend content export/import approach
- Add explanatory notes about the profile removal in version 5
- Update Docker example to remove deprecated profile usage

Fixes plone#118
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: New
Development

Successfully merging this pull request may close these issues.

Add recipe to have an interactive shell when using docker
2 participants