Merge branch '6.0' into dev-guide-create-a-backend-add-on

plone · Nov 8, 2024 · ed9c4af · ed9c4af
2 parents d8e135c + 4812700
commit ed9c4af
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 17 deletions.
diff --git a/docs/admin-guide/index.md b/docs/admin-guide/index.md
@@ -11,7 +11,7 @@ myst:
 
 # Admin guide
 
-In this part of the documentation, you can find how to install, operate, configure, and deploy Plone.
+In this part of the documentation, you can find how to install, operate, and configure Plone.
 
 
 ```{toctree}

diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md
@@ -25,7 +25,7 @@ For other installation options, see {ref}`get-started-install-label`.
 ## Prerequisites for installation
 
 -   For Plone 6.0, Python {SUPPORTED_PYTHON_VERSIONS_PLONE60}
-% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest". 
+% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest".
 % -   For Plone 6.1, Python {SUPPORTED_PYTHON_VERSIONS_PLONE61}
 
 
@@ -47,15 +47,17 @@ cd <my_projects>/plone
 Create a Python virtual environment.
 
 ```shell
-python3 -m venv .
+python3 -m venv venv
 ```
 
 Install the minimal Python packages needed in order to run Buildout.
 
 ```shell
-bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt
+venv/bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt
 ```
 
+
+
 Create a {file}`buildout.cfg` file in your directory with the following contents.
 
 ```cfg
@@ -75,6 +77,12 @@ eggs =
     Plone
 ```
 
+Use Buildout's [`bootstrap` command](https://www.buildout.org/en/latest/topics/bootstrapping.html) to install a local `buildout` script in the {file}`bin` directory.
+
+```shell
+venv/bin/buildout bootstrap
+```
+
 Run Buildout.
 
 ```shell
@@ -83,6 +91,7 @@ bin/buildout
 
 This may take a few minutes.
 
+Whenever you change the Buildout configuration, run `./bin/buildout` again.
 
 ## Start Plone in foreground mode
 

diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md
@@ -25,7 +25,7 @@ For other installation options, see {ref}`get-started-install-label`.
 ## Prerequisites for installation
 
 -   For Plone 6.0, Python {SUPPORTED_PYTHON_VERSIONS_PLONE60}
-% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest". 
+% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest".
 % -   For Plone 6.1, Python {SUPPORTED_PYTHON_VERSIONS_PLONE61}
 
 
@@ -47,13 +47,13 @@ cd <my_projects>/plone
 Create a Python virtual environment.
 
 ```shell
-python3 -m venv .
+python3 -m venv venv
 ```
 
 Install Plone and a helper package, {term}`pipx`.
 
 ```shell
-bin/pip install -c https://dist.plone.org/release/6.0-latest/constraints.txt Plone pipx
+venv/bin/pip install -c https://dist.plone.org/release/6.0-latest/constraints.txt Plone pipx
 ```
 
 

diff --git a/docs/admin-guide/run-plone.md b/docs/admin-guide/run-plone.md
@@ -19,6 +19,7 @@ There are different commands to run Plone, depending on which method you used to
 
 Running Plone in foreground mode will show output in the terminal.
 This is recommended while developing a Plone site.
+The command you use depends on the installation method you used.
 
 Cookieplone:
 :   ```shell

diff --git a/docs/backend/search.md b/docs/backend/search.md
@@ -1,16 +1,30 @@
 ---
 myst:
   html_meta:
-    "description": ""
-    "property=og:description": ""
-    "property=og:title": ""
-    "keywords": ""
+    "description": "How to index and search content in Plone"
+    "property=og:description": "How to index and search content in Plone"
+    "property=og:title": "Search"
+    "keywords": "Plone, search, index, querystring, catalog"
 ---
 
 (backend-search-label)=
 
 # Search
 
+To index and search content in Plone, see the Plone 5 documentation {doc}`plone5:develop/plone/searching_and_indexing/index`.
+
+Alternatively, you can integrate any open source search engine with your Plone site.
+
+-   [Solr](https://solr.apache.org/) - See the add-on [`collective.solr`](https://github.com/collective/collective.solr) and its [documentation](https://collectivesolr.readthedocs.io/en/latest/).
+-   [`collective.elasticsearch`](https://github.com/collective/collective.elasticsearch)
+-   [`collective.elastic.plone`](https://github.com/collective/collective.elastic.plone)
+
+You can find a comprehensive list of search options in [Awesome Plone - Searching and Categorizing](https://github.com/collective/awesome-plone?tab=readme-ov-file#searching-and-categorizing)
+
+
+```{todo}
+Help us [Migrate content from v5 "Queries, Search And Indexing" #1730](https://github.com/plone/documentation/issues/1730).
+```
 
 (backend-search-catalog-label)=
 

diff --git a/docs/install/containers/index.md b/docs/install/containers/index.md
@@ -45,9 +45,9 @@ Although there are many container engine tools for developing, managing, and run
 
 The system requirements include those required by Docker itself.
 
--   [Linux](https://docs.docker.com/desktop/install/linux/)
--   [macOS](https://docs.docker.com/desktop/install/mac-install/)
--   [Windows](https://docs.docker.com/desktop/install/windows-install/)
+-   [Linux](https://docs.docker.com/desktop/setup/install/linux/)
+-   [macOS](https://docs.docker.com/desktop/setup/install/mac-install/)
+-   [Windows](https://docs.docker.com/desktop/setup/install/windows-install/)
 
 Plone 6 itself requires memory and disk space in addition to those of Docker alone.
 See its {ref}`install-packages-hardware-requirements-label`.
@@ -66,13 +66,13 @@ Docker Desktop includes all Docker tools.
 First start the Plone Backend, naming it `plone6-backend` and creating a site with its default configuration, using the following command.
 
 ```shell
-docker run --name plone6-backend -e SITE=Plone -e CORS_ALLOW_ORIGIN='*' -d -p 8080:8080 plone/plone-backend:{PLONE_BACKEND_MINOR_VERSION}
+docker run --name plone6-backend -e SITE=Plone -d -p 8080:8080 plone/plone-backend:{PLONE_BACKEND_MINOR_VERSION}
 ```
 
 Now start the Plone Frontend, linking it to the `plone6-backend`:
 
 ```shell
-docker run --name plone6-frontend --link plone6-backend:backend -e RAZZLE_API_PATH=http://localhost:8080/Plone -e RAZZLE_INTERNAL_API_PATH=http://backend:8080/Plone -d -p 3000:3000 plone/plone-frontend:latest
+docker run --name plone6-frontend --link plone6-backend:backend -e RAZZLE_DEV_PROXY_API_PATH=http://backend:8080/Plone -d -p 3000:3000 plone/plone-frontend:latest
 ```
 
 

diff --git a/docs/install/create-project-cookieplone.md b/docs/install/create-project-cookieplone.md
@@ -33,11 +33,16 @@ For other installation options, see {ref}`get-started-install-label`.
 Plone 6 has both hardware requirements and software prerequisites.
 
 
+(create-project-cookieplone-hardware-requirements-label)=
+
 ### Hardware requirements
 
 ```{include} /_inc/_hardware-requirements.md
 ```
 
+
+(create-project-cookieplone-prerequisites-for-installation-label)=
+
 ### Prerequisites for installation
 
 ```{include} ../volto/contributing/install-operating-system.md
@@ -96,6 +101,8 @@ pip install pipx
 ```
 
 
+(create-project-cookieplone-generate-the-project-label)=
+
 ## Generate the project
 
 After satisfying the prerequisites and having activated an LTS version of Node,

diff --git a/submodules/volto b/submodules/volto