From 71cbb56f7f9d908f92031893aab753d18ffc64fa Mon Sep 17 00:00:00 2001 From: RishitModi Date: Thu, 18 Dec 2025 18:31:07 +0530 Subject: [PATCH] Add related content to admin and install documentation --- docs/admin-guide/configure-zope.md | 20 ++++++++------ docs/admin-guide/run-plone.md | 44 ++++++++++++++++-------------- docs/install/index.md | 26 ++++++++++-------- 3 files changed, 51 insertions(+), 39 deletions(-) diff --git a/docs/admin-guide/configure-zope.md b/docs/admin-guide/configure-zope.md index e933e7d11..f058a0e27 100644 --- a/docs/admin-guide/configure-zope.md +++ b/docs/admin-guide/configure-zope.md @@ -15,21 +15,25 @@ Plone runs in an application server called {term}`Zope`. You can configure your Zope instance's options, including the following. -- persistent storage: blobs, direct file storage, relational database, ZEO, and other storage mechanisms -- ports -- threads -- cache -- logging -- debugging and profiling for development - +- persistent storage: blobs, direct file storage, relational database, ZEO, and other storage mechanisms +- ports +- threads +- cache +- logging +- debugging and profiling for development ## Cookieplone If you installed Plone using Cookieplone or pip, then Zope is configured using {term}`cookiecutter-zope-instance`. For a complete list of features, usage, and options, read [`cookiecutter-zope-instance`'s README](https://github.com/plone/cookiecutter-zope-instance#readme). - ## Buildout If you installed Plone using Buildout, then Zope is configured using `plone.recipe.zope2instance`. For a complete list of features, usage, and options, read [`plone.recipe.zope2instance`'s README](https://pypi.org/project/plone.recipe.zope2instance/). + +## Related content + +- {doc}`/admin-guide/run-plone` - Learn how to run and manage a Plone instance. +- {doc}`/admin-guide/zope-manager-users` - Understand how to manage users with the Zope Management Interface. +- {doc}`/deployment/index` - Explore deployment considerations for Plone and Zope. diff --git a/docs/admin-guide/run-plone.md b/docs/admin-guide/run-plone.md index 0a1bec7e0..73d405dd4 100644 --- a/docs/admin-guide/run-plone.md +++ b/docs/admin-guide/run-plone.md @@ -22,48 +22,46 @@ This is recommended while developing a Plone site. The command you use depends on the installation method you used. Cookieplone: -: ```shell +: `shell make backend-start - ``` + ` Buildout: -: ```shell +: `shell bin/instance fg - ``` + ` pip: -: ```shell +: `shell bin/runwsgi instance/etc/zope.ini - ``` + ` For any of these commands, press {kbd}`ctrl-c` to stop the process. - ## Run Volto If you use the Volto frontend, you need to run the frontend in a separate process and terminal session. Cookieplone: -: ```shell +: `shell make frontend-start - ``` + ` For any of these commands, press {kbd}`ctrl-c` to stop the process. - ## Start Plone as a background service Buildout: -: ```shell +: `shell bin/instance start - ``` + ` ## Stop Plone as a background service Buildout: -: ```shell +: `shell bin/instance stop - ``` + ` ## Run a debug console @@ -71,19 +69,19 @@ The debug console gives you a Python prompt with the Plone site's configuration Use this for troubleshooting. Cookieplone: -: ```shell +: `shell make -C backend console - ``` + ` Buildout: -: ```shell +: `shell bin/instance debug - ``` + ` pip: -: ```shell +: `shell bin/zconsole debug instance/etc/zope.conf - ``` + ` For any of these commands, press {kbd}`ctrl-d` to stop the process. @@ -98,3 +96,9 @@ from zope.globalrequest import setRequest app = makerequest(app) setRequest(app.REQUEST) ``` + +## Related content + +- {doc}`/admin-guide/configure-zope` - Learn how to configure Zope settings for a Plone site. +- {doc}`/admin-guide/backup-restore-plone-buildout` - Understand how to back up and restore a Plone installation. +- {doc}`/deployment/index` - Explore deployment strategies for running Plone in production. diff --git a/docs/install/index.md b/docs/install/index.md index 3a8380d93..fb3faa832 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -17,7 +17,6 @@ This part of the documentation helps you find the best way to get started with P :local: true ``` - (get-started-try-plone-label)= ## Try a Plone demo @@ -25,14 +24,13 @@ This part of the documentation helps you find the best way to get started with P Choose a version to demo. https://volto.demo.plone.org/ -: Plone 6 with Volto frontend +: Plone 6 with Volto frontend https://demo.plone.org/ -: Plone 6 with Volto frontend and some add-ons, including Volto Light Theme, with content that demonstrates all the content types of Plone and blocks in Volto +: Plone 6 with Volto frontend and some add-ons, including Volto Light Theme, with content that demonstrates all the content types of Plone and blocks in Volto [https://classic.demo.plone.org/](https://classic.demo.plone.org/login?came_from=/en) -: Plone 6 with Classic UI frontend - +: Plone 6 with Classic UI frontend (get-started-install-label)= @@ -48,18 +46,24 @@ If you are following a [Plone training](https://training.plone.org/), it should ``` {doc}`create-project-cookieplone` -: This is the recommended way to install Plone with either Volto or Classic UI for a frontend. +: This is the recommended way to install Plone with either Volto or Classic UI for a frontend. {doc}`/admin-guide/install-buildout` -: This is another way to install Plone with the Classic UI frontend, but not Volto. - Using Buildout will be the most familiar way for admins who have experience with Plone 3, 4, or 5. +: This is another way to install Plone with the Classic UI frontend, but not Volto. +Using Buildout will be the most familiar way for admins who have experience with Plone 3, 4, or 5. {doc}`/admin-guide/install-pip` -: This is another way to install Plone with the Classic UI frontend, but not Volto. - It provides a basic installation without many additional tools to help with development. +: This is another way to install Plone with the Classic UI frontend, but not Volto. +It provides a basic installation without many additional tools to help with development. {doc}`Install Plone as a contributor ` -: This option is for developers who want to contribute to Plone and its packages. +: This option is for developers who want to contribute to Plone and its packages. + +## Related content + +- {doc}`/deployment/index` - Learn how to deploy Plone in production environments. +- {doc}`/developer-guide/index` - Understand how to develop and extend Plone projects. +- {doc}`/admin-guide/run-plone` - Learn how to run and manage a Plone instance. ```{seealso} If you don't want to use Cookieplone as the recommended way to install Plone with Classic UI for a frontend, read {doc}`/conceptual-guides/compare-buildout-pip` to help inform your choice between Buildout and pip for an installation method.