Skip to content

Commit

Permalink
Add reference to training choices.
Browse files Browse the repository at this point in the history
Simplify markup with naked links.
Use inline literal markup for inline literals.
Remove bold style from already bold headings
Use `{guilabel}` for UI labels
  • Loading branch information
stevepiercy committed Nov 27, 2024
1 parent 9d2833d commit 890978e
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 31 deletions.
2 changes: 2 additions & 0 deletions docs/plone-deployment/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ or considering a virtual machine on your personal computer for testing, this tra

We will delve into a basic setup, scalable to accommodate extensive Plone installations.

(deployment-training-choices)=

### Training Choices

#### Linux
Expand Down
19 changes: 9 additions & 10 deletions docs/plone-deployment/plone-docker-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ myst:

# Plone Docker Images

Since the release of Plone 6, the community has a new set of Docker images -- and offering more base options.
Since the release of Plone 6, the community has a new set of Docker images offering more base options.

## plone/plone-frontend
## `plone/plone-frontend`

Repository available at [https://github.com/plone/plone-frontend/](https://github.com/plone/plone-frontend/)
Repository available at https://github.com/plone/plone-frontend/.

Installs the Plone 6 default user-experience (Using the React-powered frontend: Volto).
Installs the Plone 6 user-experience using the React-powered frontend, Volto.

Should be used to showcase the default Plone 6 experience, as new projects will probably implement their own Docker images (with a similar Dockerfile),
like the one below:
Should be used to showcase the Plone 6 experience, as new projects will probably implement their own Docker images (with a similar Dockerfile), like the one below:

```Dockerfile
# syntax=docker/dockerfile:1
Expand Down Expand Up @@ -55,9 +54,9 @@ RUN <<EOT
EOT
```

## plone/plone-backend
## `plone/plone-backend`

Repository available at [https://github.com/plone/plone-backend/](https://github.com/plone/plone-backend/)
Repository available at https://github.com/plone/plone-backend/.

Installs the Plone 6 backend using a pip-based installation.
This approach makes it easier and faster to extend this image in your own project.
Expand Down Expand Up @@ -107,8 +106,8 @@ RUN <<EOT
EOT
```

## plone/plone-zeo
## `plone/plone-zeo`

Repository available at [https://github.com/plone/plone-zeo/](https://github.com/plone/plone-zeo/)
Repository available at https://github.com/plone/plone-zeo/.

Installs a ZEO database server.
6 changes: 3 additions & 3 deletions docs/plone-deployment/plone-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To understand the rewrite rules used in Traefik, please read our reference about

### Plone Frontend

Hosted on a Node HTTP-server running on port 3000, the Plone frontend constitutes the default user interface and requires access to the Plone Backend and the web server.
Hosted on a Node.js HTTP-server running on port 3000, the Plone frontend constitutes the default user interface and requires access to the Plone Backend and the web server.

### Plone Backend

Expand All @@ -43,7 +43,7 @@ The database layer can range from a simple ZODB with file storage to more scalab
#### Without Specialized Database

```
Web server -> Plone Frontend -> Plone Backend (file storage).
Web server Plone Frontend Plone Backend (file storage)
```

```{note}
Expand Down Expand Up @@ -71,7 +71,7 @@ Web server → Web Accelerator → Plone Frontend → Plone Backend → Database
In a multi-server environment, load distribution and redundancy are achieved through various configurations, enabling horizontal scaling.

```{figure} _static/request_flow.png
:alt: Flow of a request to https://example.com
:alt: Flow of a request to `https://example.com`
Flow of a request to https://example.com
```
Expand Down
36 changes: 18 additions & 18 deletions docs/plone-deployment/project-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ myst:

# Create a new Project

As highlighted in the {doc}`intro`'s Training Choices, GitHub is essential for building Docker images automatically in this training.
As highlighted in the {doc}`intro`'s {ref}`deployment-training-choices`, GitHub is essential for building Docker images automatically in this training.
The steps can be adapted for other providers like GitLab.

## Generating the Codebase
Expand All @@ -23,12 +23,12 @@ pipx run cookieplone project
Answer the prompts as they appear. You can either accept the default values or enter your own.

```{warning}
For participants of **Plone Conference 2024**, please use the following settings:
For participants in **Plone Conference 2024**, please use the following settings:
- `Project Title`: **Plone Conference Training**
- `Project Slug`: **ploneconf2024**
- `Project URL`: **ploneconf2024-\<your-github-username\>.tangrama.com.br**
- `GitHub Username or Organization`: **\<your-github-username\>**
- {guilabel}`Project Title`: **Plone Conference Training**
- {guilabel}`Project Slug`: **ploneconf2024**
- {guilabel}`Project URL`: **ploneconf2024-\<your-github-username\>.tangrama.com.br**
- {guilabel}`GitHub Username or Organization`: **\<your-github-username\>**
```

An example interaction with the `Cookieplone` wizard is shown below:
Expand Down Expand Up @@ -116,58 +116,58 @@ make check

## Create a Repository on GitHub

### 1. **Login to GitHub**
### 1. Login to GitHub

Visit [GitHub](https://github.com) and log in.

### 2. **Create a New Repository**
### 2. Create a New Repository

Click the '+' icon in the upper right corner, select 'New repository', and fill in the details:

- **Repository name:** ploneconf2024
- **Description:** Plone Conference 2024 Training
- **Visibility:** Public
- {guilabel}`Repository name`: `ploneconf2024`
- {guilabel}`Description`: `Plone Conference 2024 Training`
- {guilabel}`Visibility`: `Public`

Click 'Create repository'.

## Initialize and Push to the Git Repository

### 1. **Initialize Git**
### 1. Initialize Git

Initializes a new Git repository and begins tracking an existing directory.

```shell
git init .
```
### 2. **Add Files**
### 2. Add Files

stages changes for commit, meaning it tracks the new files (in this case, all files in the directory with `.`). Staging lets you select which changes you want to commit.

```shell
git add .
```

### 3. **Initial Commit**
### 3. Initial Commit

Saves the staged changes along with a brief log message describing the changes.
Replace `"Initial commit"` with a descriptive message if needed. It's the first commit,
Replace "`Initial commit`" with a descriptive message if needed. It's the first commit,
so we typically label it as the "Initial commit."

```shell
git commit -m "Initial commit"
```

### 4. **Link Local Repository to Remote Repository**
### 4. Link Local Repository to Remote Repository

Connect your local repository to the remote server. First replace `<your-github-username>` with your actual GitHub username.
'origin' is the default name given to the remote repository, and we also set the default branch to be `main`.
`origin` is the default name given to the remote repository, and we also set the default branch to be `main`.

```shell
git remote add origin [email protected]:<your-github-username>/ploneconf2024.git
git branch -M main
```

### 4. **Push to GitHub**
### 4. Push to GitHub

Push your commits to the remote repository hosted on GitHub. This command will trigger the GitHub Actions that test the codebase and
generate Docker images for the Backend and for the Frontend.
Expand Down

0 comments on commit 890978e

Please sign in to comment.