Skip to content

Commit d8900d0

Browse files
committed
Tidy up override-core.md
1 parent 7f7ba8c commit d8900d0

File tree

1 file changed

+34
-15
lines changed

1 file changed

+34
-15
lines changed

docs/admin-guide/override-core.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,25 @@ myst:
44
"description": "Override core Plone packages"
55
"property=og:description": "Override core Plone packages"
66
"property=og:title": "Override core Plone packages"
7-
"keywords": "Plone 6, core, package, version, override"
7+
"keywords": "Plone 6, core, package, version, override, Cookieplone, cookiecutter-plone-starter, Buildout"
88
---
99

1010
(override-core-plone-packages-label)=
1111

1212
# Override core Plone packages
1313

14-
Plone includes a lot of Python packages.
15-
Sometimes it is necessary to override one or more package versions in order to fix a bug.
14+
Plone includes a few hundred Python packages.
15+
Sometimes you will need to override one or more package versions to fix a bug.
1616

1717

18-
## with Cookieplone
18+
## Cookieplone
1919

2020
Use the following instructions if you installed Plone with Cookieplone or `cookiecutter-plone-starter`.
2121

22+
2223
### Override a core Plone package
2324

24-
Add a version override to {file}`mx.ini`.
25+
Add a version override to the file {file}`mx.ini`.
2526
This example uses `plone.api`.
2627

2728
```
@@ -37,24 +38,28 @@ For an explanation of why Plone uses `mxdev`, see {ref}`manage-backend-python-pa
3738

3839
Stop the backend with {kbd}`ctrl-c`.
3940

40-
To actually download and install the new package version, run:
41+
To actually download and install the new package version, run the following command.
4142

4243
```shell
4344
make backend-build
4445
```
4546

4647
```{note}
47-
If you installed Plone using `cookiecutter-plone-starter`, run `make build-backend` instead.`
48+
If you installed Plone using `cookiecutter-plone-starter`, run `make build-backend` instead.
4849
```
4950

5051
Now restart the backend.
5152

53+
```{seealso}
54+
{doc}`run-plone`
55+
```
56+
5257

5358
### Install a core Plone package from source
5459

55-
`mxdev` can also be used to install core Plone packages from a source control system such as GitHub.
60+
You can also use `mxdev` to install core Plone packages from a source control system such as GitHub.
5661

57-
Add the Plone package you want to check out in {file}`mx.ini`.
62+
Add the Plone package you want to check out in the file {file}`mx.ini`.
5863
This example uses `plone.restapi`.
5964

6065
```cfg
@@ -66,7 +71,7 @@ extras = test
6671

6772
Stop the backend with {kbd}`ctrl-c`.
6873

69-
To actually download and install the new package version, run:
74+
To actually download and install the new package version, run the following command.
7075

7176
```shell
7277
make backend-build
@@ -78,14 +83,18 @@ If you installed Plone using `cookiecutter-plone-starter`, run `make build-backe
7883

7984
Now restart the backend.
8085

86+
```{seealso}
87+
{doc}`run-plone`
88+
```
89+
8190

82-
## with Buildout
91+
## Buildout
8392

8493
Use the following instructions if you installed Plone with Buildout.
8594

8695
### Override a core Plone package
8796

88-
Update {file}`buildout.cfg`.
97+
Update the file {file}`buildout.cfg`.
8998
This example uses `plone.api`.
9099

91100
```cfg
@@ -111,20 +120,24 @@ plone.api = 2.0.0a3
111120
The version pins specified in the `[versions]` section will take precedence over the pins inherited from `https://dist.plone.org/release/6-latest/versions.cfg`.
112121
```
113122

114-
To actually download and install the new package version, run:
123+
To actually download and install the new package version, run the following command.
115124

116125
```shell
117126
bin/buildout
118127
```
119128

120129
Then restart your instance.
121130

131+
```{seealso}
132+
{doc}`run-plone`
133+
```
134+
122135

123136
### Install a core Plone package from source
124137

125138
A core Plone package can be installed from a source control system such as GitHub.
126139

127-
Update {file}`buildout.cfg`.
140+
Update the file {file}`buildout.cfg`.
128141
This example uses `plone.restapi`.
129142

130143
```cfg
@@ -156,12 +169,18 @@ plone.restapi =
156169
Setting an empty version ensures that the copy of `plone.restapi` from source control will be used, instead of the version pin inherited from https://dist.plone.org/release/6-latest/versions.cfg.
157170
```
158171

159-
To actually download and install the new add-on, run:
172+
To actually download and install the new add-on, run the following command.
160173

161174
```shell
162175
bin/buildout
163176
```
164177

178+
Then restart your instance.
179+
180+
```{seealso}
181+
{doc}`run-plone`
182+
```
183+
165184
```{seealso}
166185
This approach uses the [`mr.developer`](https://pypi.org/project/mr.developer/) Buildout extension.
167186
```

0 commit comments

Comments
 (0)