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

Simplify the introductory container installation docs #1729

Merged
merged 5 commits into from
Nov 7, 2024

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Oct 2, 2024

Reopened against 6.0 branch.

See #1456 for discussion and background.


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

davisagli and others added 2 commits February 25, 2023 09:35
It's a best practice to run Volto in seamless mode, where the API is served at the same domain with the /++api++ prefix. This avoids complications with browser cross-origin restrictions when the browser accesses the backend directly at a different domain.

So, we should show this best practice here. The current example sets RAZZLE_API_PATH, because the default is http://localhost:8080/Plone which does not work inside a container. But, setting RAZZLE_API_PATH also stops using the best practice of seamless mode. We can avoid this by setting RAZZLE_DEV_PROXY_API_PATH instead.

(Future improvement: make Volto recognize when it is running in a container, so that it can use http://host.docker.internal:8080/Plone as the default API path instead of localhost. Then it would not be necessary to set RAZZLE_DEV_PROXY_API_PATH here.)
@stevepiercy
Copy link
Contributor Author

@davisagli what should we do with this old PR? Merge as is, amend, close?

@davisagli
Copy link
Member

@stevepiercy This page and the "Examples of Plone 6 using containers" page should be replaced by a freshly written how-to guide (or several) about installing Plone using Docker / docker-compose / Docker Swarm. I can help with that, but I won't have time until after the conference.

The pages under "Official Images" are sort of a mix of how-to and reference and I don't have a clear idea what to do with them yet.

@stevepiercy
Copy link
Contributor Author

@davisagli, here's what I have in mind. I think we're in agreement.

  • Containers - Mix of Conceptual guide (introduction) and How-to (the rest of the page).
  • Official Images - Each page is a mix of Reference (environment variables) and How-to, and should be split apart. I'd break each page into two.
  • Examples of Plone 6 using containers - How-to. Add orchestration examples using Docker / docker-compose / Docker Swarm (and maybe other tools?).

But all that is not relevant to the content in this PR, AFAICT. Is this content worth saving or deploying now? If not, let's close it and create a new issue that captures the plan instead.

@davisagli
Copy link
Member

@stevepiercy We should merge this as is, now -- the commands that are updated were just plain wrong before these changes. Then I agree, we can work on the larger reorganization separately.

Copy link
Contributor Author

@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.

LGTM

@stevepiercy stevepiercy merged commit 4daa66c into 6.0 Nov 7, 2024
3 checks passed
@stevepiercy stevepiercy deleted the davisagli-container-install branch November 7, 2024 02:25
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