Add new structure for overview, install and deployment

wolbernd · wolbernd · commit 4d4da61d49e3 · 2022-05-05T18:16:27.000+02:00
diff --git a/docs/deployment/backup.md b/docs/deployment/backup.md
@@ -0,0 +1,11 @@
+---
+html_meta:
+  "description": "Backup and restore of Plone 6"
+  "property=og:description": "Backup and restore of Plone 6"
+  "property=og:title": "Backup and restore of Plone 6"
+  "keywords": "Plone, Backup, Restore"
+---
+
+
+
+# Backup and Restore
diff --git a/docs/deployment/index.md b/docs/deployment/index.md
@@ -0,0 +1,22 @@
+---
+html_meta:
+  "description": "Deployment of Plone"
+  "property=og:description": "Deployment of Plone"
+  "property=og:title": "Deployment of Plone"
+  "keywords": "Plone, deployment, automation"
+---
+
+
+# Deployment of Plone 
+
+
+
+```{toctree}
+:maxdepth: 2
+:hidden: true
+
+provision
+scaling
+upgrade
+backup
+```
diff --git a/docs/deployment/provision.md b/docs/deployment/provision.md
@@ -0,0 +1,15 @@
+---
+html_meta:
+  "description": "Provisioning of Plone 6"
+  "property=og:description": "Provisioning of Plone 6"
+  "property=og:title": "Provisioning of Plone 6"
+  "keywords": "Plone, Provision"
+---
+
+
+
+# Provisioning
+
+## Ansible
+
+## Containers
diff --git a/docs/deployment/scaling.md b/docs/deployment/scaling.md
@@ -0,0 +1,17 @@
+---
+html_meta:
+  "description": "Scaling Plone 6"
+  "property=og:description": "Scaling Plone 6"
+  "property=og:title": "Scaling Plone 6"
+  "keywords": "Plone, scaling, high availability"
+---
+
+
+
+# Scaling
+
+## Traffic
+
+## High availability
+
+## Caching
diff --git a/docs/deployment/upgrade.md b/docs/deployment/upgrade.md
@@ -0,0 +1,16 @@
+---
+html_meta:
+  "description": "Plone 6 upgrade Guide"
+  "property=og:description": "Plone 6 upgrade guide"
+  "property=og:title": "Plone 6 upgrade guide"
+  "keywords": "Plone, upgrade"
+---
+
+
+
+# Plone 6 upgrade guide
+
+
+## from 5.x
+
+## from 6.x
diff --git a/docs/index.md b/docs/index.md
@@ -16,7 +16,9 @@ This website is the HTML documentation of Plone, an open source, enterprise-leve
 :maxdepth: 2
 :hidden: true
 
+overview/index
 install/index
+deployment/index
 volto/index
 plone.restapi/docs/source/index
 backend/index
diff --git a/docs/install/index.md b/docs/install/index.md
@@ -10,251 +10,22 @@ html_meta:
 
 # Install Plone 6
 
-This section focuses on installing Plone 6 for the developer, tester, or contributor.
+## Getting started
 
-For trying out Plone 6, visit our official demonstration site located at:
+* What do you want to do?
+  * Try a demo now
+  * Run Plone in containers (why use containers here..)
+  * Develop Plone add-ons or contribute to Plone packages → Install Plone from source
 
