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.

Sign up for GitHub

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

Jump to bottom

Changed plone instances to zope instances #1836

Open
wants to merge 1 commit into
base: 6.0
Choose a base branch
from
Open

Changed plone instances to zope instances #1836

wants to merge 1 commit into from

Conversation

alizgirl
Copy link

@alizgirl alizgirl commented Jan 17, 2025 •
edited by github-actions bot
Loading

First-time contributors

You must read and follow our First-time contributors.

Submit a pull request

Thank you for your contribution to the Plone Documentation.

Before submitting this pull request, please make sure you follow our guides:

Issue number

Description

Replaced "Plone instance" in the documentation repo with "Zope instance".

Add screenshots or links to a preview of the changes

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

@boring-cyborg boring-cyborg
Copy link

boring-cyborg bot commented Jan 17, 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! 🎉

stevepiercy
stevepiercy approved these changes Jan 18, 2025
View reviewed changes
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.

LGTM. Let's get a quick review from @davisagli, since he brought up the original issue.

docs/backend/upgrading/troubleshooting.md
@@ -86,7 +86,7 @@ If the problem disappears, you will need to double-check the offending product.

(upgrading-troubleshooting-test-with-a-fresh-plone-instance-label)=
Copy link
Contributor

@stevepiercy stevepiercy Jan 18, 2025 •
edited by davisagli
Loading

Choose a reason for hiding this comment

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

Suggested change
(upgrading-troubleshooting-test-with-a-fresh-plone-instance-label)=
(upgrading-troubleshooting-test-with-a-fresh-plone-site-label)=

@stevepiercy stevepiercy requested a review from davisagli January 18, 2025 08:48
@stevepiercy
Copy link
Contributor

stevepiercy commented Jan 18, 2025 •
edited
Loading

@alizgirl would you please change your pull request description from Fixes #1751 to Ref: #1751? There are instances of both "Plone instance" and "Zope / Plone instance" in the plone.api and plone.restapi documentation that need to be replaced in those repositories as well. That way it still links, but it won't close the issue until it is complete.

plone.api and plone.restapi get pulled into documentation as git submodules. See Editing external package documentation for more information. If you would like to submit a PR for those parts as well, I would greatly appreciate it.

Thank you!

@stevepiercy
Copy link
Contributor

Also you will need to update your branch to 6.0. You can do that by either clicking the Update branch button if available, or see Update your pull request from your fork.

davisagli
davisagli requested changes Jan 22, 2025
View reviewed changes
Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

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

Some of these should be replaced with "Plone site" instead of "Zope instance". I added suggestions.

docs/backend/upgrading/troubleshooting.md
@@ -86,7 +86,7 @@ If the problem disappears, you will need to double-check the offending product.

(upgrading-troubleshooting-test-with-a-fresh-plone-instance-label)=

## Test with a fresh Plone instance
## Test with a fresh Zope instance
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Test with a fresh Zope instance
## Test with a fresh Plone site

The context below makes it clear that this is about a new Plone site, not a new Zope instance.

docs/backend/upgrading/intro.md
@@ -20,7 +20,7 @@ Upgrading Plone includes the Plone application and its add-ons, as well as migra

A *migration* is the process of taking a component in your Plone site, and moving it from its current version to a newer one.
Migration is necessary because the internals of Plone sometimes change to support new functionality.
When that's the case, the content that is stored in your Plone instance may not align with the requirements of the new version.
When that's the case, the content that is stored in your Zope instance may not align with the requirements of the new version.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
When that's the case, the content that is stored in your Zope instance may not align with the requirements of the new version.
When that's the case, the content that is stored in your Plone site may not align with the requirements of the new version.

docs/backend/upgrading/version-specific-migration/migrate-to-volto.md
@@ -36,7 +36,7 @@ As a pre-requisite, your Plone site must be {doc}`upgraded to Plone 6 <upgrade-t
Plone provides a form `/@@migrate_to_volto` that allows you to run all the required changes to your existing site to make it compatible with Volto.

You can access this form in the browser when you are logged in as an Administrator.
Open `http://localhost:8080/Plone/@@migrate_to_volto`, where `localhost` is your hostname, `8080` is the port on which Plone runs, and `Plone` is the name of the Plone instance.
Open `http://localhost:8080/Plone/@@migrate_to_volto`, where `localhost` is your hostname, `8080` is the port on which Plone runs, and `Plone` is the name of the Zope instance.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Open `http://localhost:8080/Plone/@@migrate_to_volto`, where `localhost` is your hostname, `8080` is the port on which Plone runs, and `Plone` is the name of the Zope instance.
Open `http://localhost:8080/Plone/@@migrate_to_volto`, where `localhost` is your hostname, `8080` is the port on which Plone runs, and `Plone` is the name of the Plone site.

docs/classic-ui/layers.md
@@ -20,7 +20,7 @@ Layers are useful in the following scenarios.
Layers are marker interfaces applied to the {term}`HTTPRequest` object.
They are usually used in conjunction with Zope Configuration Mark-up Language ({term}`ZCML`) directives to dynamically activate various parts of the configuration, such as theme files or add-on product functionality.

Layers ensure that only one add-on product can override the specific Plone instance functionality in your site at a time, while still allowing you to have possibly conflicting add-on products in your buildout and ZCML.
Layers ensure that only one add-on product can override the specific Zope instance functionality in your site at a time, while still allowing you to have possibly conflicting add-on products in your buildout and ZCML.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Layers ensure that only one add-on product can override the specific Zope instance functionality in your site at a time, while still allowing you to have possibly conflicting add-on products in your buildout and ZCML.
Layers ensure that only one add-on product can override the specific Zope view in your site at a time, while still allowing you to have possibly conflicting add-on products in your buildout and ZCML.

docs/classic-ui/layers.md
@@ -20,7 +20,7 @@ Layers are useful in the following scenarios.
Layers are marker interfaces applied to the {term}`HTTPRequest` object.
They are usually used in conjunction with Zope Configuration Mark-up Language ({term}`ZCML`) directives to dynamically activate various parts of the configuration, such as theme files or add-on product functionality.

Layers ensure that only one add-on product can override the specific Plone instance functionality in your site at a time, while still allowing you to have possibly conflicting add-on products in your buildout and ZCML.
Layers ensure that only one add-on product can override the specific Zope instance functionality in your site at a time, while still allowing you to have possibly conflicting add-on products in your buildout and ZCML.
Multiple Plone site instances can share the same ZCML and code files.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Multiple Plone site instances can share the same ZCML and code files.
Multiple Plone sites can share the same ZCML and code files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davisagli davisagli davisagli requested changes

@stevepiercy stevepiercy stevepiercy approved these changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Replace "Plone instance" and "Zope / Plone instance" with "Zope instance"
3 participants
@alizgirl @stevepiercy @davisagli