From ba0e0744cd0e1f14c504f97dea0d746da6143821 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 4 Nov 2024 00:11:09 -0800 Subject: [PATCH] Tidy up add-site.md, mostly docs style guide stuff, and a rewording of the final admonition. Add plural `distributions` to Glossary. --- docs/glossary.md | 1 + docs/install/add-site.md | 33 +++++++++++++++++---------------- 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/glossary.md b/docs/glossary.md index 5d070f130..2fd60ba99 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -802,6 +802,7 @@ reference implementation The reference implementation often accompanies a technical standard, and demonstrates what should be considered the "correct" behavior of any other implementation of it. distribution +distributions A Plone distribution is a pre-packaged version of Plone that includes specific features, themes, modules, and configurations. It is a convenient way to get a specific type of website up and running quickly, as the distribution includes everything needed to run that type of site. diff --git a/docs/install/add-site.md b/docs/install/add-site.md index e5bacf36a..73d40805c 100644 --- a/docs/install/add-site.md +++ b/docs/install/add-site.md @@ -3,11 +3,11 @@ myst: html_meta: "description": "How to add a Plone site to an existing Zope instance" "property=og:description": "How to add a Plone site to an existing Zope instance" - "property=og:title": "Create a Plone site" + "property=og:title": "Add a Plone site" "keywords": "Plone 6, create, add, factory, distributions" --- -% This should move into the Admin guide once https://github.com/plone/documentation/pull/1746 is merged. +% TODO: This should move into the Admin guide once https://github.com/plone/documentation/pull/1746 is merged. (add-a-plone-site-label)= @@ -17,19 +17,19 @@ This section explains how to add a Plone site to an existing Zope instance. It assumes that you have already {doc}`installed ` and started Plone. Some installation methods create a Plone site for you already. -Follow these instructions if you used an installation method that did not do this, -or if you need a second Plone site in the same instance for some reason. +Follow these instructions if you used an installation method that did not do this, or if you need a second Plone site in the same instance for some reason. ```{versionadded} Plone 6.1 The user interface for creating a new Plone site was changed in Plone 6.1. You can access it the same way in Plone 6.0, but the appearance and options are different. ``` -Open the Plone backend. Usually it is running at http://localhost:8080/ +Visit the Plone backend in a web browser. +Usually it is running at http://localhost:8080/ -This launch screen prompts you to choose one of the available {term}`distributions ` to create a new site. +The launch screen prompts you to choose one of the available {term}`distributions` to create a new site. -% add a link to choose-user-interface doc once https://github.com/plone/documentation/pull/1749 is merged +% TODO: Add a link to the choose-user-interface doc once https://github.com/plone/documentation/pull/1749 is merged. ````{card} ```{image} /backend/upgrading/version-specific-migration/images/distribution-chooser.png @@ -42,14 +42,16 @@ _Launch screen for choosing a distribution_ Hover over your choice and click the {guilabel}`Create` button. -Now complete the form with initial configuration for your site. You can configure: +Now complete the form with initial configuration for your site. +You can configure the following settings. -:::{card} Path Identifier -: The ID of the site. This ends up as part of the URL unless hidden by an upstream web server. +: The ID of the site. + This ends up as part of the URL unless hidden by an upstream web server. Title -: The name of the site in the HTML `title` element. This will be shown as part of the title of the browser tab on each page. +: The name of the site in the HTML `title` element. + This will be shown as part of the title of the browser tab on each page. Site Description : A brief description that will be served in an HTML `meta` tag. @@ -62,14 +64,13 @@ Language Timezone : The default timezone setting of the portal. -::: -Finally, press {guilabel}`Submit`. +Finally, click the {guilabel}`Submit` button. Have fun with your new Plone site! ```{important} -If you are using the Volto frontend, keep in mind that the launch screen for adding a site is hosted by the Plone backend server. -After you create the site, you must switch to Volto. -Usually, it is running at http://localhost:3000. +The launch screen for adding a site is hosted by the Plone backend server. +Regardless of the frontend you select, you will be redirected to the backend's user interface after you create the site. +If you select the Volto frontend, you can switch to it by changing the port number in the URL, usually `3000`, and visiting it at http://localhost:3000, for example. ```