-```{toctree}
-:maxdepth: 2
-:hidden: true
-
-containers/index
-```
-
-https://6.demo.plone.org/
-
-```{todo}
-For deployment of Plone 6, visit TBD.
-```
-
-
-(install-index-system-requirements-pre-requisites-label)=
-
-## System requirements and pre-requisites
-
-To install Plone 6, you must satisfy system requirements and pre-requisites.
-
-```{todo}
-Add any missing requirements, including disk space.
-```
-
--   2GB if using a container image, 4GB RAM if installing manually.
--   Disk space (TBD).
--   Either a UNIX-like operating system—such as Linux, Ubuntu, macOS—or Windows.
-    For Windows, it is a good idea to use [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/).
-    We strongly recommend using a recent version of your operating system released within the last 3 years.
-    Older systems might not be supported.
--   Python 3.7, 3.8, or 3.9.
--   Node.js 14 or 16.
--   For Plone images, a container engine to develop, manage, and run OCI containers.
-
-
-(install-index-choose-installation-method-label)=
-
-## Choose an installation method
-
-Developers may either [use the official Plone 6 images](install-index-image-installation-method-label) or [manually install Plone 6](install-index-manual-installation-method-label).
-
-The Plone 6 images are compliant with the [Open Container Initiative (OCI)](https://opencontainers.org/).
-They should work with any OCI-compliant container engine for developing, managing, and running Plone 6 images.
-Two popular options include [podman](https://podman.io/) and [Docker](https://www.docker.com/products/docker-desktop/).
-The Plone 6 images have all the system requirements, pre-requisites, and Plone 6 itself already installed, except those requirements needed for running the container engine itself.
-This option is the quickest method to install and develop for Plone 6 and its packages.
-
-There may be some cases where using a Plone 6 image is not practical or desired.
-You might want to use an SQL database that is not PostgreSQL, or you might use a deployment workflow that has specific requirements.
-For these situations, Plone 6 may be installed manually.
-This method takes longer.
-It might be a challenge if you bump up against system requirements, or need to resolve conflicts between required packages.
-
-
-(install-index-image-installation-method-label)=
-
-## Image installation method
-
-The following Plone images are available.
-
--   [`plone/plone-backend`](https://github.com/plone/plone-backend)
--   [`plone/plone-frontend`](https://github.com/plone/plone-frontend) (Volto)
--   [`plone/plone-haproxy`](https://github.com/plone/plone-haproxy)
-
-See their README files for installation and configuration instructions.
-
-
-(install-index-manual-installation-method-label)=
-
-## Manual installation method
-
-As an overview, you will perform the following steps in order.
-
-1.  Install the Plone backend (which includes the Classic UI) with either [buildout](install-index-install-backend-label) or [pip](install-index-install-backend-pip-label).
-1.  Create the Plone Site in a web browser, choosing either the new Volto or the Classic UI for a frontend.
-1.  Install the Plone frontend (Volto) with node.
-
-
-(install-index-install-backend-label)=
-
-### Install the Plone backend
-
-You can install the Plone backend with either [buildout](install-index-install-backend-label) or [pip](install-index-install-backend-pip-label).
-
-
-(install-index-install-backend-buildout-label)=
-
-#### Install backend with buildout
-
-Create a new directory to hold your project, make it your current directory, and create a new file inside it called `buildout.cfg`.
-This file will refer to the latest version of Plone, and the `user` value that will be used in the next step to create a Plone site.
-Paste the following configuration information into it.
-
-```ini
-[buildout]
-extends = https://dist.plone.org/release/6.0.0a4/versions.cfg
-parts = instance
-
-[instance]
-recipe = plone.recipe.zope2instance
-eggs =
-    Plone
-user = admin:admin
-```
-
-Install Plone with the following shell commands.
-
-```shell
-# Create a Python virtual environment in the current directory
-python3.9 -m venv .
-# Install the latest Plone 6 requirements with pip
-bin/pip install -r https://dist.plone.org/release/6.0.0a4/requirements.txt
-# Run buildout to install Plone 6
-bin/buildout
-# Start the Plone instance
-bin/instance fg
-```
-
-
-(install-index-install-backend-pip-label)=
 
-#### Install backend with pip
+## Caveat that Plone is a large project and source installs are non-trivial
 
-Create a new directory to hold your project, make it your current directory, then issue the following commands in a shell session.
 
-```shell
-# Create a Python virtual environment in the current directory
-python3.9 -m venv .
-# Update Python package management tools
-bin/pip install -U pip setuptools wheel
-# Install Plone 6 with constrained requirements with pip
-bin/pip install Plone -c https://dist.plone.org/release/6.0.0a4/constraints.txt
-# Create a Plone 6 site with the given username and password in the current directory
-bin/mkwsgiinstance -u admin:admin -d .
-# Initialize Zope
-bin/runwsgi -v etc/zope.ini
-```
-
-```{warning}
-You might need to edit `etc/zope.conf` to add a `blobstorage` node with a `blob-dir` entry.
-See [issue 3345](https://github.com/plone/Products.CMFPlone/issues/3345#issuecomment-953700024).
-```
-
-
-(install-index-create-plone-site-label)=
-
-## Create a Plone site
-
-After you have installed the backend with buildout or pip, open a browser and visit http://localhost:8080/.
-
-Choose either Volto or Classic UI for the frontend.
-
--   For a new Volto frontend, click {guilabel}`Create a new Plone site` to prepare a Plone site and its backend.
-
-    ```{note}
-    If this button is not available, then you did not install `plone.volto` with buildout or pip.
-    ```
-
-    ```{attention}
-    For Volto, make sure the `Path` identifier is `Plone`.
-    You can change this, but then you need to change some Volto frontend configuration as well.
-    ```
-
--   For a Plone Classic UI frontend, click {guilabel}`Create Classic Plone site`.
-
-Submit the form and your backend is ready.
-
-If you created a Plone site with a Classic UI frontend, then you have completed installation.
-
-If a created a Plone site with a Volto frontend, continue with the next steps.
-
-
-(install-index-volto-frontend-node-label)=
-
-## Volto frontend with node
-
-We recommend that you read the chapter {ref}`frontend-getting-started-installing-volto-label` for details.
-
-
-(install-index-nvm-node-version-manager-label)=
-
-### `nvm`, the Node Version Manager
-
-We recommend that you install [`nvm`, or Node Version Manager](https://github.com/nvm-sh/nvm).
-This makes it possible to switch to any version of [`node` (Node.JS)](https://nodejs.org/en/) and [`npm` (Node Package Manager)](https://www.npmjs.com/) for any project on which you might work.
-
--   On Linux: `apt-get install nvm`
--   On Mac: `brew install nvm`
--   Or use the installation procedure detailed in the [nvm documentation](https://github.com/nvm-sh/nvm)
-
-With `nvm` installed, you can use it to install and use a supported version of `node` and `npm` using the following shell commands.
 
-```shell
-nvm install 16
-nvm use 16
-```
-
-
-(install-index-install-yarn-label)=
-
-## Install Yarn
-
-Volto requires [Yarn Classic](https://classic.yarnpkg.com/lang/en/), a dependency manager for JavaScript code.
-Install Yarn with the following command.
-
-```shell
-npm install --global yarn
-```
-
-
-(install-index-create-volto-project-label)=
-
-### Create a Volto project
-
-Create a Volto project using the following shell command.
-
-```shell
-npm init yo @plone/volto
-```
-
-This will take some time ☕️.
-Toward the end of the process, it will ask you for a project name.
-Enter the name of your project, using only lowercase letters.
-It will create a directory with this name.
-Go to that directory and start the frontend with the following command.
+```{toctree}
+:maxdepth: 2
+:hidden: true
 
-```shell
-yarn start
+containers/index
+source
 ```
-
-In your browser, visit [http://localhost:3000](http://localhost:3000/).
-
-Congratulations!
-You have completed the installation of Plone 6 with Volto for its frontend.
-Welcome to Plone 6!
-
-
-(install-index-additional-references-label)=
-
-## Additional references
-
--   [Installation instructions from the Mastering Plone 6 training](https://training.plone.org/5/mastering-plone/installation.html)
--   {ref}`frontend-getting-started-installing-volto-label`
--   [Community post](https://community.plone.org/t/our-pip-based-development-workflow-for-plone/14562) on work in progress with [`plone-kickstarter`](https://github.com/bluedynamics/plone-kickstarter) and [`mxdev`](https://github.com/bluedynamics/mxdev).
diff --git a/docs/install/source.md b/docs/install/source.md
@@ -0,0 +1,24 @@
+---
+html_meta:
+  "description": "Install Plone 6 from source"
+  "property=og:description": "Install Plone 6 from source"
+  "property=og:title": "Install Plone 6 from source"
+  "keywords": "Plone 6, install, installation, installing, buildout, pip, docker, source"
+---
+
+
+# Install from source for development 
+
+## Backend source / frontend source explanation
+
+## Pip install  / cookiecutter
+
+## Mxdev
+
+## Tox
+
+## Deprecated installation methods
+
+### Buildout
+
+### Universal installer? (based on buildout) -> container
diff --git a/docs/overview/history.md b/docs/overview/history.md
diff --git a/docs/overview/index.md b/docs/overview/index.md
